LinCAN driver major structured comments and documentation update

[lincan.git] / lincan / include / can.h

diff --git a/lincan/include/can.h b/lincan/include/can.h
index e31073283e3a5abf4a3f1a4716b4a2c3582e8b10..344dcf67ed767ae136db5175fd897cf134c16c10 100644 (file)
--- a/lincan/include/can.h
+++ b/lincan/include/can.h
@@ -10,6 +10,19 @@
 
 #define CAN_MSG_LENGTH 8
 
+/**
+ * struct canmsg_t - structure representing CAN message
+ * @flags:  message flags, %MSG_RTR .. message is Remote Transmission Request,
+ *     %MSG_EXT .. message with extended ID, %MSG_OVR indication of queue
+ *     overflow condition
+ * @cob:    communication object number (not used)
+ * @id:     ID of CAN message
+ * @timestamp: not used
+ * @length: length of used data
+ * @data:   data bytes buffer
+ *
+ * Header: can.h
+ */
 struct canmsg_t {
        short           flags;
        int             cob;