Update class decriptions for Doxygen

Author: TatianaBorisova

src/generator/classgeneratorbase.h

@@ -45,6 +45,11 @@ namespace generator {
 
 using PropertyMap = std::map<std::string, std::string>;
 
+/*!
+ * \ingroup generator
+ * \private
+ * \brief The ClassGeneratorBase class is base of source code generation
+ */
 class ClassGeneratorBase
 {
 public:

src/generator/classsourcegeneratorbase.h

@@ -33,6 +33,11 @@
 namespace QtProtobuf {
 namespace generator {
 
+/*!
+ * \ingroup generator
+ * \private
+ * \brief The ClassSourceGeneratorBase class implements source generation
+ */
 class ClassSourceGeneratorBase : public ClassGeneratorBase
 {
 public:

src/generator/clientgenerator.h

@@ -38,6 +38,11 @@ class Message;
 namespace QtProtobuf {
 namespace generator {
 
+/*!
+ * \ingroup generator
+ * \private
+ * \brief The ClientGenerator class
+ */
 class ClientGenerator : public ServiceGeneratorBase
 {
 public:

src/generator/clientsourcegenerator.h

@@ -29,7 +29,11 @@
 
 namespace QtProtobuf {
 namespace generator {
-
+/*!
+ * \ingroup generator
+ * \private
+ * \brief The ClientSourceGenerator class
+ */
 class ClientSourceGenerator : public ClassSourceGeneratorBase
 {
 public:

src/generator/enumsgenerator.h

@@ -35,6 +35,11 @@ class EnumDescriptor;
 namespace QtProtobuf {
 namespace generator {
 
+/*!
+ * \ingroup generator
+ * \private
+ * \brief The EnumsGenerator class
+ */
 class EnumsGenerator : public ClassGeneratorBase
 {
     const google::protobuf::EnumDescriptor *mEnumDescriptor;

src/generator/enumssourcegenerator.h

@@ -31,6 +31,11 @@
 namespace QtProtobuf {
 namespace generator {
 
+/*!
+ * \ingroup generator
+ * \private
+ * \brief The EnumsSourceGenerator class
+ */
 class EnumsSourceGenerator : public ClassGeneratorBase
 {
     const google::protobuf::EnumDescriptor *mEnumDescriptor;

src/generator/generator.h

@@ -40,7 +40,11 @@ class GeneratorContext;
 
 namespace QtProtobuf {
 namespace generator {
-
+/*!
+ * \ingroup generator
+ * \private
+ * \brief The QtGenerator class
+ */
 class QtGenerator : public GeneratorBase
 {
 public:

src/generator/generatorbase.h

@@ -41,6 +41,11 @@ class GeneratorContext;
 namespace QtProtobuf {
 namespace generator {
 
+/*!
+ * \ingroup generator
+ * \private
+ * \brief The GeneratorBase class
+ */
 class GeneratorBase: public ::google::protobuf::compiler::CodeGenerator
 {
 public:

src/generator/generatoroptions.h

@@ -30,6 +30,11 @@
 namespace QtProtobuf {
 namespace generator {
 
+/*!
+ * \ingroup generator
+ * \private
+ * \brief The GeneratorOptions class
+ */
 class GeneratorOptions
 {
     GeneratorOptions();

src/generator/globalenumsgenerator.h

@@ -31,6 +31,11 @@
 namespace QtProtobuf {
 namespace generator {
 
+/*!
+ * \ingroup generator
+ * \private
+ * \brief The GlobalEnumsGenerator class
+ */
 class GlobalEnumsGenerator : public ClassGeneratorBase
 {
     PackagesList mPackageList;

src/generator/globalenumssourcegenerator.h

@@ -30,7 +30,11 @@
 
 namespace QtProtobuf {
 namespace generator {
-
+/*!
+ * \ingroup generator
+ * \private
+ * \brief The GlobalEnumsSourceGenerator class
+ */
 class GlobalEnumsSourceGenerator : public ClassGeneratorBase
 {
     PackagesList mPackageList;

src/generator/main.cpp

@@ -30,6 +30,14 @@
 #include "generatoroptions.h"
 #include "utils.h"
 
+/*! \mainpage
+ * QtProtobuf is project that provides gRPC and Protobuf generator and bindings for Qt framework
+ *
+ * Look at project <a href="https://github.com/semlanik/qtprotobuf/blob/master/README.md">README</a> for installation and usage details.
+ *
+ * QtProtobuf distributed in terms of MIT license and is free for modification and use under MIT
+ * license <a href="https://github.com/semlanik/qtprotobuf/blob/master/LICENSE">terms</a>.
+ */
 using namespace ::QtProtobuf::generator;
 int main(int argc, char *argv[])
 {

src/generator/protobufclassgenerator.h

@@ -43,6 +43,11 @@ namespace generator {
 
 using PropertyMap = std::map<std::string, std::string>;
 
+/*!
+ * \ingroup generator
+ * \private
+ * \brief The ProtobufClassGenerator class
+ */
 class ProtobufClassGenerator : public ClassGeneratorBase
 {
     const ::google::protobuf::Descriptor *mMessage;

src/generator/protobufsourcegenerator.h

@@ -30,6 +30,11 @@
 namespace QtProtobuf {
 namespace generator {
 
+/*!
+ * \ingroup generator
+ * \private
+ * \brief The ProtobufSourceGenerator class
+ */
 class ProtobufSourceGenerator : public ClassSourceGeneratorBase
 {
     const google::protobuf::Descriptor *mMessage;

src/generator/servergenerator.h

@@ -38,6 +38,11 @@ class Message;
 namespace QtProtobuf {
 namespace generator {
 
+/*!
+ * \ingroup generator
+ * \private
+ * \brief The ServerGenerator class
+ */
 class ServerGenerator : public ServiceGeneratorBase
 {
     const google::protobuf::ServiceDescriptor *mService;

src/generator/servicegeneratorbase.h

@@ -38,6 +38,11 @@ class Message;
 namespace QtProtobuf {
 namespace generator {
 
+/*!
+ * \ingroup generator
+ * \private
+ * \brief The ServiceGeneratorBase class
+ */
 class ServiceGeneratorBase : public ClassGeneratorBase
 {
 protected:

src/generator/singlefilegenerator.h

@@ -42,6 +42,11 @@ class GeneratorContext;
 namespace QtProtobuf {
 namespace generator {
 
+/*!
+ * \ingroup generator
+ * \private
+ * \brief The SingleFileGenerator class
+ */
 class SingleFileGenerator : public GeneratorBase
 {
 public:

src/generator/templates.h

@@ -32,6 +32,11 @@
 namespace QtProtobuf {
 namespace generator {
 
+/*!
+ * \ingroup generator
+ * \private
+ * \brief The Templates class
+ */
 class Templates {
 public:
     static const std::vector<std::string> ListOfQmlExeptions;

src/generator/utils.h

@@ -44,6 +44,12 @@ class FileDescriptor;
 
 namespace QtProtobuf {
 namespace generator {
+
+/*!
+ * \ingroup generator
+ * \private
+ * \brief The utils class
+ */
 class utils {
 public:
 static void split(const std::string &str, std::vector<std::string> &container, char delim)

src/grpc/qabstractgrpcchannel.h

@@ -49,9 +49,10 @@ class Q_GRPC_EXPORT QAbstractGrpcChannel
 {
 public:
     /*!
-     * \brief Calls \p method synchronously with given serialized messge \p args and write result of call to \p ret.
-     *        \note This method is synchronous, that means it doesn't returns until call complete or aborted by timeout if it's
+     * \brief Calls \p method synchronously with given serialized message \p args and write result of call to \p ret.
+     *        \note This method is synchronous, that means it doesn't return until call is completed or aborted by timeout if it's
      *        implemented in inherited channel.
+     *        \note This method should not be called directly.
      * \param[in] method remote method is called
      * \param[in] service service identified in URL path format
      * \param[in] args serialized argument message
@@ -63,6 +64,7 @@ class Q_GRPC_EXPORT QAbstractGrpcChannel
     /*!
      * \brief Calls \p method asynchronously with given serialized messge \p args. Result of method call is written to QGrpcAsyncReply.
      *        \note This method is asynchronous, that means it returns control imediately after it is called.
+     *        \note This method should not be called directly.
      * \param[in] method remote method is called
      * \param[in] service service identified in URL path format
      * \param[in] args serialized argument message
@@ -74,6 +76,7 @@ class Q_GRPC_EXPORT QAbstractGrpcChannel
 
     /*!
      * \brief Subscribes to server-side stream to receive updates for given \p method.
+     *        \note This method should not be called directly.
      * \param[in] method remote method is called
      * \param[in] service service identified in URL path format
      * \param[in] args serialized argument message
@@ -83,16 +86,20 @@ class Q_GRPC_EXPORT QAbstractGrpcChannel
 
     virtual std::shared_ptr<QAbstractProtobufSerializer> serializer() const = 0;
 protected:
+    //! \private
     QAbstractGrpcChannel() = default;
+    //! \private
     virtual ~QAbstractGrpcChannel() = default;
 
     /*!
+     * \private
      * \brief Aborts async call for given \p reply
      * \param[in] reply returned by asynchronous QAbstractGrpcChannel::call() method
      */
     virtual void abort(QGrpcAsyncReply *reply);
 
     /*!
+     * \private
      * \brief Cancels \p subscription
      * \param[in] subscription returned by QAbstractGrpcChannel::subscribe() method
      */

src/grpc/qabstractgrpcclient.cpp

@@ -32,6 +32,8 @@
 #include <QTimer>
 
 namespace QtProtobuf {
+
+//! \private
 class QAbstractGrpcClientPrivate final {
 public:
     QAbstractGrpcClientPrivate(const QString &service) : service(service) {

src/grpc/qabstractgrpcclient.h

@@ -40,6 +40,10 @@
 
 #include "qtgrpcglobal.h"
 
+/*!
+ * \defgroup QtGrpc
+ * \brief Qt framework based gRPC clients and services
+ */
 namespace QtProtobuf {
 
 class QGrpcAsyncReply;
@@ -139,7 +143,7 @@ class Q_GRPC_EXPORT QAbstractGrpcClient : public QObject
      * \param[in] arg Protobuf message argument for \p method
      * \param[out] ret Pointer to preallocated return-message structure. \p ret Structure fields will be update each
      *        time message update recevied from server-stream.
-     * \note If \p ret is used as property-fiels in other object, property NOTIFY signal won't be called in case of
+     * \note If \p ret is used as property-fields in other object, property NOTIFY signal won't be called in case of
      *       updated message recevied from server-stream
      */
     template<typename A, typename R>
@@ -163,28 +167,26 @@ class Q_GRPC_EXPORT QAbstractGrpcClient : public QObject
     }
 
     /*!
-     * \brief Canceles all subscription for specified \p method
+     * \brief Canceles all subscriptions for specified \p method
      * \param[in] method Name of method subscription for to be canceled
      */
     void cancel(const QString &method);
 
+    /*!
+     * \brief serializer provides assigned to client serializer
+     * \return pointer to serializer. Serializer is owned by QtProtobuf::QProtobufSerializerRegistry.
+     */
     QAbstractProtobufSerializer *serializer() const;
 
     friend class QGrpcAsyncOperationBase;
 private:
-    /*!
-     * \private
-     */
+    //!\private
     QGrpcStatus call(const QString &method, const QByteArray &arg, QByteArray &ret);
 
-    /*!
-     * \private
-     */
+    //!\private
     QGrpcAsyncReply *call(const QString &method, const QByteArray &arg);
 
-    /*!
-     * \private
-     */
+    //!\private
     QGrpcSubscription *subscribe(const QString &method, const QByteArray &arg, const QtProtobuf::SubscriptionHandler &handler = {});
 
     /*!

src/grpc/qgrpcasyncoperationbase_p.h

@@ -38,6 +38,11 @@
 
 namespace QtProtobuf {
 
+/*!
+ * \ingroup QtGrpc
+ * \private
+ * \brief The QGrpcAsyncOperationBase class implements subscription logic
+ */
 class Q_GRPC_EXPORT QGrpcAsyncOperationBase : public QObject
 {
     Q_OBJECT
@@ -84,8 +89,7 @@ class Q_GRPC_EXPORT QGrpcAsyncOperationBase : public QObject
 
     /*!
      * \brief The signal is emitted when error happend in channel or during serialization
-     * \param code gRPC channel QGrpcStatus::StatusCode
-     * \param errorMessage Description of error occured
+     * \param[out] status received from gRPC channel
      */
     void error(const QGrpcStatus &status);
 

src/grpc/qgrpcasyncreply.h

@@ -40,7 +40,7 @@ namespace QtProtobuf {
 /*!
  * \ingroup QtGrpc
  * \brief The QGrpcAsyncReply class contains data for asynchronous call of gRPC client API. It's owned by client class, that
- *        created it. QGrpcAsyncReply coul be used by QAbstractGrpcChannel implementations to control call work flow and
+ *        created it. QGrpcAsyncReply could be used by QAbstractGrpcChannel implementations to control call work flow and
  *        abort calls if possible in case if QGrpcAsyncReply::abort method called by library user.
  */
 class Q_GRPC_EXPORT QGrpcAsyncReply final : public QGrpcAsyncOperationBase
@@ -84,6 +84,7 @@ class Q_GRPC_EXPORT QGrpcAsyncReply final : public QGrpcAsyncOperationBase
     ~QGrpcAsyncReply() = default;
 
 private:
+    //! \private
     QGrpcAsyncReply();
     Q_DISABLE_COPY_MOVE(QGrpcAsyncReply)