Browse Source

Unify doxy comments style

Alexey Edelev 5 years ago
parent
commit
a29546b851

+ 1 - 1
Doxyfile.in

@@ -183,7 +183,7 @@ SHORT_NAMES            = NO
 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
 # first line (until the first dot) of a Javadoc-style comment as the brief
 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
-# style comments (thus requiring an explicit @brief command for a brief
+# style comments (thus requiring an explicit \brief command for a brief
 # description.)
 # The default value is: NO.
 

+ 5 - 5
src/grpc/abstractchannel.h

@@ -35,13 +35,13 @@ namespace qtprotobuf {
 
 class AsyncReply;
 class AbstractClient;
-/**
+/*!
 *  \addtogroup QtGrpc
-*  @{
+*  \{
 */
 
-/**
- * @brief The AbstractChannel class
+/*!
+ * \brief The AbstractChannel class
  */
 class QTGRPCSHARED_EXPORT AbstractChannel
 {
@@ -109,5 +109,5 @@ protected:
 private:
     Q_DISABLE_COPY(AbstractChannel)
 };
-/** @} */
+/*! \} */
 }

+ 10 - 10
src/grpc/abstractclient.h

@@ -40,15 +40,15 @@
 #include "qtgrpc_global.h"
 
 namespace qtprotobuf {
-/**
+/*!
 *  \addtogroup QtGrpc
-*  @{
+*  \{
 */
 
 class AbstractChannel;
 
-/**
- * @brief The AbstractClient class
+/*!
+ * \brief The AbstractClient class
  */
 class QTGRPCSHARED_EXPORT AbstractClient : public QObject
 {
@@ -63,12 +63,12 @@ protected:
     AbstractClient(const QString &service, QObject *parent = nullptr);
     virtual ~AbstractClient();
 
-    /**
-     * @brief A template of a sync RPC call
+    /*!
+     * \brief A template of a sync RPC call
      *
-     * @param method Name of the method to be called
-     * @param arg Arguments (proto-message) passed to the method called
-     * @param ret A pointer to memory with proto-message to write an RPC reply to
+     * \param method Name of the method to be called
+     * \param arg Arguments (proto-message) passed to the method called
+     * \param ret A pointer to memory with proto-message to write an RPC reply to
      */
     template<typename A, typename R>
     bool call(const QString &method, const A &arg, const QPointer<R> &ret) {
@@ -139,5 +139,5 @@ private:
     // PIMPL
     class AbstractClientPrivate *d;
 };
-/** @} */
+/*! \} */
 }

+ 14 - 14
src/grpc/abstractcredentials.h

@@ -34,16 +34,16 @@
 #include "qtgrpc_global.h"
 
 namespace qtprotobuf {
-/**
+/*!
 *  \addtogroup QtGrpc
-*  @{
+*  \{
 */
 
 class CallCredentials;
 class ChannelCredentials;
 
-/**
- * @brief The AbstractCredentials class
+/*!
+ * \brief The AbstractCredentials class
  */
 class QTGRPCSHARED_EXPORT AbstractCredentials
 {
@@ -80,8 +80,8 @@ private:
     CredentialMap mChannelCredentials;
 };
 
-/**
- * @brief The CallCredentials class
+/*!
+ * \brief The CallCredentials class
  */
 class QTGRPCSHARED_EXPORT CallCredentials : public AbstractCredentials
 {
@@ -95,8 +95,8 @@ private:
     CallCredentials() = default;
 };
 
-/**
- * @brief The ChannelCredentials class
+/*!
+ * \brief The ChannelCredentials class
  */
 class QTGRPCSHARED_EXPORT ChannelCredentials : public AbstractCredentials
 {
@@ -106,9 +106,9 @@ protected:
         setChannelCredentials(credentialMap);
     }
 };
-/** @} */
+/*! \} */
 
-//! @private
+//! \private
 template<typename Call, typename Channel,
          typename std::enable_if_t<std::is_base_of<qtprotobuf::CallCredentials, Call>::value
                                    && std::is_base_of<qtprotobuf::ChannelCredentials, Channel>::value, int> = 0>
@@ -118,7 +118,7 @@ AbstractCredentials::AbstractCredentials(const Call &call, const Channel &channe
     mChannelCredentials = channel.mChannelCredentials;
 }
 
-//! @private
+//! \private
 template<typename Call,
          typename std::enable_if_t<std::is_base_of<qtprotobuf::CallCredentials, Call>::value, int> = 0>
 AbstractCredentials::AbstractCredentials(const Call &call)
@@ -126,7 +126,7 @@ AbstractCredentials::AbstractCredentials(const Call &call)
     mCallCredentials = call.mCallCredentials;
 }
 
-//! @private
+//! \private
 template<typename Channel,
          typename std::enable_if_t<std::is_base_of<qtprotobuf::ChannelCredentials, Channel>::value, int> = 0>
 AbstractCredentials::AbstractCredentials(const Channel &channel)
