[dox] doxygen headers for abi

paparazzi · Aug 28, 2013 · e867282 · e867282
1 parent 081188d
commit e867282
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 5 deletions.
diff --git a/sw/airborne/subsystems/abi.h b/sw/airborne/subsystems/abi.h
@@ -19,11 +19,16 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * @file subsystems/abi.h
+ *
+ * Main include for ABI (AirBorneInterface).
+ * @todo explain how to use ABI
+ */
+
 #ifndef ABI_H
 #define ABI_H
 
-/* TODO Explain how to use ABI */
-
 #include "abi_messages.h"
 
 #endif /* ABI_H */
diff --git a/sw/airborne/subsystems/abi_common.h b/sw/airborne/subsystems/abi_common.h
@@ -19,7 +19,11 @@
  * Boston, MA 02111-1307, USA.
  */
 
-/* Common tools for ABI middelware */
+/**
+ * @file subsystems/abi_common.h
+ *
+ * Common tools for ABI middelware.
+ */
 
 #ifndef ABI_COMMON_H
 #define ABI_COMMON_H
@@ -44,8 +48,8 @@
 typedef void (*abi_callback)(void);
 
 /** Broadcast address.
- * When passing broadcast address has a sender id,
- * messages from all sender are received
+ * When passing broadcast address as a sender id,
+ * messages from all senders are received
  */
 #define ABI_BROADCAST 0