Quellcode durchsuchen

Add missing documentation of modbus_set_float functions

Stéphane Raimbault vor 9 Jahren
Ursprung
Commit
4a303e94c7

+ 3 - 0
doc/Makefile.am

@@ -43,6 +43,9 @@ TXT3 = \
         modbus_set_debug.txt \
         modbus_set_error_recovery.txt \
         modbus_set_float.txt \
+        modbus_set_float_abcd.txt \
+        modbus_set_float_badc.txt \
+        modbus_set_float_cdab.txt \
         modbus_set_float_dcba.txt \
         modbus_set_response_timeout.txt \
         modbus_set_slave.txt \

+ 1 - 1
doc/modbus_get_float_abcd.txt

@@ -28,9 +28,9 @@ The function shall return a float.
 SEE ALSO
 --------
 linkmb:modbus_set_float_abcd[3]
-linkmb:modbus_get_float_dcba[3]
 linkmb:modbus_get_float_badc[3]
 linkmb:modbus_get_float_cdab[3]
+linkmb:modbus_get_float_dcba[3]
 
 
 AUTHORS

+ 1 - 2
doc/modbus_get_float_badc.txt

@@ -14,7 +14,6 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-
 The *modbus_get_float_badc()* function shall get a float from 4 bytes with
 swapped bytes (BADC instead of ABCD). The _src_ array must be a pointer on two
 16 bits values, for example, if the first word is set to 0x2000 and the second
@@ -30,8 +29,8 @@ SEE ALSO
 --------
 linkmb:modbus_set_float_badc[3]
 linkmb:modbus_get_float_abcd[3]
-linkmb:modbus_get_float_dcba[3]
 linkmb:modbus_get_float_cdab[3]
+linkmb:modbus_get_float_dcba[3]
 
 
 AUTHORS

+ 1 - 1
doc/modbus_get_float_cdab.txt

@@ -29,8 +29,8 @@ SEE ALSO
 --------
 linkmb:modbus_set_float_cdab[3]
 linkmb:modbus_get_float_abcd[3]
-linkmb:modbus_get_float_dcba[3]
 linkmb:modbus_get_float_badc[3]
+linkmb:modbus_get_float_dcba[3]
 
 
 AUTHORS

+ 38 - 0
doc/modbus_set_float_abcd.txt

@@ -0,0 +1,38 @@
+modbus_set_float_abcd(3)
+========================
+
+
+NAME
+----
+modbus_set_float_abcd - set a float value in 2 registers using ABCD byte order
+
+
+SYNOPSIS
+--------
+*void modbus_set_float_abcd(float 'f', uint16_t *'dest');*
+
+
+DESCRIPTION
+-----------
+The *modbus_set_float_abcd()* function shall set a float to 4 bytes in usual
+Modbus format. The _dest_ array must be pointer on two 16 bits values to be able
+to store the full result of the conversion.
+
+
+RETURN VALUE
+------------
+There is no return values.
+
+
+SEE ALSO
+--------
+linkmb:modbus_get_float_abcd[3]
+linkmb:modbus_set_float_badc[3]
+linkmb:modbus_set_float_cdab[3]
+linkmb:modbus_set_float_dcba[3]
+
+
+AUTHORS
+-------
+The libmodbus documentation was written by Stéphane Raimbault
+<stephane.raimbault@gmail.com>

+ 38 - 0
doc/modbus_set_float_badc.txt

@@ -0,0 +1,38 @@
+modbus_set_float_badc(3)
+========================
+
+
+NAME
+----
+modbus_set_float_badc - set a float value in 2 registers using BADC byte order
+
+
+SYNOPSIS
+--------
+*void modbus_set_float_badc(float 'f', uint16_t *'dest');*
+
+
+DESCRIPTION
+-----------
+The *modbus_set_float_badc()* function shall set a float to 4 bytes in swapped
+bytes Modbus format (BADC insted of ABCD). The _dest_ array must be pointer on
+two 16 bits values to be able to store the full result of the conversion.
+
+
+RETURN VALUE
+------------
+There is no return values.
+
+
+SEE ALSO
+--------
+linkmb:modbus_get_float_badc[3]
+linkmb:modbus_set_float_abcd[3]
+linkmb:modbus_set_float_cdab[3]
+linkmb:modbus_set_float_dcba[3]
+
+
+AUTHORS
+-------
+The libmodbus documentation was written by Stéphane Raimbault
+<stephane.raimbault@gmail.com>

+ 39 - 0
doc/modbus_set_float_cdab.txt

@@ -0,0 +1,39 @@
+modbus_set_float_cdab(3)
+========================
+
+
+NAME
+----
+modbus_set_float_cdab - set a float value in 2 registers using CDAB byte order
+
+
+SYNOPSIS
+--------
+*void modbus_set_float_cdab(float 'f', uint16_t *'dest');*
+
+
+DESCRIPTION
+-----------
+The *modbus_set_float_cdab()* function shall set a float to 4 bytes in swapped
+words Modbus format (CDAB order instead of ABCD). The _dest_ array must be
+pointer on two 16 bits values to be able to store the full result of the
+conversion.
+
+
+RETURN VALUE
+------------
+There is no return values.
+
+
+SEE ALSO
+--------
+linkmb:modbus_get_float_cdab[3]
+linkmb:modbus_set_float_abcd[3]
+linkmb:modbus_set_float_badc[3]
+linkmb:modbus_set_float_dcba[3]
+
+
+AUTHORS
+-------
+The libmodbus documentation was written by Stéphane Raimbault
+<stephane.raimbault@gmail.com>