Fixes a typo and start doxygen documentation

Author: epsilonrt

dev/codelite/executable-modbuspp/main.cpp

@@ -20,7 +20,7 @@ int main (int argc, char **argv) {
     uint16_t value;
 
     mb.setSlave (8); // to the slave at address 8
-    mb.readInputRegistrers (1, &value);
+    mb.readInputRegisters (1, &value);
     // ....
     mb.close();
   }

include/modbuspp.h

@@ -22,6 +22,9 @@
 #include <modbus.h>
 #include "global.h"
 
+/**
+ *
+ */
 namespace Modbus {
 
   const int Broadcast = MODBUS_BROADCAST_ADDRESS;
@@ -61,7 +64,7 @@ namespace Modbus {
         Float,
         Double
       };
-      
+
       enum Endian {
         EndianBigBig = 0x00, // bytes in big endian order, word in big endian order
         EndianBig = EndianBigBig,
@@ -86,7 +89,7 @@ namespace Modbus {
 
   /**
    * @class Timeout
-   * @brief
+   * @brief Représente une durée de timeout
    */
   class Timeout {
     public:
@@ -96,74 +99,13 @@ namespace Modbus {
       uint32_t usec;
   };
 
-  /**
-   * @class NetLayer
-   * @brief
-   */
-  class NetLayer  {
-
-    protected:
-      class Private;
-      NetLayer (Private &dd);
-      std::unique_ptr<Private> d_ptr;
 
-    private:
-      PIMP_DECLARE_PRIVATE (NetLayer)
-  };
-
-  /**
-   * @class TcpLayer
-   * @brief
-   */
-  class TcpLayer : public NetLayer {
-    public:
-      const std::string & node() const;
-      const std::string & service() const;
-
-      friend class Device;
-
-    protected:
-      class Private;
-      TcpLayer (Private &dd);
-
-    private:
-      PIMP_DECLARE_PRIVATE (TcpLayer)
-  };
-
-  /**
-   * @class RtuLayer
-   * @brief
-   */
-  class RtuLayer : public NetLayer {
-    public:
-      const std::string & port() const;
-      int baud() const;
-      char parity() const;
-      int stop() const;
-
-      SerialMode serialMode();
-      bool setSerialMode (SerialMode mode);
-      SerialRts rts();
-      bool setRts (SerialRts rts);
-      int rtsDelay();
-      bool setRtsDelay (int delay);
-
-      static int baud (const std::string & settings);
-      static char parity (const std::string & settings);
-      static int stop (const std::string & settings);
-
-      friend class Device;
-    protected:
-      class Private;
-      RtuLayer (Private &dd);
-
-    private:
-      PIMP_DECLARE_PRIVATE (RtuLayer)
-  };
+  class RtuLayer;
+  class TcpLayer;
 
   /**
    * @class Device
-   * @brief
+   * @brief Représente un équipement connecté à MODBUS
    */
   class Device  {
     public:
@@ -215,23 +157,100 @@ namespace Modbus {
 
   /**
    * @class Master
-   * @brief
+   * @brief MODBUS Master (Client)
    */
   class Master : public Device {
+    
     public:
-
+      /**
+       * @brief Constructor
+       * @param net
+       * @param connection
+       * @param settings
+       */
       Master (Net net = Tcp, const std::string & connection = "*",
               const std::string & settings = "502");
+      /**
+       * @brief Destructor
+       */
       virtual ~Master();
 
+      /**
+       * @brief
+       * @param addr
+       * @param dest
+       * @param nb
+       * @return
+       */
       int readDiscreteInputs (int addr, bool * dest, int nb = 1);
+      /**
+       * @brief
+       * @param addr
+       * @param dest
+       * @param nb
+       * @return
+       */
       int readCoils (int addr, bool * dest, int nb = 1);
-      int readInputRegistrers (int addr, uint16_t * dest, int nb = 1);
+      /**
+       * @brief
+       * @param addr
+       * @param dest
+       * @param nb
+       * @return
+       */
+      int readInputRegisters (int addr, uint16_t * dest, int nb = 1);
+      /**
+       * @brief
+       * @param addr
+       * @param dest
+       * @param nb
+       * @return
+       */
       int readRegistrers (int addr, uint16_t * dest, int nb = 1);
+      /**
+       * @brief write a single bit
+       * 
+       * This function shall write the status of value at the address addr of 
+       * the remote device. \n
+       * The function uses the Modbus function code 0x05 (force single coil).
+       * @param addr
+       * @param value
+       * @return 
+       */
       int writeCoil (int addr, bool value);
+      /**
+       * @brief
+       * @param addr
+       * @param src
+       * @param nb
+       * @return
+       */
       int writeCoils (int addr, const bool * src, int nb);
+      /**
+       * @brief
+       * @param addr
+       * @param value
+       * @return
+       */
       int writeRegistrer (int addr, uint16_t value);
+      /**
+       * @brief
+       * @param addr
+       * @param src
+       * @param nb
+       * @return
+       */
       int writeRegistrers (int addr, const uint16_t * src, int nb);
+      /**
+       * @brief
+       * @param waddr
+       * @param src
+       * @param wnb
+       * @param raddr
+       * @param dest
+       * @param rnb
+       * @return
+       */
       int writeReadRegistrers (int waddr, const uint16_t * src, int wnb,
                                int raddr, uint16_t * dest, int rnb);
 
@@ -243,6 +262,72 @@ namespace Modbus {
       PIMP_DECLARE_PRIVATE (Master)
   };
 
+
+  /**
+   * @class NetLayer
+   * @brief
+   */
+  class NetLayer  {
+
+    protected:
+      class Private;
+      NetLayer (Private &dd);
+      std::unique_ptr<Private> d_ptr;
+
+    private:
+      PIMP_DECLARE_PRIVATE (NetLayer)
+  };
+
+  /**
+   * @class TcpLayer
+   * @brief
+   */
+  class TcpLayer : public NetLayer {
+    public:
+      const std::string & node() const;
+      const std::string & service() const;
+
+      friend class Device;
+
+    protected:
+      class Private;
+      TcpLayer (Private &dd);
+
+    private:
+      PIMP_DECLARE_PRIVATE (TcpLayer)
+  };
+
+  /**
+   * @class RtuLayer
+   * @brief
+   */
+  class RtuLayer : public NetLayer {
+    public:
+      const std::string & port() const;
+      int baud() const;
+      char parity() const;
+      int stop() const;
+
+      SerialMode serialMode();
+      bool setSerialMode (SerialMode mode);
+      SerialRts rts();
+      bool setRts (SerialRts rts);
+      int rtsDelay();
+      bool setRtsDelay (int delay);
+
+      static int baud (const std::string & settings);
+      static char parity (const std::string & settings);
+      static int stop (const std::string & settings);
+
+      friend class Device;
+    protected:
+      class Private;
+      RtuLayer (Private &dd);
+
+    private:
+      PIMP_DECLARE_PRIVATE (RtuLayer)
+  };
+
 }
 /**
  *  @}

src/modbuspp.cpp

@@ -352,7 +352,7 @@ namespace Modbus {
   }
 
   // ---------------------------------------------------------------------------
-  int Master::readInputRegistrers (int addr, uint16_t * dest, int nb) {
+  int Master::readInputRegisters (int addr, uint16_t * dest, int nb) {
 
     if (isOpen()) {
       PIMP_D (Master);