Document all functions in header files.

[apps/agl-service-can-low-level.git] / src / isotp / isotp.h

diff --git a/src/isotp/isotp.h b/src/isotp/isotp.h
index 1b52ad3..3a3658c 100644 (file)
--- a/src/isotp/isotp.h
+++ b/src/isotp/isotp.h
@@ -12,22 +12,27 @@
 extern "C" {
 #endif
 
+/* Public: Initialize an IsoTpShims with the given callback functions.
+ *
+ * If any callbacks are not to be used, set them to NULL. For documentation of
+ * the function type signatures, see isotp_types.h. This struct is a handy
+ * encapsulation used to pass the shims around to the various isotp_* functions.
+ *
+ * Returns a struct with the fields initailized to the callbacks.
+ */
 IsoTpShims isotp_init_shims(LogShim log,
         SendCanMessageShim send_can_message,
         SetTimerShim set_timer);
 
-void isotp_message_to_string(const IsoTpMessage* message, char* destination,
-        size_t destination_length);
-
-/* Public: Change the timeout for waiting on an ISO-TP response frame.
- *
- * If this function is not used, the conventional 100ms is used by default.
+/* Public: Render an IsoTpMessage as a string into the given buffer.
  *
- * handler - the ISO-TP handler to modify.
- * timeout - the new timeout in milliseconds.
+ * message - the message to convert to a string, for debug logging.
+ * destination - the target string buffer.
+ * destination_length - the size of the destination buffer, i.e. the max size
+ *      for the rendered string.
  */
-// void isotp_set_timeout(IsoTpHandler* handler, uint16_t timeout_ms);
-
+void isotp_message_to_string(const IsoTpMessage* message, char* destination,
+        size_t destination_length);
 
 #ifdef __cplusplus
 }