[rtems commit] Miscellaneous Doxygen clean-up
Jennifer Averett
jennifer at rtems.org
Fri Dec 28 15:46:15 UTC 2012
Module: rtems
Branch: master
Commit: b8fc260ff3b9008d260febeadd092f31fd37c10a
Changeset: http://git.rtems.org/rtems/commit/?id=b8fc260ff3b9008d260febeadd092f31fd37c10a
Author: Joel Sherrill <joel.sherrill at oarcorp.com>
Date: Fri Dec 28 09:48:37 2012 -0600
Miscellaneous Doxygen clean-up
---
cpukit/libcsupport/include/rtems/assoc.h | 2 +-
cpukit/libmisc/mouse/mouse_parser.h | 2 ++
cpukit/posix/include/rtems/posix/semaphore.h | 2 ++
cpukit/rtems/include/rtems/rtems/barrier.h | 3 ++-
cpukit/rtems/include/rtems/rtems/options.h | 6 +++++-
cpukit/score/cpu/sparc/rtems/score/cpu.h | 2 ++
6 files changed, 14 insertions(+), 3 deletions(-)
diff --git a/cpukit/libcsupport/include/rtems/assoc.h b/cpukit/libcsupport/include/rtems/assoc.h
index 06a7484..0ed3ded 100644
--- a/cpukit/libcsupport/include/rtems/assoc.h
+++ b/cpukit/libcsupport/include/rtems/assoc.h
@@ -10,7 +10,7 @@
#define _RTEMS_RTEMS_ASSOC_H
/**
- * @defgroup Associativity Routines
+ * @defgroup Associativity Associativity Routines
*/
/**@{*/
diff --git a/cpukit/libmisc/mouse/mouse_parser.h b/cpukit/libmisc/mouse/mouse_parser.h
index 8b42c44..2e02e1f 100644
--- a/cpukit/libmisc/mouse/mouse_parser.h
+++ b/cpukit/libmisc/mouse/mouse_parser.h
@@ -114,4 +114,6 @@ void mouse_parser_enqueue(
}
#endif
+/**@}*/
+
#endif
diff --git a/cpukit/posix/include/rtems/posix/semaphore.h b/cpukit/posix/include/rtems/posix/semaphore.h
index 08ace76..6390f22 100644
--- a/cpukit/posix/include/rtems/posix/semaphore.h
+++ b/cpukit/posix/include/rtems/posix/semaphore.h
@@ -189,5 +189,7 @@ int _POSIX_Semaphore_Translate_core_semaphore_return_code(
}
#endif
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/rtems/include/rtems/rtems/barrier.h b/cpukit/rtems/include/rtems/rtems/barrier.h
index b7e7483..a7508b4 100644
--- a/cpukit/rtems/include/rtems/rtems/barrier.h
+++ b/cpukit/rtems/include/rtems/rtems/barrier.h
@@ -31,7 +31,8 @@
*
* @ingroup ClassicRTEMS
*
- * This encapsulates functionality which XXX
+ * This encapsulates functionality which implements the Classic API
+ * Barrier Manager.
*/
/**@{*/
diff --git a/cpukit/rtems/include/rtems/rtems/options.h b/cpukit/rtems/include/rtems/rtems/options.h
index 6b30cc3..c42af1c 100644
--- a/cpukit/rtems/include/rtems/rtems/options.h
+++ b/cpukit/rtems/include/rtems/rtems/options.h
@@ -25,7 +25,11 @@ extern "C" {
/**
* @defgroup ClassicOptions Classic API Options
*
- * This encapsulates functionality which XXX
+ * @ingroup ClassicRTEMS
+ *
+ * This encapsulates functionality related to the options argument
+ * to Classic API blocking operations. The primary option is whether
+ * or not a task is willing to wait for the operation to complete.
*/
/**@{*/
diff --git a/cpukit/score/cpu/sparc/rtems/score/cpu.h b/cpukit/score/cpu/sparc/rtems/score/cpu.h
index 6e88b9e..686d0e2 100644
--- a/cpukit/score/cpu/sparc/rtems/score/cpu.h
+++ b/cpukit/score/cpu/sparc/rtems/score/cpu.h
@@ -354,6 +354,8 @@ typedef struct {
/**
* @defgroup Contexts SPARC Context Structures
*
+ * @ingroup Score
+ *
* Generally there are 2 types of context to save.
* + Interrupt registers to save
* + Task level registers to save
More information about the vc
mailing list