@@ -135,7 +135,7 @@ AbstractCredentials::AbstractCredentials(const Channel &channel)
 }
 }
 
-//! @private
+//! \private
 template<typename Call, typename Channel,
          typename std::enable_if_t<std::is_base_of<qtprotobuf::CallCredentials, Call>::value
                                    && std::is_base_of<qtprotobuf::ChannelCredentials, Channel>::value, int> = 0>
@@ -144,7 +144,7 @@ qtprotobuf::AbstractCredentials operator|(const Call &call, const Channel &chann
     return qtprotobuf::AbstractCredentials(call, channel);
 }
 
-//! @private
+//! \private
 template<typename Call, typename Channel,
          typename std::enable_if_t<std::is_base_of<qtprotobuf::CallCredentials, Call>::value
                                    && std::is_base_of<qtprotobuf::ChannelCredentials, Channel>::value, int> = 0>

+ 5 - 5
src/grpc/asyncreply.h

@@ -35,13 +35,13 @@
 #include "qtgrpc_global.h"
 
 namespace qtprotobuf {
-/**
+/*!
 *  \addtogroup QtGrpc
-*  @{
+*  \{
 */
 
-/**
- * @brief The AsyncReply class
+/*!
+ * \brief The AsyncReply class
  */
 class QTGRPCSHARED_EXPORT AsyncReply final : public QObject
 {
@@ -83,5 +83,5 @@ private:
 
     QMutex m_asyncLock;
 };
-/** @} */
+/*! \} */
 }

+ 1 - 1
src/grpc/http2channel.cpp

