Merge pull request #475 from simonduq/fix/tsch-doxygen-files

TSCH: added file descriptions in .h files
2018-04-28 21:24:19 +01:00 · 2018-04-28 21:24:19 +01:00 · 3ff776d501
commit 3ff776d501
parent b81f19bec0 34ca2c06c1
13 changed files with 27 additions and 22 deletions
--- a/os/net/mac/tsch/tsch-adaptive-timesync.h
+++ b/os/net/mac/tsch/tsch-adaptive-timesync.h
@ -33,6 +33,8 @@
 /**
 * \addtogroup tsch
 * @{
+ * \file
+ *	TSCH adaptive time synchronization
 */

 #ifndef __TSCH_ADAPTIVE_TIMESYNC_H__
--- a/os/net/mac/tsch/tsch-asn.h
+++ b/os/net/mac/tsch/tsch-asn.h
@ -31,16 +31,12 @@
 */

 /**
+ * \addtogroup tsch
+ * @{
 * \file
 *         TSCH 5-Byte Absolute Slot Number (ASN) management
 * \author
 *         Simon Duquennoy <simonduq@sics.se>
- *
- */
-
-/**
- * \addtogroup tsch
- * @{
 */

 #ifndef __TSCH_ASN_H__
--- a/os/net/mac/tsch/tsch-conf.h
+++ b/os/net/mac/tsch/tsch-conf.h
@ -31,17 +31,14 @@
 */

 /**
+* \addtogroup tsch
+* @{
 * \file
 *         TSCH configuration
 * \author
 *         Simon Duquennoy <simonduq@sics.se>
 */

-/**
- * \addtogroup tsch
- * @{
-*/
-
 #ifndef __TSCH_CONF_H__
 #define __TSCH_CONF_H__

--- a/os/net/mac/tsch/tsch-const.h
+++ b/os/net/mac/tsch/tsch-const.h
@ -31,17 +31,14 @@
 */

 /**
+* \addtogroup tsch
+* @{
 * \file
- *         TSCH configuration
+ *         TSCH constants
 * \author
 *         Simon Duquennoy <simonduq@sics.se>
 */

-/**
- * \addtogroup tsch
- * @{
-*/
-
 #ifndef __TSCH_CONST_H__
 #define __TSCH_CONST_H__

--- a/os/net/mac/tsch/tsch-log.h
+++ b/os/net/mac/tsch/tsch-log.h
@ -33,6 +33,8 @@
 /**
 * \addtogroup tsch
 * @{
+ * \file
+ *	TSCH per-slot logging
 */

 #ifndef __TSCH_LOG_H__
--- a/os/net/mac/tsch/tsch-packet.h
+++ b/os/net/mac/tsch/tsch-packet.h
@ -33,6 +33,8 @@
 /**
 * \addtogroup tsch
 * @{
+ * \file
+ *	TSCH packet parsing and creation. EBs and EACKs.
 */

 #ifndef __TSCH_PACKET_H__
--- a/os/net/mac/tsch/tsch-queue.h
+++ b/os/net/mac/tsch/tsch-queue.h
@ -33,6 +33,8 @@
 /**
 * \addtogroup tsch
 * @{
+ * \file
+ *	TSCH queues
 */

 #ifndef __TSCH_QUEUE_H__
--- a/os/net/mac/tsch/tsch-rpl.h
+++ b/os/net/mac/tsch/tsch-rpl.h
@ -31,6 +31,8 @@
 /**
 * \addtogroup tsch
 * @{
+ * \file
+ *	TSCH-RPL interaction
 */

 #ifndef __TSCH_RPL_H__
--- a/os/net/mac/tsch/tsch-schedule.h
+++ b/os/net/mac/tsch/tsch-schedule.h
@ -33,6 +33,8 @@
 /**
 * \addtogroup tsch
 * @{
+ * \file
+ *	TSCH scheduling engine
 */

 #ifndef __TSCH_SCHEDULE_H__
--- a/os/net/mac/tsch/tsch-security.h
+++ b/os/net/mac/tsch/tsch-security.h
@ -33,6 +33,8 @@
 /**
 * \addtogroup tsch
 * @{
+ * \file
+ *	TSCH security
 */

 #ifndef __TSCH_SECURITY_H__
--- a/os/net/mac/tsch/tsch-slot-operation.h
+++ b/os/net/mac/tsch/tsch-slot-operation.h
@ -33,6 +33,8 @@
 /**
 * \addtogroup tsch
 * @{
+ * \file
+ *	TSCH runtime operation within timeslots
 */

 #ifndef __TSCH_SLOT_OPERATION_H__
--- a/os/net/mac/tsch/tsch-types.h
+++ b/os/net/mac/tsch/tsch-types.h
@ -31,17 +31,14 @@
 */

 /**
+* \addtogroup tsch
+* @{
 * \file
 *         TSCH types
 * \author
 *         Simon Duquennoy <simonduq@sics.se>
 */

-/**
- * \addtogroup tsch
- * @{
-*/
-
 #ifndef __TSCH_TYPES_H__
 #define __TSCH_TYPES_H__

--- a/os/net/mac/tsch/tsch.h
+++ b/os/net/mac/tsch/tsch.h
@ -37,6 +37,8 @@ The IEEE 802.15.4-2015 TimeSlotted Channel Hopping (TSCH) protocol. Provides
 scheduled communication on top of a globally-synchronized network. Performs
 frequency hopping for enhanced reliability.
 * @{
+* \file
+*	Main API declarations for TSCH.
 */

 #ifndef __TSCH_H__