doxygen fixes

BlueAndi · Oct 30, 2024 · 422464b · 422464b
1 parent e39d8ee
commit 422464b
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 27 deletions.
diff --git a/lib/APPTurtle/src/Transports/CustomRosTransportTcp.cpp b/lib/APPTurtle/src/Transports/CustomRosTransportTcp.cpp
@@ -152,29 +152,6 @@ size_t CustomRosTransportTcp::read(uint8_t* buffer, size_t size, int timeout, ui
          * The read function relationships are:
          * 
          * read() -> [state]->read() -> readInternal() -> WifiClient
-         * 
-         * @startuml "TCP Reader Relationships"
-         * Actor MicroRos order 10
-         * participant CustomRosTransportTcp order 20
-         * participant WifiClient order 20
-         * 
-         * MicroRos-> CustomRosTransportTcp : read()
-         * activate CustomRosTransportTcp
-         * group loop StateMachine [while loop]
-         *     group alt state 
-         *         CustomRosTransportTcp -> CustomRosTransportTcp : read<State>(&loop)
-         *         activate CustomRosTransportTcp
-         *             CustomRosTransportTcp -> CustomRosTransportTcp : readInternal()
-         *             activate CustomRosTransportTcp
-         *                 CustomRosTransportTcp -> WifiClient : read
-         *                 activate WifiClient
-         *                 return
-         *             return
-         *         return
-         *     end
-         * end
-         * return
-         * @enduml
          */
         while (loop)
         {

diff --git a/lib/APPTurtle/src/Transports/CustomRosTransportTcp.h b/lib/APPTurtle/src/Transports/CustomRosTransportTcp.h
@@ -57,7 +57,7 @@
 /** 
  * Map this transport to the class name used in MicroRosClient.
  * The used transport is a compile time decision and this typedef
- * avoids the use of #ifdef's.
+ * avoids the use of ifdef's.
  */
 typedef class CustomRosTransportTcp CustomRosTransport;
 
@@ -164,6 +164,8 @@ class CustomRosTransportTcp : public CustomRosTransportBase
      * 
      * @param[in]  timeout The timeout in milliseconds.
      * @param[out] errorCode Set the error code to != 0 on error.
+     *
+     *  @return true if statemachine shall reloop.
      */
     bool readSizePrefix(int timeout, uint8_t* errorCode);
 
@@ -197,7 +199,6 @@ class CustomRosTransportTcp : public CustomRosTransportBase
      * Used in the rare event that low level read only provided one byte.
      * 
      * @param[in]  timeout The timeout in milliseconds.
-     * @param[out] loop Indicate if state machine shall reloop.
      * @param[out] errorCode Set the error code to != 0 on error.
      * 
      * @return true if statemachine shall reloop.
@@ -208,7 +209,8 @@ class CustomRosTransportTcp : public CustomRosTransportBase
     WiFiClient            m_tcpClient;     /**< The TCP client.     */
     static const String   m_protocolName;  /**< This protocol name. */
 
-    /* Read buffer handling from streaming sockets to implement framing.
+    /**
+     *  Read buffer handling from streaming sockets to implement framing.
      *
      * Custom transports with framing support need a customized agent.
      * That is why the framing is implemented here to work with the

diff --git a/lib/APPTurtle/src/Transports/CustomRosTransportUdp.h b/lib/APPTurtle/src/Transports/CustomRosTransportUdp.h
@@ -57,7 +57,7 @@
 /** 
  * Map this transport to the class name used in MicroRosClient.
  * The used transport is a compile time decision and this typedef
- * avoids the use of #ifdef's.
+ * avoids the use of ifdef's.
  */
 typedef class CustomRosTransportUdp CustomRosTransport;