@@ -48,7 +48,7 @@ using namespace qtprotobuf;
 
 namespace  {
 
-/**
+/*!
  * This QNetworkReply::NetworkError -> AbstractChannel::StatusCode mapping should be kept in sync with original
  * <a href="https://github.com/grpc/grpc/blob/master/doc/statuscodes.md">gRPC status codes</a>
  */

+ 5 - 5
src/grpc/http2channel.h

@@ -30,15 +30,15 @@
 #include <QUrl>
 
 namespace qtprotobuf {
-/**
+/*!
 *  \addtogroup QtGrpc
-*  @{
+*  \{
 */
 
 class AbstractCredentials;
 
-/**
- * @brief The Http2Channel class
+/*!
+ * \brief The Http2Channel class
  */
 class QTGRPCSHARED_EXPORT Http2Channel final : public AbstractChannel
 {
@@ -61,5 +61,5 @@ private:
     // PIMPL
     struct Http2ChannelPrivate *d;
 };
-/** @} */
+/*! \} */
 }

+ 5 - 5
src/grpc/insecurecredentials.h

@@ -30,18 +30,18 @@
 #include "qtgrpc_global.h"
 
 namespace qtprotobuf {
-/**
+/*!
 *  \addtogroup QtGrpc
-*  @{
+*  \{
 */
 
-/**
- * @brief The InsecureCredentials class
+/*!
+ * \brief The InsecureCredentials class
  */
 class QTGRPCSHARED_EXPORT InsecureCredentials : public ChannelCredentials
 {
 public:
     InsecureCredentials() : ChannelCredentials(CredentialMap()) {}
 };
-/** @} */
+/*! \} */
 }

+ 5 - 5
src/grpc/sslcredentials.h

@@ -32,13 +32,13 @@
 #include "qtgrpc_global.h"
 
 namespace qtprotobuf {
-/**
+/*!
 *  \addtogroup QtGrpc
-*  @{
+*  \{
 */
 
-/**
- * @brief The SslCredentials class
+/*!
+ * \brief The SslCredentials class
  */
 class QTGRPCSHARED_EXPORT SslCredentials : public ChannelCredentials
 {
@@ -47,5 +47,5 @@ public:
         ChannelCredentials(CredentialMap{{QLatin1String("sslConfig"),
                            QVariant::fromValue<QSslConfiguration>(configuation)}}) {}
 };
-/** @} */
+/*! \} */
 }

+ 20 - 20
src/protobuf/qabstractprotobufserializer.h

@@ -39,42 +39,39 @@
 #include "qtprotobuf_global.h"
 
 namespace qtprotobuf {
-/**
+/*!
 *  \addtogroup QtProtobuf
-*  @{
+*  \{
 */
 
-//! @private
-constexpr int NotUsedFieldIndex = -1;
-
-/**
- * @brief The QAbstractProtobufSerializer class is interface that represents basic functions for serialization/deserialization
+/*!
+ * \brief The QAbstractProtobufSerializer class is interface that represents basic functions for serialization/deserialization
  *
- * @details This class is used by QProtobufSerializerRegistry to access basic serialization routines.
+ * \details This class is used by QProtobufSerializerRegistry to access basic serialization routines.
  *
  */
 class QTPROTOBUFSHARED_EXPORT QAbstractProtobufSerializer
 {
 public:
-    /**
-     * @brief Serializer is interface function for serialize method
+    /*!
+     * \brief Serializer is interface function for serialize method
      */
     using Serializer = std::function<QByteArray(const QVariant &, int &)>;
-    /**
-     * @brief Deserializer is interface function for deserialize method
+    /*!
+     * \brief Deserializer is interface function for deserialize method
      */
     using Deserializer = std::function<void(SelfcheckIterator &, QVariant &)>;
 
-    /**
-     * @brief SerializationHandlers contains set of objects that required for class serializaion/deserialization
+    /*!
+     * \brief SerializationHandlers contains set of objects that required for class serializaion/deserialization
      */
     struct SerializationHandlers {
-        Serializer serializer; /**< serializer assigned to class */
-        Deserializer deserializer;/**< deserializer assigned to class */
-        WireTypes type;/**< Serialization WireType */
+        Serializer serializer; /*!< serializer assigned to class */
+        Deserializer deserializer;/*!< deserializer assigned to class */
+        WireTypes type;/*!< Serialization WireType */
     };
-    /**
-     * @brief SerializerRegistry is container to store mapping between metatype identifier and serialization handlers.
+    /*!
+     * \brief SerializerRegistry is container to store mapping between metatype identifier and serialization handlers.
      */
     using SerializerRegistry = std::unordered_map<int/*metatypeid*/, SerializationHandlers>;
 
@@ -119,5 +116,8 @@ public:
     QByteArray serializeMapPair(const QVariant &key, const QVariant &value, int fieldIndex) override;
     void deserializeMapPair(QVariant &key, QVariant &value, SelfcheckIterator &it) override;
 };
-/** @} */
+/*! \} */
+
+//! \private
+constexpr int NotUsedFieldIndex = -1;
 }

+ 38 - 38
src/protobuf/qprotobufserializer_p.h

@@ -33,10 +33,10 @@
 
 namespace qtprotobuf {
 
-/**
- * @private
+/*!
+ * \private
  *
- * @brief The QProtobufSerializerPrivate class
+ * \brief The QProtobufSerializerPrivate class
  */
 class QProtobufSerializerPrivate {
     QProtobufSerializerPrivate() = delete;
@@ -73,14 +73,14 @@ public:
     }
 
     //---------------Integral and floating point types serializers---------------
-    /**
-     * @brief Serialization of fixed-length primitive types
+    /*!
+     * \brief Serialization of fixed-length primitive types
      *
      * Natural layout of bits is used: value is encoded in a byte array same way as it is located in memory
      *
-     * @param[in] value Value to serialize
-     * @param[out] outFieldIndex Index of the value in parent structure (ignored)
-     * @return Byte array with value encoded
+     * \param[in] value Value to serialize
+     * \param[out] outFieldIndex Index of the value in parent structure (ignored)
+     * \return Byte array with value encoded
      */
     template <typename V,
               typename std::enable_if_t<std::is_floating_point<V>::value, int> = 0>
@@ -93,14 +93,14 @@ public:
         return result;
     }
 
-    /**
-     * @brief Serialization of fixed length integral types
+    /*!
+     * \brief Serialization of fixed length integral types
      *
-     * @details Natural layout of bits is employed
+     * \details Natural layout of bits is employed
      *
-     * @param[in] value Value to serialize
-     * @param[out] outFieldIndex Index of the value in parent structure (ignored)
-     * @return Byte array with value encoded
+     * \param[in] value Value to serialize
+     * \param[out] outFieldIndex Index of the value in parent structure (ignored)
+     * \return Byte array with value encoded
      */
     template <typename V,
               typename std::enable_if_t<std::is_same<V, fixed32>::value
@@ -116,16 +116,16 @@ public:
         return result;
     }
 
-    /**
-     *@brief Serialization of signed integral types
+    /*!
+     *\brief Serialization of signed integral types
      *
      * Use <a href="https://developers.google.com/protocol-buffers/docs/encoding">ZigZag encoding</a> first,
      * then apply serialization as for unsigned integral types
-     * @see serializeBasic\<typename V, typename std::enable_if_t\<std::is_integral\<V\>::value && std::is_unsigned\<V\>::value, int\> = 0\>(V, int)
+     * \see serializeBasic\<typename V, typename std::enable_if_t\<std::is_integral\<V\>::value && std::is_unsigned\<V\>::value, int\> = 0\>(V, int)
      *
-     * @param[in] value Value to serialize
-     * @param[out] outFieldIndex Index of the value in parent structure
-     * @return Byte array with value encoded
+     * \param[in] value Value to serialize
+     * \param[out] outFieldIndex Index of the value in parent structure
+     * \return Byte array with value encoded
      */
     template <typename V,
               typename std::enable_if_t<std::is_integral<V>::value
@@ -150,16 +150,16 @@ public:
         return serializeBasic(static_cast<UV>(value), outFieldIndex);
     }
 
