Few cosmetic changes in doxy comments

src/grpc/abstractchannel.h

@@ -36,17 +36,14 @@ namespace qtprotobuf {
 class AsyncReply;
 class AbstractClient;
 /*!
-*  \addtogroup QtGrpc
-*  \{
-*/
-
-/*!
+ * \ingroup QtGrpc
  * \brief The AbstractChannel class
  */
 class QTGRPCSHARED_EXPORT AbstractChannel
 {
 public:
     /*!
+     * \enum StatusCode
      * \brief Channel's status codes
      */
     enum StatusCode {
@@ -109,5 +106,4 @@ protected:
 private:
     Q_DISABLE_COPY(AbstractChannel)
 };
-/*! \} */
 }

src/grpc/abstractclient.h

@@ -40,14 +40,10 @@
 #include "qtgrpc_global.h"
 
 namespace qtprotobuf {
-/*!
-*  \addtogroup QtGrpc
-*  \{
-*/
-
 class AbstractChannel;
 
 /*!
+ * \ingroup QtGrpc
  * \brief The AbstractClient class
  */
 class QTGRPCSHARED_EXPORT AbstractClient : public QObject
@@ -139,5 +135,4 @@ private:
     // PIMPL
     class AbstractClientPrivate *d;
 };
-/*! \} */
 }

src/grpc/asyncreply.h

@@ -36,11 +36,7 @@
 
 namespace qtprotobuf {
 /*!
-*  \addtogroup QtGrpc
-*  \{
-*/
-
-/*!
+ * \ingroup QtGrpc
  * \brief The AsyncReply class
  */
 class QTGRPCSHARED_EXPORT AsyncReply final : public QObject
@@ -83,5 +79,4 @@ private:
 
     QMutex m_asyncLock;
 };
-/*! \} */
 }

src/grpc/http2channel.h

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

src/grpc/insecurecredentials.h

@@ -31,11 +31,7 @@
 
 namespace qtprotobuf {
 /*!
-*  \addtogroup QtGrpc
-*  \{
-*/
-
-/*!
+ * \ingroup QtGrpc
  * \brief The InsecureCredentials class
  */
 class QTGRPCSHARED_EXPORT InsecureCredentials : public ChannelCredentials
@@ -43,5 +39,4 @@ class QTGRPCSHARED_EXPORT InsecureCredentials : public ChannelCredentials
 public:
     InsecureCredentials() : ChannelCredentials(CredentialMap()) {}
 };
-/*! \} */
 }

src/grpc/sslcredentials.h

@@ -33,11 +33,7 @@
 
 namespace qtprotobuf {
 /*!
-*  \addtogroup QtGrpc
-*  \{
-*/
-
-/*!
+ * \ingroup QtGrpc
  * \brief The SslCredentials class
  */
 class QTGRPCSHARED_EXPORT SslCredentials : public ChannelCredentials
@@ -47,5 +43,4 @@ public:
         ChannelCredentials(CredentialMap{{QLatin1String("sslConfig"),
                            QVariant::fromValue<QSslConfiguration>(configuation)}}) {}
 };
-/*! \} */
 }

src/protobuf/qabstractprotobufserializer.h

@@ -97,7 +97,9 @@ protected:
     SerializerRegistry m_handlers;//TODO: move to d-prointer
 };
 
-
+/*!
+ * \brief The QProtobufSerializer class
+ */
 class QTPROTOBUFSHARED_EXPORT QProtobufSerializer : public QAbstractProtobufSerializer
 {
 public:

src/protobuf/qprotobufobject.h

@@ -28,13 +28,30 @@
 #include "qprotobufserializerregistry.h"
 #include <unordered_map>
 
+/*!
+*  \addtogroup QtProtobuf
+*  \{
+*/
+
+/*!
+ * \def Q_DECLARE_PROTOBUF_SERIALIZERS(T)
+ * Defines serializers for type T inherited of QObject. Is part of autogenerated by qtprogobufgenerator classes
+ */
+
 #define Q_DECLARE_PROTOBUF_SERIALIZERS(T)\
     public:\
         QByteArray serialize() const { return qtprotobuf::QProtobufSerializerRegistry::serialize<T>(this); }\
         void deserialize(const QByteArray &array) { qtprotobuf::QProtobufSerializerRegistry::deserialize<T>(this, array); }\
     private:
 
+/*!
+ * \def Q_PROTOBUF_OBJECT
+ * Declares propertyOrdering for type T inherited of QObject. Is part of autogenerated by qtprogobufgenerator classes
+ */
+
 #define Q_PROTOBUF_OBJECT\
     public:\
         static const qtprotobuf::QProtobufPropertyOrdering propertyOrdering;\
     private:
+
+/*! \} */

src/protobuf/qprotobufserializerregistry.h

@@ -39,11 +39,7 @@
 
 namespace qtprotobuf {
 /*!
-*  \addtogroup QtProtobuf
-*  \{
-*/
-
-/*!
+ * \ingroup QtProtobuf
  * \brief The QProtobufSerializerRegistry class provides api to register serializers of QObjects
  *
  * \details The QProtobufSerializerRegistry class registers serializers/deserializers for classes inherited of QObject.
@@ -297,6 +293,4 @@ private:
         previous = QVariant::fromValue<QMap<K, QSharedPointer<V>>>(out);
     }
 };
-
-/*! \} */
 }

src/protobuf/qqmllistpropertyconstructor.h

@@ -29,28 +29,32 @@
 #include <QQmlEngine>
 
 namespace qtprotobuf {
-
+//! \private
 template<typename T>
 static void qmllistpropertyAppend(QQmlListProperty<T> *p, T *v) {
     QQmlEngine::setObjectOwnership(v, QQmlEngine::CppOwnership);
     reinterpret_cast<QList<QSharedPointer<T>> *>(p->data)->append(QSharedPointer<T>(v));
 }
 
+//! \private
 template<typename T>
 static int qmllistpropertyCount(QQmlListProperty<T> *p) {
     return reinterpret_cast<QList<QSharedPointer<T>> *>(p->data)->count();
 }
 
+//! \private
 template<typename T>
 static T * qmllistpropertyAt(QQmlListProperty<T> *p, int index) {
     return reinterpret_cast<QList<QSharedPointer<T>> *>(p->data)->at(index).data();
 }
 
+//! \private
 template<typename T>
 static void qmllistpropertyReset(QQmlListProperty<T> *p){
     reinterpret_cast<QList<QSharedPointer<T>> *>(p->data)->clear();
 }
 
+//! \private
 template<typename T>
 static QQmlListProperty<T> constructQmlListProperty(QObject *p, QList<QSharedPointer<T>> *data)
 {

src/protobuf/qtprotobuftypes.h

@@ -39,17 +39,17 @@ namespace qtprotobuf {
 /*!
  * \brief The WireTypes enumeration reflects protobuf default wiretypes
  *
- * \details Look at https://developers.google.com/protocol-buffers/docs/encoding for details.
+ * \see https://developers.google.com/protocol-buffers/docs/encoding for details.
  *
  */
 enum WireTypes {
     UnknownWireType = -1, //!< Invalid wire type
-    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
-    Fixed32 = 5 //!< fixed32, sfixed32, float
+    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
+    Fixed32 = 5           //!< fixed32, sfixed32, float
 };
 
 //! \private

src/protobuf/registrationhelper.h

@@ -23,6 +23,8 @@
  * DEALINGS IN THE SOFTWARE.
  */
 
+#pragma once
+
 #include <functional>
 namespace qtprotobuf {