[rtems commit] posix: Add files to Doxygen group

Sebastian Huber sebh at rtems.org
Wed Jul 26 04:56:35 UTC 2023


Module:    rtems
Branch:    master
Commit:    d3fe128d67d19fd5bdf77e3d20cb89f0fc9d9b3c
Changeset: http://git.rtems.org/rtems/commit/?id=d3fe128d67d19fd5bdf77e3d20cb89f0fc9d9b3c

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Tue Jul 25 10:30:56 2023 +0200

posix: Add files to Doxygen group

Canonicalize brief descriptions.

Update #3707.

---

 cpukit/include/rtems/posix/posixapi.h     | 6 +++---
 cpukit/include/rtems/posix/spinlockimpl.h | 8 ++++----
 2 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/cpukit/include/rtems/posix/posixapi.h b/cpukit/include/rtems/posix/posixapi.h
index 24c1dc51e0..5d78573ef7 100644
--- a/cpukit/include/rtems/posix/posixapi.h
+++ b/cpukit/include/rtems/posix/posixapi.h
@@ -3,10 +3,10 @@
 /**
  * @file
  *
- * @brief POSIX API Implementation
+ * @ingroup POSIXAPI
  *
- * This include file defines the top level interface to the POSIX API
- * implementation in RTEMS.
+ * @brief This header file provides interfaces used by the POSIX API
+ *   implementation.
  */
 
 /*
diff --git a/cpukit/include/rtems/posix/spinlockimpl.h b/cpukit/include/rtems/posix/spinlockimpl.h
index 855e57cc14..10424f1961 100644
--- a/cpukit/include/rtems/posix/spinlockimpl.h
+++ b/cpukit/include/rtems/posix/spinlockimpl.h
@@ -2,11 +2,11 @@
 
 /**
  * @file
- * 
- * @brief Inlined Routines from the POSIX Spinlock Manager
  *
- * This file contains the static inlin implementation of the inlined
- * routines from the POSIX Spinlock Manager.
+ * @ingroup POSIXAPI
+ *
+ * @brief This header file provides interfaces used by the POSIX Spinlock
+ *   implementation.
  */
 
 /*



More information about the vc mailing list