-    /**
-    *@brief Serialization of unsigned integral types
+    /*!
+    *\brief Serialization of unsigned integral types
     *
     * Use <a href="https://developers.google.com/protocol-buffers/docs/encoding">Varint encoding</a>:
     * "Varints are a method of serializing integers using one or more bytes. Smaller numbers
     * [regardless its type] take a smaller number of bytes."
     *
-    * @param[in] value Value to serialize
-    * @param[out] outFieldIndex Index of the value in parent structure
-    * @return Byte array with value encoded
+    * \param[in] value Value to serialize
+    * \param[out] outFieldIndex Index of the value in parent structure
+    * \return Byte array with value encoded
     */
     template <typename V,
               typename std::enable_if_t<std::is_integral<V>::value
@@ -408,12 +408,12 @@ public:
     static bool decodeHeader(SelfcheckIterator &it, int &fieldIndex, WireTypes &wireType);
     static QByteArray encodeHeader(int fieldIndex, WireTypes wireType);
 
-    /**
-     * @brief Gets length of a byte-array and prepends to it its serialized length value
+    /*!
+     * \brief Gets length of a byte-array and prepends to it its serialized length value
      *      using the appropriate serialization algorithm
      *
      *
-     * @param[in, out] serializedList Byte-array to be prepended
+     * \param[in, out] serializedList Byte-array to be prepended
      */
     static QByteArray prependLengthDelimitedSize(const QByteArray &data)
     {
@@ -462,17 +462,17 @@ protected:
 //                             Common functions
 //###########################################################################
 
-/*! @brief Encode a property field index and its type into output bytes
+/*! \brief Encode a property field index and its type into output bytes
  *
- * @details
+ * \details
  * Header byte
  *  Meaning    |  Field index  |  Type
  *  ---------- | ------------- | --------
  *  bit number | 7  6  5  4  3 | 2  1  0
- * @param fieldIndex The index of a property in parent object
- * @param wireType Serialization type used for the property with index @p fieldIndex
+ * \param fieldIndex The index of a property in parent object
+ * \param wireType Serialization type used for the property with index @p fieldIndex
  *
- * @return Varint encoded fieldIndex and wireType
+ * \return Varint encoded fieldIndex and wireType
  */
 inline QByteArray QProtobufSerializerPrivate::encodeHeader(int fieldIndex, WireTypes wireType)
 {
@@ -480,13 +480,13 @@ inline QByteArray QProtobufSerializerPrivate::encodeHeader(int fieldIndex, WireT
     return serializeVarintCommon<uint32_t>(header);
 }
 
-/*! @brief Decode a property field index and its serialization type from input bytes
+/*! \brief Decode a property field index and its serialization type from input bytes
  *
- * @param[in] Iterator that points to header with encoded field index and serialization type
- * @param[out] fieldIndex Decoded index of a property in parent object
- * @param[out] wireType Decoded serialization type used for the property with index @p fieldIndex
+ * \param[in] Iterator that points to header with encoded field index and serialization type
+ * \param[out] fieldIndex Decoded index of a property in parent object
+ * \param[out] wireType Decoded serialization type used for the property with index @p fieldIndex
  *
- * @return true if both decoded wireType and fieldIndex have "allowed" values and false, otherwise
+ * \return true if both decoded wireType and fieldIndex have "allowed" values and false, otherwise
  */
 inline bool QProtobufSerializerPrivate::decodeHeader(SelfcheckIterator &it, int &fieldIndex, WireTypes &wireType)
 {

+ 49 - 49
src/protobuf/qprotobufserializerregistry.h

@@ -38,17 +38,17 @@
 #include "qtprotobuf_global.h"
 
 namespace qtprotobuf {
-/**
+/*!
 *  \addtogroup QtProtobuf
-*  @{
+*  \{
 */
 
-/**
- * @brief The QProtobufSerializerRegistry class provides api to register serializers of QObjects
+/*!
+ * \brief The QProtobufSerializerRegistry class provides api to register serializers of QObjects
  *
- * @details The QProtobufSerializerRegistry class registers serializers/deserializers for classes inherited of QObject.
+ * \details The QProtobufSerializerRegistry class registers serializers/deserializers for classes inherited of QObject.
  *          To register serializers for user-defined class it has to be inherited of QObjec contain macro's.
- *          @code{.cpp}
+ *          \code{.cpp}
  *          class MyType : public QObject
  *          {
  *              Q_OBJECT
@@ -57,7 +57,7 @@ namespace qtprotobuf {
  *              ...
  *              Q_DECLARE_PROTOBUF_SERIALIZERS(MyType)
  *          };
- *          @endcode
+ *          \endcode
  *          Practically code above is generated automaticaly by running qtprotobufgenerator or using cmake build macro
  *          generate_qtprotobuf, based on .proto files. But it's still possible to reuse manually written code if needed.
  */
@@ -75,11 +75,11 @@ class QTPROTOBUFSHARED_EXPORT QProtobufSerializerRegistry
     static QAbstractProtobufSerializer::SerializationHandlers empty;
 public:
     static const QAbstractProtobufSerializer::SerializationHandlers &handler(int userType);
-    /**
-     * @brief Serialization of a registered qtproto message object into byte-array
+    /*!
+     * \brief Serialization of a registered qtproto message object into byte-array
      *
      *
-     * @param[in] object Pointer to QObject containing message to be serialized
+     * \param[in] object Pointer to QObject containing message to be serialized
      * @result serialized message bytes
      */
     template<typename T>
@@ -88,14 +88,14 @@ public:
         return basicSerializer->serializeObjectCommon(object, T::propertyOrdering, T::staticMetaObject);
     }
 
-    /**
-     * @brief Deserialization of a byte-array into a registered qtproto message object
+    /*!
+     * \brief Deserialization of a byte-array into a registered qtproto message object
      *
-     * @details Properties in a message are identified via ProtobufObjectPrivate::decodeHeader.
+     * \details Properties in a message are identified via ProtobufObjectPrivate::decodeHeader.
      *          Bytes corresponding to unexpected properties are skipped without any exception
      *
-     * @param[out] object Pointer to memory where result of deserialization should be injected
-     * @param[in] array Bytes with serialized message
+     * \param[out] object Pointer to memory where result of deserialization should be injected
+     * \param[in] array Bytes with serialized message
      */
     template<typename T>
     static void deserialize(QObject *object, const QByteArray &array) {
@@ -104,10 +104,10 @@ public:
     }
 
 
-    /**
-     * @brief Registers serializers for type T in QProtobufSerializerRegistry
+    /*!
+     * \brief Registers serializers for type T in QProtobufSerializerRegistry
      *
-     * @details generates default serializers for type T. Type T has to be inherited of QObject.
+     * \details generates default serializers for type T. Type T has to be inherited of QObject.
      */
     template<typename T>
     static void registerSerializers() {
@@ -117,10 +117,10 @@ public:
                 deserializeList<T>, LengthDelimited };
     }
 
-    /**
-     * @brief Registers serializers for type QMap<K, V> in QProtobufSerializerRegistry
+    /*!
+     * \brief Registers serializers for type QMap<K, V> in QProtobufSerializerRegistry
      *
-     * @details generates default serializers for QMap<K, V>.
+     * \details generates default serializers for QMap<K, V>.
      */
     template<typename K, typename V,
              typename std::enable_if_t<!std::is_base_of<QObject, V>::value, int> = 0>
@@ -129,10 +129,10 @@ public:
         deserializeMap<K, V>, LengthDelimited };
     }
 
