Skip to content

Commit

Permalink
Fixed layout API documents
Browse files Browse the repository at this point in the history
  • Loading branch information
@lammertb
lammertb committed Nov 27, 2016
1 parent e3d7758 commit 32aacc5
Show file tree
Hide file tree
Showing 18 changed files with 24 additions and 20 deletions.
4 changes: 3 additions & 1 deletion doc/checksum_NMEA.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| :--- | :--- |
Expand Down
4 changes: 3 additions & 1 deletion doc/crc_16.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| :--- | :--- |
Expand Down
2 changes: 1 addition & 1 deletion doc/crc_32.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| :--- | :--- |
Expand Down
4 changes: 3 additions & 1 deletion doc/crc_8.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| :--- | :--- |
Expand Down
2 changes: 1 addition & 1 deletion doc/crc_ccitt_1d0f.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| :--- | :--- |
Expand Down
2 changes: 1 addition & 1 deletion doc/crc_ccitt_ffff.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| :--- | :--- |
Expand Down
2 changes: 1 addition & 1 deletion doc/crc_dnp.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| :--- | :--- |
Expand Down
2 changes: 1 addition & 1 deletion doc/crc_kermit.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| :--- | :--- |
Expand Down
2 changes: 1 addition & 1 deletion doc/crc_modbus.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| :--- | :--- |
Expand Down
2 changes: 1 addition & 1 deletion doc/crc_sick.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| :--- | :--- |
Expand Down
2 changes: 1 addition & 1 deletion doc/crc_xmodem.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| :--- | :--- |
Expand Down
2 changes: 1 addition & 1 deletion doc/update_crc_16.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| :--- | :--- |
Expand Down
2 changes: 1 addition & 1 deletion doc/update_crc_32.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| :--- | :--- |
Expand Down
2 changes: 1 addition & 1 deletion doc/update_crc_8.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| :--- | :--- |
Expand Down
4 changes: 1 addition & 3 deletions doc/update_crc_ccitt.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,14 @@
|**`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 |
| :--- | :--- |
|**`uint16_t`**|The new CRC value of the byte stream including the current byte|

### 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
Expand Down
2 changes: 1 addition & 1 deletion doc/update_crc_dnp.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| :--- | :--- |
Expand Down
2 changes: 1 addition & 1 deletion doc/update_crc_kermit.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| :--- | :--- |
Expand Down
2 changes: 1 addition & 1 deletion doc/update_crc_sick.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| :--- | :--- |
Expand Down

0 comments on commit 32aacc5

Please sign in to comment.