cobs[r].c: add documentation to function implementations as well

cobs.c

@@ -25,6 +25,17 @@
  * Functions
  ****************************************************************************/
 
+/* COBS-encode a string of input bytes.
+ *
+ * dst_buf_ptr:    The buffer into which the result will be written
+ * dst_buf_len:    Length of the buffer into which the result will be written
+ * src_ptr:        The byte string to be encoded
+ * src_len         Length of the byte string to be encoded
+ *
+ * returns:        A struct containing the success status of the encoding
+ *                 operation and the length of the result (that was written to
+ *                 dst_buf_ptr)
+ */
 cobs_encode_result cobs_encode(uint8_t *dst_buf_ptr, size_t dst_buf_len, const uint8_t * src_ptr, size_t src_len)
 {
     cobs_encode_result  result              = { 0, COBS_ENCODE_OK };
@@ -111,6 +122,17 @@ cobs_encode_result cobs_encode(uint8_t *dst_buf_ptr, size_t dst_buf_len, const u
 }
 
 
+/* Decode a COBS byte string.
+ *
+ * dst_buf_ptr:    The buffer into which the result will be written
+ * dst_buf_len:    Length of the buffer into which the result will be written
+ * src_ptr:        The byte string to be decoded
+ * src_len         Length of the byte string to be decoded
+ *
+ * returns:        A struct containing the success status of the decoding
+ *                 operation and the length of the result (that was written to
+ *                 dst_buf_ptr)
+ */
 cobs_decode_result cobs_decode(uint8_t *dst_buf_ptr, size_t dst_buf_len, const uint8_t * src_ptr, size_t src_len)
 {
     cobs_decode_result  result              = { 0, COBS_DECODE_OK };

cobsr.c

@@ -25,6 +25,17 @@
  * Functions
  ****************************************************************************/
 
+/* COBS/R-encode a string of input bytes, which may save one byte of output.
+ *
+ * dst_buf_ptr:    The buffer into which the result will be written
+ * dst_buf_len:    Length of the buffer into which the result will be written
+ * src_ptr:        The byte string to be encoded
+ * src_len         Length of the byte string to be encoded
+ *
+ * returns:        A struct containing the success status of the encoding
+ *                 operation and the length of the result (that was written to
+ *                 dst_buf_ptr)
+ */
 cobsr_encode_result cobsr_encode(uint8_t *dst_buf_ptr, size_t dst_buf_len, const uint8_t * src_ptr, size_t src_len)
 {
     cobsr_encode_result result              = { 0, COBSR_ENCODE_OK };
@@ -127,6 +138,17 @@ cobsr_encode_result cobsr_encode(uint8_t *dst_buf_ptr, size_t dst_buf_len, const
 }
 
 
+/* Decode a COBS/R byte string.
+ *
+ * dst_buf_ptr:    The buffer into which the result will be written
+ * dst_buf_len:    Length of the buffer into which the result will be written
+ * src_ptr:        The byte string to be decoded
+ * src_len         Length of the byte string to be decoded
+ *
+ * returns:        A struct containing the success status of the decoding
+ *                 operation and the length of the result (that was written to
+ *                 dst_buf_ptr)
+ */
 cobsr_decode_result cobsr_decode(uint8_t *dst_buf_ptr, size_t dst_buf_len, const uint8_t * src_ptr, size_t src_len)
 {
     cobsr_decode_result result              = { 0, COBSR_DECODE_OK };