-    /**
-     * @brief Registers serializers for type QMap<K, V> in QProtobufSerializerRegistry
+    /*!
+     * \brief Registers serializers for type QMap<K, V> in QProtobufSerializerRegistry
      *
-     * @details generates default serializers for QMap<K, V>. Specialization for V type
+     * \details generates default serializers for QMap<K, V>. Specialization for V type
      *          inherited of QObject.
      */
     template<typename K, typename V,
@@ -143,10 +143,10 @@ public:
     }
 
 private:
-    /**
-     * @private
+    /*!
+     * \private
      *
-     * @brief default serializer template for type T inherited of QObject
+     * \brief default serializer template for type T inherited of QObject
      */
     template <typename T,
               typename std::enable_if_t<std::is_base_of<QObject, T>::value, int> = 0>
@@ -154,10 +154,10 @@ private:
         return basicSerializer->serializeObject(value.value<T *>(), T::propertyOrdering, T::staticMetaObject);
     }
 
-    /**
-     * @private
+    /*!
+     * \private
      *
-     * @brief default serializer template for list of type T objects inherited of QObject
+     * \brief default serializer template for list of type T objects inherited of QObject
      */
     template<typename V,
              typename std::enable_if_t<std::is_base_of<QObject, V>::value, int> = 0>
@@ -185,10 +185,10 @@ private:
         return serializedList;
     }
 
-    /**
-     * @private
+    /*!
+     * \private
      *
-     * @brief default serializer template for map of key K, value V
+     * \brief default serializer template for map of key K, value V
      */
     template<typename K, typename V,
              typename std::enable_if_t<!std::is_base_of<QObject, V>::value, int> = 0>
@@ -204,10 +204,10 @@ private:
         return mapResult;
     }
 
-    /**
-     * @private
+    /*!
+     * \private
      *
-     * @brief default serializer template for map of type key K, value V. Specialization for V
+     * \brief default serializer template for map of type key K, value V. Specialization for V
      *        inherited of QObject
      */
     template<typename K, typename V,
@@ -228,10 +228,10 @@ private:
         return mapResult;
     }
 
-    /**
-     * @private
+    /*!
+     * \private
      *
-     * @brief default deserializer template for type T inherited of QObject
+     * \brief default deserializer template for type T inherited of QObject
      */
     template <typename T,
               typename std::enable_if_t<std::is_base_of<QObject, T>::value, int> = 0>
@@ -241,10 +241,10 @@ private:
         to = QVariant::fromValue<T *>(value);
     }
 
