Focal CI: static checkers and doxygen linters

.github/workflows/ci.yml

@@ -23,3 +23,7 @@ jobs:
       - name: Compile and test
         id: ci
         uses: ignition-tooling/action-ignition-ci@focal
+        with:
+          cppcheck-enabled: true
+          cpplint-enabled: true
+          doxygen-enabled: true

include/ignition/transport/AdvertiseOptions.hh

@@ -37,7 +37,7 @@ namespace ignition
     class AdvertiseMessageOptionsPrivate;
     class AdvertiseServiceOptionsPrivate;
 
-    /// \def Scope This strongly typed enum defines the different options for
+    /// \brief This strongly typed enum defines the different options for
     /// the scope of a topic/service.
     enum class Scope_t
     {

include/ignition/transport/CIface.h

@@ -84,6 +84,7 @@ extern "C" {
   /// \brief Subscribe to a topic, and register a callback.
   /// \param[in] _node Pointer to a node.
   /// \param[in] _topic Name of the topic.
+  /// \param[in] _opts Subscriber options.
   /// \param[in] _callback The function to call when a message is received.
   /// \param[in] _userData Arbitrary user data pointer.
   /// \return 0 on success.

include/ignition/transport/Node.hh

@@ -253,7 +253,7 @@ namespace ignition
       /// \param[in] _topic Topic to be subscribed.
       /// \param[in] _callback Pointer to the callback function with the
       /// following parameters:
-      ///   \param[in] _msg Protobuf message containing a new topic update.
+      ///   * _msg Protobuf message containing a new topic update.
       /// \param[in] _opts Subscription options.
       /// \return true when successfully subscribed or false otherwise.
       public: template<typename MessageT>
@@ -267,7 +267,7 @@ namespace ignition
       /// In this version the callback is a lamda function.
       /// \param[in] _topic Topic to be subscribed.
       /// \param[in] _callback Lambda function with the following parameters:
-      ///   \param[in] _msg Protobuf message containing a new topic update.
+      ///   * _msg Protobuf message containing a new topic update.
       /// \param[in] _opts Subscription options.
       /// \return true when successfully subscribed or false otherwise.
       public: template<typename MessageT>
@@ -282,7 +282,7 @@ namespace ignition
       /// \param[in] _topic Topic to be subscribed.
       /// \param[in] _callback Pointer to the callback function with the
       /// following parameters:
-      ///   \param[in] _msg Protobuf message containing a new topic update.
+      ///   * _msg Protobuf message containing a new topic update.
       /// \param[in] _obj Instance containing the member function.
       /// \param[in] _opts Subscription options.
       /// \return true when successfully subscribed or false otherwise.
@@ -299,8 +299,8 @@ namespace ignition
       /// \param[in] _topic Topic to be subscribed.
       /// \param[in] _callback Pointer to the callback function with the
       /// following parameters:
-      ///   \param[in] _msg Protobuf message containing a new topic update.
-      ///   \param[in] _info Message information (e.g.: topic name).
+      ///   * _msg Protobuf message containing a new topic update.
+      ///   * _info Message information (e.g.: topic name).
       /// \param[in] _opts Subscription options.
       /// \return true when successfully subscribed or false otherwise.
       public: template<typename MessageT>
@@ -314,8 +314,8 @@ namespace ignition
       /// In this version the callback is a lamda function.
       /// \param[in] _topic Topic to be subscribed.
       /// \param[in] _callback Lambda function with the following parameters:
-      ///   \param[in] _msg Protobuf message containing a new topic update.
-      ///   \param[in] _info Message information (e.g.: topic name).
+      ///   * _msg Protobuf message containing a new topic update.
+      ///   * _info Message information (e.g.: topic name).
       /// \param[in] _opts Subscription options.
       /// \return true when successfully subscribed or false otherwise.
       public: template<typename MessageT>
@@ -331,8 +331,8 @@ namespace ignition
       /// \param[in] _topic Topic to be subscribed.
       /// \param[in] _callback Pointer to the callback function with the
       /// following parameters:
-      ///   \param[in] _msg Protobuf message containing a new topic update.
-      ///   \param[in] _info Message information (e.g.: topic name).
+      ///   * _msg Protobuf message containing a new topic update.
+      ///   * _info Message information (e.g.: topic name).
       /// \param[in] _obj Instance containing the member function.
       /// \param[in] _opts Subscription options.
       /// \return true when successfully subscribed or false otherwise.
@@ -361,9 +361,9 @@ namespace ignition
       /// \param[in] _topic Topic name associated to the service.
       /// \param[in] _callback Callback to handle the service request with the
       /// following parameters:
-      ///   \param[in] _request Protobuf message containing the request.
-      ///   \param[out] _reply Protobuf message containing the response.
-      ///   \return Service call result.
+      ///   * _request Protobuf message containing the request.
+      ///   * _reply Protobuf message containing the response.
+      ///   * Returns Service call result.
       /// \param[in] _options Advertise options.
       /// \return true when the topic has been successfully advertised or
       /// false otherwise.
@@ -379,8 +379,8 @@ namespace ignition
       /// \param[in] _topic Topic name associated to the service.
       /// \param[in] _callback Callback to handle the service request with the
       /// following parameters:
-      ///   \param[out] _reply Protobuf message containing the response.
-      ///   \return Service call result.
+      ///   * _reply Protobuf message containing the response.
+      ///   * Returns Service call result.
       /// \param[in] _options Advertise options.
       /// \return true when the topic has been successfully advertised or
       /// false otherwise.
@@ -396,7 +396,7 @@ namespace ignition
       /// \param[in] _topic Topic name associated to the service.
       /// \param[in] _callback Callback to handle the service request with the
       /// following parameters:
-      ///   \param[in] _request Protobuf message containing the request.
+      ///   * _request Protobuf message containing the request.
       /// \param[in] _options Advertise options.
       /// \return true when the topic has been successfully advertised or
       /// false otherwise.
@@ -412,9 +412,9 @@ namespace ignition
       /// \param[in] _topic Topic name associated to the service.
       /// \param[in] _callback Callback to handle the service request with the
       /// following parameters:
-      ///   \param[in] _request Protobuf message containing the request.
-      ///   \param[out] _reply Protobuf message containing the response.
-      ///   \return Service call result.
+      ///   * _request Protobuf message containing the request.
+      ///   * _reply Protobuf message containing the response.
+      ///   * Returns Service call result.
       /// \param[in] _options Advertise options.
       /// \return true when the topic has been successfully advertised or
       /// false otherwise.
@@ -431,8 +431,8 @@ namespace ignition
       /// \param[in] _topic Topic name associated to the service.
       /// \param[in] _callback Callback to handle the service request with the
       /// following parameters:
-      ///   \param[out] _reply Protobuf message containing the response.
-      ///   \return Service call result.
+      ///   * _reply Protobuf message containing the response.
+      ///   * Returns Service call result.
       /// \param[in] _options Advertise options.
       /// \return true when the topic has been successfully advertised or
       /// false otherwise.
@@ -448,7 +448,7 @@ namespace ignition
       /// \param[in] _topic Topic name associated to the service.
       /// \param[in] _callback Callback to handle the service request with the
       /// following parameters:
-      ///   \param[in] _request Protobuf message containing the request.
+      ///   * _request Protobuf message containing the request.
       /// \param[in] _options Advertise options.
       /// \return true when the topic has been successfully advertised or
       /// false otherwise.
@@ -464,9 +464,9 @@ namespace ignition
       /// \param[in] _topic Topic name associated to the service.
       /// \param[in] _callback Callback to handle the service request with the
       /// following parameters:
-      ///   \param[in] _request Protobuf message containing the request.
-      ///   \param[out] _reply Protobuf message containing the response.
-      ///   \return Service call result.
+      ///   * _request Protobuf message containing the request.
+      ///   * _reply Protobuf message containing the response.
+      ///   * Returns Service call result.
       /// \param[in] _obj Instance containing the member function.
       /// \param[in] _options Advertise options.
       /// \return true when the topic has been successfully advertised or
@@ -484,8 +484,8 @@ namespace ignition
       /// \param[in] _topic Topic name associated to the service.
       /// \param[in] _callback Callback to handle the service request with the
       /// following parameters:
-      ///   \param[out] _reply Protobuf message containing the response.
-      ///   \return Service call result.
+      ///   * _reply Protobuf message containing the response.
+      ///   * Returns Service call result.
       /// \param[in] _obj Instance containing the member function.
       /// \param[in] _options Advertise options.
       /// \return true when the topic has been successfully advertised or
@@ -503,7 +503,7 @@ namespace ignition
       /// \param[in] _topic Topic name associated to the service.
       /// \param[in] _callback Callback to handle the service request with the
       /// following parameters:
-      ///   \param[in] _request Protobuf message containing the request.
+      ///   * _request Protobuf message containing the request.
       /// \param[in] _obj Instance containing the member function.
       /// \param[in] _options Advertise options.
       /// \return true when the topic has been successfully advertised or
@@ -527,8 +527,8 @@ namespace ignition
       /// parameters.
       /// \param[in] _callback Pointer to the callback function executed when
       /// the response arrives. The callback has the following parameters:
-      ///   \param[in] _reply Protobuf message containing the response.
-      ///   \param[in] _result Result of the service call. If false, there was
+      ///   * _reply Protobuf message containing the response.
+      ///   * _result Result of the service call. If false, there was
       ///   a problem executing your request.
       /// \return true when the service call was succesfully requested.
       public: template<typename RequestT, typename ReplyT>
@@ -543,8 +543,8 @@ namespace ignition
       /// \param[in] _topic Service name requested.
       /// \param[in] _callback Pointer to the callback function executed when
       /// the response arrives. The callback has the following parameters:
-      ///   \param[in] _reply Protobuf message containing the response.
-      ///   \param[in] _result Result of the service call. If false, there was
+      ///   * _reply Protobuf message containing the response.
+      ///   * _result Result of the service call. If false, there was
       ///   a problem executing your request.
       /// \return true when the service call was succesfully requested.
       public: template<typename ReplyT>
@@ -559,8 +559,8 @@ namespace ignition
       /// parameters.
       /// \param[in] _callback Lambda function executed when the response
       /// arrives. The callback has the following parameters:
-      ///   \param[in] _reply Protobuf message containing the response.
-      ///   \param[in] _result Result of the service call. If false, there was
+      ///   * _reply Protobuf message containing the response.
+      ///   * _result Result of the service call. If false, there was
       ///   a problem executing your request.
       /// \return true when the service call was succesfully requested.
       public: template<typename RequestT, typename ReplyT>
@@ -576,8 +576,8 @@ namespace ignition
       /// \param[in] _topic Service name requested.
       /// \param[in] _callback Lambda function executed when the response
       /// arrives. The callback has the following parameters:
-      ///   \param[in] _reply Protobuf message containing the response.
-      ///   \param[in] _result Result of the service call. If false, there was
+      ///   * _reply Protobuf message containing the response.
+      ///   * _result Result of the service call. If false, there was
       ///   a problem executing your request.
       /// \return true when the service call was succesfully requested.
       public: template<typename ReplyT>
@@ -593,8 +593,8 @@ namespace ignition
       /// parameters.
       /// \param[in] _callback Pointer to the callback function executed when
       /// the response arrives. The callback has the following parameters:
-      ///   \param[in] _reply Protobuf message containing the response.
-      ///   \param[in] _result Result of the service call. If false, there was
+      ///   * _reply Protobuf message containing the response.
+      ///   * _result Result of the service call. If false, there was
       ///   a problem executing your request.
       /// \param[in] _obj Instance containing the member function.
       /// \return true when the service call was succesfully requested.
@@ -611,8 +611,8 @@ namespace ignition
       /// \param[in] _topic Service name requested.
       /// \param[in] _callback Pointer to the callback function executed when
       /// the response arrives. The callback has the following parameters:
-      ///   \param[in] _reply Protobuf message containing the response.
-      ///   \param[in] _result Result of the service call. If false, there was
+      ///   * _reply Protobuf message containing the response.
+      ///   * _result Result of the service call. If false, there was
       ///   a problem executing your request.
       /// \param[in] _obj Instance containing the member function.
       /// \return true when the service call was succesfully requested.

include/ignition/transport/NodeOptions.hh

@@ -96,7 +96,7 @@ namespace ignition
       /// The symbol '/' is allowed as part of a partition name but just '/' is
       /// not allowed. The symbols '@', '~' and ' ' are not allowed as part of a
       /// partition name. Two or more consecutive slashes ('//') are not allowed
-      /// \param[in] _ns The partition's name.
+      /// \param[in] _partition The partition's name.
       /// The default partition value is created using a combination of your
       /// hostname, followed by ':' and your username. E.g.: "bb9:caguero" .
       /// It's also possible to use the environment variable IGN_PARTITION for

include/ignition/transport/NodeShared.hh

@@ -81,7 +81,7 @@ namespace ignition
       /// \param[in, out] _ffn Deallocation function. This function is
       /// executed by ZeroMQ when the data is published. This function
       /// deallocates the buffer containing the published data.
-      /// \ref http://zeromq.org/blog:zero-copy
+      /// \sa http://zeromq.org/blog:zero-copy
       /// \param[in] _msgType Message type in string format.
       /// \return true when success or false otherwise.
       public: bool Publish(const std::string &_topic,

include/ignition/transport/Publisher.hh

@@ -50,7 +50,7 @@ namespace ignition
       /// \param[in] _topic Topic name.
       /// \param[in] _addr ZeroMQ address.
       /// \param[in] _pUuid Process UUID.
-      /// \param[in] _nUUID node UUID.
+      /// \param[in] _nUuid node UUID.
       /// \param[in] _opts The advertise options.
       public: Publisher(const std::string &_topic,
                         const std::string &_addr,
@@ -229,7 +229,7 @@ namespace ignition
       /// \param[in] _addr ZeroMQ address.
       /// \param[in] _ctrl ZeroMQ control address.
       /// \param[in] _pUuid Process UUID.
-      /// \param[in] _nUUID node UUID.
+      /// \param[in] _nUuid node UUID.
       /// \param[in] _msgTypeName Message type advertised by this publisher.
       /// \param[in] _opts Advertise options.
       public: explicit MessagePublisher(const std::string &_topic,
@@ -362,7 +362,7 @@ namespace ignition
       /// \param[in] _addr ZeroMQ address.
       /// \param[in] _id ZeroMQ socket ID.
       /// \param[in] _pUuid Process UUID.
-      /// \param[in] _nUUID node UUID.
+      /// \param[in] _nUuid node UUID.
       /// \param[in] _reqType Message type used in the service request.
       /// \param[in] _repType Message type used in the service response.
       /// \param[in] _opts Advertise options.

include/ignition/transport/RepHandler.hh

@@ -63,7 +63,7 @@ namespace ignition
       /// \brief Executes the local callback registered for this handler.
       /// \param[in] _msgReq Input parameter (Protobuf message).
       /// \param[out] _msgRep Output parameter (Protobuf message).
-      /// \param[out] _result Service call result.
+      /// \return Service call result.
       public: virtual bool RunLocalCallback(const transport::ProtoMsg &_msgReq,
                                             transport::ProtoMsg &_msgRep) = 0;
 
@@ -72,7 +72,7 @@ namespace ignition
       /// to compose a specific protobuf message and will be passed to the
       /// callback function.
       /// \param[out] _rep Out parameter with the data serialized.
-      /// \param[out] _result Service call result.
+      /// \return Service call result.
       public: virtual bool RunCallback(const std::string &_req,
                                        std::string &_rep) = 0;
 
@@ -118,9 +118,9 @@ namespace ignition
 
       /// \brief Set the callback for this handler.
       /// \param[in] _cb The callback with the following parameters:
-      /// \param[in] _req Protobuf message containing the service request params
-      /// \param[out] _rep Protobuf message containing the service response.
-      /// \param[out] _result True when the service response is considered
+      /// * _req Protobuf message containing the service request params
+      /// * _rep Protobuf message containing the service response.
+      /// * Returns true when the service response is considered
       /// successful or false otherwise.
       public: void SetCallback(
         const std::function<bool(const Req &, Rep &)> &_cb)

include/ignition/transport/ReqHandler.hh

@@ -214,8 +214,8 @@ namespace ignition
 
       /// \brief Set the callback for this handler.
       /// \param[in] _cb The callback with the following parameters:
-      /// \param[in] _rep Protobuf message containing the service response.
-      /// \param[in] _result True when the service request was successful or
+      /// * _rep Protobuf message containing the service response.
+      /// * _result True when the service request was successful or
       /// false otherwise.
       public: void SetCallback(const std::function <void(
         const Rep &_rep, const bool _result)> &_cb)
@@ -242,8 +242,9 @@ namespace ignition
       /// It shouldn't do anything.
       /// \param[in] _repMsg Protofub message containing the variable where
       /// the result will be stored.
-      public: void SetResponse(const Rep * /*_repMsg*/)
+      public: void SetResponse(const Rep *_repMsg)
       {
+        (void)_repMsg;
       }
 
       // Documentation inherited