diff --git a/doc/checksum_NMEA.md b/doc/checksum_NMEA.md index fac4a87..5881570 100644 --- a/doc/checksum_NMEA.md +++ b/doc/checksum_NMEA.md @@ -2,12 +2,14 @@ ### `checksum_NMEA( input_str, result );` +### Parameters + | Parameter | Type | Description | | :--- | :--- | :--- | |**`input_str`**|`const unsigned char *`|The NUL terminated input string for which the NMEA checksum must be calculated| |**`result`**|`unsigned char *`|Storage buffer to the calculated NMEA checksum| -### Returns +### Return Value | Type | Description | | :--- | :--- | diff --git a/doc/crc_16.md b/doc/crc_16.md index b2c4f14..89da67e 100644 --- a/doc/crc_16.md +++ b/doc/crc_16.md @@ -2,12 +2,14 @@ ### `crc_16( input_str, num_bytes );` +### Parameters + | Parameter | Type | Description | | :--- | :--- | :--- | |**`input_str`**|`const unsigned char *`|The input byte buffer for which the CRC must be calculated| |**`num_bytes`**|`size_t`|The number of characters in the input buffer| -### Returns +### Return Value | Type | Description | | :--- | :--- | diff --git a/doc/crc_32.md b/doc/crc_32.md index 2659b30..61fb88e 100644 --- a/doc/crc_32.md +++ b/doc/crc_32.md @@ -9,7 +9,7 @@ |**`input_str`**|`const unsigned char *`|The input byte buffer for which the CRC must be calculated| |**`num_bytes`**|`size_t`|The number of characters in the input buffer| -### Returns +### Return Value | Type | Description | | :--- | :--- | diff --git a/doc/crc_8.md b/doc/crc_8.md index f7999db..61444e7 100644 --- a/doc/crc_8.md +++ b/doc/crc_8.md @@ -2,12 +2,14 @@ ### `crc_8( input_str, num_bytes );` +### Parameters + | Parameter | Type | Description | | :--- | :--- | :--- | |**`input_str`**|`const unsigned char *`|The input byte buffer for which the CRC must be calculated| |**`num_bytes`**|`size_t`|The number of characters in the input buffer| -### Returns +### Return Value | Type | Description | | :--- | :--- | diff --git a/doc/crc_ccitt_1d0f.md b/doc/crc_ccitt_1d0f.md index e0d08c1..becba21 100644 --- a/doc/crc_ccitt_1d0f.md +++ b/doc/crc_ccitt_1d0f.md @@ -9,7 +9,7 @@ |**`input_str`**|`const unsigned char *`|The input byte buffer for which the CRC must be calculated| |**`num_bytes`**|`size_t`|The number of characters in the input buffer| -### Returns +### Return Value | Type | Description | | :--- | :--- | diff --git a/doc/crc_ccitt_ffff.md b/doc/crc_ccitt_ffff.md index eb4f33a..f21c678 100644 --- a/doc/crc_ccitt_ffff.md +++ b/doc/crc_ccitt_ffff.md @@ -9,7 +9,7 @@ |**`input_str`**|`const unsigned char *`|The input byte buffer for which the CRC must be calculated| |**`num_bytes`**|`size_t`|The number of characters in the input buffer| -### Returns +### Return Value | Type | Description | | :--- | :--- | diff --git a/doc/crc_dnp.md b/doc/crc_dnp.md index 81b160f..6f5c7b8 100644 --- a/doc/crc_dnp.md +++ b/doc/crc_dnp.md @@ -9,7 +9,7 @@ |**`input_str`**|`const unsigned char *`|The input byte buffer for which the CRC must be calculated| |**`num_bytes`**|`size_t`|The number of characters in the input buffer| -### Returns +### Return Value | Type | Description | | :--- | :--- | diff --git a/doc/crc_kermit.md b/doc/crc_kermit.md index 1abe90a..fe628c6 100644 --- a/doc/crc_kermit.md +++ b/doc/crc_kermit.md @@ -9,7 +9,7 @@ |**`input_str`**|`const unsigned char *`|The input byte buffer for which the CRC must be calculated| |**`num_bytes`**|`size_t`|The number of characters in the input buffer| -### Returns +### Return Value | Type | Description | | :--- | :--- | diff --git a/doc/crc_modbus.md b/doc/crc_modbus.md index 7a8ebc6..69a5078 100644 --- a/doc/crc_modbus.md +++ b/doc/crc_modbus.md @@ -9,7 +9,7 @@ |**`input_str`**|`const unsigned char *`|The input byte buffer for which the CRC must be calculated| |**`num_bytes`**|`size_t`|The number of characters in the input buffer| -### Returns +### Return Value | Type | Description | | :--- | :--- | diff --git a/doc/crc_sick.md b/doc/crc_sick.md index 1551ed2..f064765 100644 --- a/doc/crc_sick.md +++ b/doc/crc_sick.md @@ -9,7 +9,7 @@ |**`input_str`**|`const unsigned char *`|The input byte buffer for which the CRC must be calculated| |**`num_bytes`**|`size_t`|The number of characters in the input buffer| -### Returns +### Return Value | Type | Description | | :--- | :--- | diff --git a/doc/crc_xmodem.md b/doc/crc_xmodem.md index 06a7aa5..5476118 100644 --- a/doc/crc_xmodem.md +++ b/doc/crc_xmodem.md @@ -9,7 +9,7 @@ |**`input_str`**|`const unsigned char *`|The input byte buffer for which the CRC must be calculated| |**`num_bytes`**|`size_t`|The number of characters in the input buffer| -### Returns +### Return Value | Type | Description | | :--- | :--- | diff --git a/doc/update_crc_16.md b/doc/update_crc_16.md index 8dbeae9..9cd68d2 100644 --- a/doc/update_crc_16.md +++ b/doc/update_crc_16.md @@ -9,7 +9,7 @@ |**`crc`**|`uint16_t`|The CRC value calculated from the byte stream upto but not including the current byte| |**`c`**|`unsigned char`|The next byte from the byte stream to be used in the CRC calculation| -### Returns +### Return Value | Type | Description | | :--- | :--- | diff --git a/doc/update_crc_32.md b/doc/update_crc_32.md index c7fcc27..910f182 100644 --- a/doc/update_crc_32.md +++ b/doc/update_crc_32.md @@ -9,7 +9,7 @@ |**`crc`**|`uint32_t`|The CRC value calculated from the byte stream upto but not including the current byte| |**`c`**|`unsigned char`|The next byte from the byte stream to be used in the CRC calculation| -### Returns +### Return Value | Type | Description | | :--- | :--- | diff --git a/doc/update_crc_8.md b/doc/update_crc_8.md index 1215099..fa02e5d 100644 --- a/doc/update_crc_8.md +++ b/doc/update_crc_8.md @@ -9,7 +9,7 @@ |**`crc`**|`uint8_t`|The CRC value calculated from the byte stream upto but not including the current byte| |**`c`**|`unsigned char`|The next byte from the byte stream to be used in the CRC calculation| -### Returns +### Return Value | Type | Description | | :--- | :--- | diff --git a/doc/update_crc_ccitt.md b/doc/update_crc_ccitt.md index 2cc2f78..5077a5b 100644 --- a/doc/update_crc_ccitt.md +++ b/doc/update_crc_ccitt.md @@ -9,7 +9,7 @@ |**`crc`**|`uint16_t`|The CRC value calculated from the byte stream upto but not including the current byte| |**`c`**|`unsigned char`|The next byte from the byte stream to be used in the CRC calculation| -### Returns +### Return Value | Type | Description | | :--- | :--- | @@ -17,8 +17,6 @@ ### Description -### See Also - The function `update_crc_ccitt()` can be used to calculate the CRC value in a stream of bytes where it is not possible to first buffer the stream completely to calculate the CRC when all data is received. The parameters are the previous CRC value and the current byte which must be used diff --git a/doc/update_crc_dnp.md b/doc/update_crc_dnp.md index 54eebc0..f8d7b5c 100644 --- a/doc/update_crc_dnp.md +++ b/doc/update_crc_dnp.md @@ -9,7 +9,7 @@ |**`crc`**|`uint16_t`|The CRC value calculated from the byte stream upto but not including the current byte| |**`c`**|`unsigned char`|The next byte from the byte stream to be used in the CRC calculation| -### Returns +### Return Value | Type | Description | | :--- | :--- | diff --git a/doc/update_crc_kermit.md b/doc/update_crc_kermit.md index 6526f35..af3583c 100644 --- a/doc/update_crc_kermit.md +++ b/doc/update_crc_kermit.md @@ -9,7 +9,7 @@ |**`crc`**|`uint16_t`|The CRC value calculated from the byte stream upto but not including the current byte| |**`c`**|`unsigned char`|The next byte from the byte stream to be used in the CRC calculation| -### Returns +### Return Value | Type | Description | | :--- | :--- | diff --git a/doc/update_crc_sick.md b/doc/update_crc_sick.md index 0541ede..a3f7b45 100644 --- a/doc/update_crc_sick.md +++ b/doc/update_crc_sick.md @@ -10,7 +10,7 @@ |**`c`**|`unsigned char`|The next byte from the byte stream to be used in the CRC calculation| |**`prev_byte`**|`unsigned char`|The previous byte from the byte stream| -### Returns +### Return Value | Type | Description | | :--- | :--- |