-    /**
-     * @private
+    /*!
+     * \private
      *
-     * @brief default deserializer template for list of type T objects inherited of QObject
+     * \brief default deserializer template for list of type T objects inherited of QObject
      */
     template <typename V,
               typename std::enable_if_t<std::is_base_of<QObject, V>::value, int> = 0>
@@ -258,10 +258,10 @@ private:
         previous.setValue(list);
     }
 
-    /**
-     * @private
+    /*!
+     * \private
      *
-     * @brief default deserializer template for map of key K, value V
+     * \brief default deserializer template for map of key K, value V
      */
     template <typename K, typename V,
               typename std::enable_if_t<!std::is_base_of<QObject, V>::value, int> = 0>
@@ -277,10 +277,10 @@ private:
         previous = QVariant::fromValue<QMap<K, V>>(out);
     }
 
-    /**
-     * @private
+    /*!
+     * \private
      *
-     * @brief default deserializer template for map of type key K, value V. Specialization for V
+     * \brief default deserializer template for map of type key K, value V. Specialization for V
      *        inherited of QObject
      */
     template <typename K, typename V,
@@ -298,5 +298,5 @@ private:
     }
 };
 
-/** @} */
+/*! \} */
 }

+ 86 - 86
src/protobuf/qtprotobuftypes.h

@@ -31,15 +31,15 @@
 #include <unordered_map>
 
 namespace qtprotobuf {
-/**
+/*!
 *  \addtogroup QtProtobuf
-*  @{
+*  \{
 */
 
-/**
- * @brief The WireTypes enumeration reflects protobuf default wiretypes
+/*!
+ * \brief The WireTypes enumeration reflects protobuf default wiretypes
  *
- * @details Look at https://developers.google.com/protocol-buffers/docs/encoding for details.
+ * \details Look at https://developers.google.com/protocol-buffers/docs/encoding for details.
  *
  */
 enum WireTypes {
@@ -47,18 +47,18 @@ enum WireTypes {
     Varint = 0, //!< int32, int64, uint32, uint64, sint32, sint64, bool, enum
     Fixed64 = 1, //!< fixed64, sfixed64, double
     LengthDelimited = 2, //!< string, bytes, embedded messages, packed repeated fields
-    StartGroup = 3, //!< groups @deprecated Is deprecated in proto syntax 3. Not supported by QtProtobuf
-    EndGroup = 4, //!< groups @deprecated Is deprecated in proto syntax 3. Not supported by QtProtobuf
+    StartGroup = 3, //!< groups \deprecated Is deprecated in proto syntax 3. Not supported by QtProtobuf
+    EndGroup = 4, //!< groups \deprecated Is deprecated in proto syntax 3. Not supported by QtProtobuf
     Fixed32 = 5 //!< fixed32, sfixed32, float
 };
 
-//! @private
+//! \private
 using QProtobufPropertyOrdering = std::unordered_map<int, int>;
 
-/**
- * @private
+/*!
+ * \private
  *
- * @brief the transparent class is template to define set of extra types for integral types, to cover protobuf needs
+ * \brief the transparent class is template to define set of extra types for integral types, to cover protobuf needs
  */
 template<typename T, int = 0>
 struct transparent {
@@ -74,151 +74,151 @@ struct transparent {
     static QString toString(transparent t) { return QString::number(t._t); }
 };
 
-/**
- * @brief int32 signed 32-bit integer
+/*!
+ * \brief int32 signed 32-bit integer
  *
- * @details int32 is regular signed 32-bit integer that is represented in protobuf as variable size integer
+ * \details int32 is regular signed 32-bit integer that is represented in protobuf as variable size integer
  * aka WireTypes::Varint without modificators
  */
 using int32 = transparent<int32_t>;
 
-/**
- * @brief int64 signed 64-bit integer
+/*!
+ * \brief int64 signed 64-bit integer
  *
- * @details int64 is regular signed 64-bit integer that is represented in protobuf as variable size integer
+ * \details int64 is regular signed 64-bit integer that is represented in protobuf as variable size integer
  * aka WireTypes::Varint without modificators
  */
 using int64 = transparent<int64_t>;
 
-/**
- * @brief uint32 unsigned 32-bit integer
+/*!
+ * \brief uint32 unsigned 32-bit integer
  *
- * @details uint32 is unsigned 32-bit integer that is represented in protobuf as variable size integer
+ * \details uint32 is unsigned 32-bit integer that is represented in protobuf as variable size integer
  * aka WireTypes::Varint without modificators
  */
 using uint32 = uint32_t;
 
-/**
- * @brief uint64 unsigned 64-bit integer
+/*!
+ * \brief uint64 unsigned 64-bit integer
  *
- * @details uint64 is unsigned 64-bit integer that is represented in protobuf as variable size integer
+ * \details uint64 is unsigned 64-bit integer that is represented in protobuf as variable size integer
  * aka WireTypes::Varint without modificators
  */
 using uint64 = uint64_t;
 
-/**
- * @brief sint32 signed 32-bit ZigZag integer
+/*!
+ * \brief sint32 signed 32-bit ZigZag integer
  *
- * @details sint32 is 32-bit integer with forced sign marker that is represented in protobuf as variable size integer
+ * \details sint32 is 32-bit integer with forced sign marker that is represented in protobuf as variable size integer
  * aka WireTypes::Varint. sint32 type serialized using ZigZag convertion to reduce size of negative numbers.
  *
- * See https://developers.google.com/protocol-buffers/docs/encoding#signed-integers for details.
+ * \see https://developers.google.com/protocol-buffers/docs/encoding#signed-integers for details.
  */
 using sint32 = int32_t;
 
-/**
- * @brief sint64 signed 64-bit ZigZag integer
+/*!
+ * \brief sint64 signed 64-bit ZigZag integer
  *
- * @details sint64 is 64-bit integer with forced sign marker that is represented in protobuf as variable size integer
+ * \details sint64 is 64-bit integer with forced sign marker that is represented in protobuf as variable size integer
  * aka WireTypes::Varint. sint64 type serialized using ZigZag convertion to reduce size of negative numbers.
  *
- * See https://developers.google.com/protocol-buffers/docs/encoding#signed-integers for details.
+ * \see https://developers.google.com/protocol-buffers/docs/encoding#signed-integers for details.
  */
 using sint64 = int64_t;
 
-/**
- * @brief fixed32 unsigned 32-bit fixed size integer
+/*!
+ * \brief fixed32 unsigned 32-bit fixed size integer
  *
- * @details fixed32 is unsigned 32-bit integer that is represented in protobuf as fixed size 32-bit field
+ * \details fixed32 is unsigned 32-bit integer that is represented in protobuf as fixed size 32-bit field
  * aka WireTypes::Fixed32
  */
 using fixed32 = transparent<uint32_t, 1>;
 
-/**
- * @brief fixed64 unsigned 64-bit fixed size integer
+/*!
+ * \brief fixed64 unsigned 64-bit fixed size integer
  *
- * @details fixed64 is unsigned 64-bit integer that is represented in protobuf as fixed size 64-bit field
+ * \details fixed64 is unsigned 64-bit integer that is represented in protobuf as fixed size 64-bit field
  * aka WireTypes::Fixed64
  */
 using fixed64 = transparent<uint64_t, 1>;
 
-/**
- * @brief fixed32 signed 32-bit fixed size integer
+/*!
+ * \brief fixed32 signed 32-bit fixed size integer
  *
- * @details fixed32 is signed 32-bit integer that is represented in protobuf as fixed size 32-bit field
+ * \details fixed32 is signed 32-bit integer that is represented in protobuf as fixed size 32-bit field
  * aka WireTypes::Fixed32
  */
 using sfixed32 = transparent<int32_t, 1>;
 
-/**
- * @brief fixed64 signed 64-bit fixed size integer
+/*!
+ * \brief fixed64 signed 64-bit fixed size integer
  *
- * @details fixed64 is signed 64-bit integer that is represented in protobuf as fixed size 64-bit field
+ * \details fixed64 is signed 64-bit integer that is represented in protobuf as fixed size 64-bit field
  * aka WireTypes::Fixed64
  */
 using sfixed64 = transparent<int64_t, 1>;
 
-/**
- * @brief alias for list of qtprotobuf::int32
+/*!
+ * \brief alias for list of qtprotobuf::int32
  */
 using int32List = QList<int32>;
 
-/**
- * @brief alias for list of qtprotobuf::int64
+/*!
+ * \brief alias for list of qtprotobuf::int64
  */
 using int64List = QList<int64>;
 
-/**
- * @brief alias for list of qtprotobuf::uint32
+/*!
+ * \brief alias for list of qtprotobuf::uint32
  */
 using uint32List = QList<uint32>;
 
-/**
- * @brief alias for list of qtprotobuf::uint64
+/*!
+ * \brief alias for list of qtprotobuf::uint64
  */
 using uint64List = QList<uint64>;
 
-/**
- * @brief alias for list of qtprotobuf::sint32
+/*!
+ * \brief alias for list of qtprotobuf::sint32
  */
 using sint32List = QList<sint32>;
 
-/**
- * @brief alias for list of qtprotobuf::sint64
+/*!
+ * \brief alias for list of qtprotobuf::sint64
  */
 using sint64List = QList<sint64>;
 
-/**
- * @brief alias for list of qtprotobuf::fixed32
+/*!
+ * \brief alias for list of qtprotobuf::fixed32
  */
 using fixed32List = QList<fixed32>;
 
-/**
- * @brief alias for list of qtprotobuf::fixed64
+/*!
+ * \brief alias for list of qtprotobuf::fixed64
  */
 using fixed64List = QList<fixed64>;
 
-/**
- * @brief alias for list of qtprotobuf::sfixed32
+/*!
+ * \brief alias for list of qtprotobuf::sfixed32
  */
 using sfixed32List = QList<sfixed32>;
 
-/**
- * @brief alias for list of qtprotobuf::sfixed64
+/*!
+ * \brief alias for list of qtprotobuf::sfixed64
  */
 using sfixed64List = QList<sfixed64>;
 
-/**
- * @brief alias for list of qtprotobuf::float
+/*!
+ * \brief alias for list of qtprotobuf::float
  */
 using FloatList = QList<float>;
 
-/**
- * @brief alias for list of qtprotobuf::double
+/*!
+ * \brief alias for list of qtprotobuf::double
  */
 using DoubleList = QList<double>;
 
-/** @} */
+/*! \} */
 }
 
 Q_DECLARE_METATYPE(qtprotobuf::int32)
@@ -246,59 +246,59 @@ Q_DECLARE_METATYPE(qtprotobuf::sfixed64List)
 Q_DECLARE_METATYPE(qtprotobuf::FloatList)
 Q_DECLARE_METATYPE(qtprotobuf::DoubleList)
 
-//! @private
+//! \private
 template<>
 struct std::make_unsigned<qtprotobuf::int32> { typedef typename std::make_unsigned<decltype(qtprotobuf::int32::_t)>::type type; };
-//! @private
+//! \private
 template<>
 struct std::make_unsigned<qtprotobuf::int64> { typedef typename std::make_unsigned<decltype(qtprotobuf::int64::_t)>::type type; };
-//! @private
+//! \private
 template<>
 struct std::make_unsigned<qtprotobuf::fixed32> { typedef typename std::make_unsigned<decltype(qtprotobuf::fixed32::_t)>::type type; };
-//! @private
+//! \private
 template<>
 struct std::make_unsigned<qtprotobuf::fixed64> { typedef typename std::make_unsigned<decltype(qtprotobuf::fixed64::_t)>::type type; };
-//! @private
+//! \private
 template<>
 struct std::make_unsigned<qtprotobuf::sfixed32> { typedef typename std::make_unsigned<decltype(qtprotobuf::sfixed32::_t)>::type type; };
-//! @private
+//! \private
 template<>
 struct std::make_unsigned<qtprotobuf::sfixed64> { typedef typename std::make_unsigned<decltype(qtprotobuf::sfixed64::_t)>::type type; };
 
-//! @private
+//! \private
 template<>
 struct std::make_signed<qtprotobuf::int32> { typedef typename std::make_signed<decltype(qtprotobuf::int32::_t)>::type type; };
-//! @private
+//! \private
 template<>
 struct std::make_signed<qtprotobuf::int64> { typedef typename std::make_signed<decltype(qtprotobuf::int64::_t)>::type type; };
-//! @private
+//! \private
 template<>
 struct std::make_signed<qtprotobuf::fixed32> { typedef typename std::make_signed<decltype(qtprotobuf::fixed32::_t)>::type type; };
-//! @private
+//! \private
 template<>
 struct std::make_signed<qtprotobuf::fixed64> { typedef typename std::make_signed<decltype(qtprotobuf::fixed64::_t)>::type type; };
-//! @private
+//! \private
 template<>
 struct std::make_signed<qtprotobuf::sfixed32> { typedef typename std::make_signed<decltype(qtprotobuf::sfixed32::_t)>::type type; };
-//! @private
+//! \private
 template<>
 struct std::make_signed<qtprotobuf::sfixed64> { typedef typename std::make_signed<decltype(qtprotobuf::sfixed64::_t)>::type type; };
 
-//! @private
+//! \private
 template<>
 struct std::is_signed<qtprotobuf::int32> : public is_signed<decltype(qtprotobuf::int32::_t)> {};
-//! @private
+//! \private
 template<>
 struct std::is_signed<qtprotobuf::int64> : public is_signed<decltype(qtprotobuf::int64::_t)> {};
-//! @private
+//! \private
 template<>
 struct std::is_signed<qtprotobuf::fixed32> : public is_signed<decltype(qtprotobuf::fixed32::_t)> {};
-//! @private
+//! \private
 template<>
 struct std::is_signed<qtprotobuf::fixed64> : public is_signed<decltype(qtprotobuf::fixed64::_t)> {};
-//! @private
+//! \private
 template<>
 struct std::is_signed<qtprotobuf::sfixed32> : public is_signed<decltype(qtprotobuf::sfixed32::_t)> {};
-//! @private
+//! \private
 template<>
 struct std::is_signed<qtprotobuf::sfixed64> : public is_signed<decltype(qtprotobuf::sfixed64::_t)> {};

+ 4 - 0
src/protobuf/quick/qtprotobufquickplugin.h

@@ -28,6 +28,10 @@
 #include <QQmlExtensionPlugin>
 #include "qtprotobufquick_global.h"
 
+/*!
+ * \private
+ * \brief The QtProtobufQuickPlugin class
+ */
 class QTPROTOBUFQUICKSHARED_EXPORT QtProtobufQuickPlugin : public QQmlExtensionPlugin
 {
     Q_OBJECT