[PATCH 04/20] rtems: Canonicalize partition file documentation

[Sebastian Huber]

---
 cpukit/include/rtems/rtems/partdata.h |  3 ++-
 cpukit/include/rtems/rtems/partimpl.h |  3 ++-
 cpukit/rtems/src/part.c               |  5 +++--
 cpukit/rtems/src/partcreate.c         |  5 +++--
 cpukit/rtems/src/partdelete.c         |  8 +++++---
 cpukit/rtems/src/partgetbuffer.c      |  8 +++++---
 cpukit/rtems/src/partident.c          |  5 +++--
 cpukit/rtems/src/partmp.c             |  5 +++--
 cpukit/rtems/src/partreturnbuffer.c   | 10 ++++++++--
 9 files changed, 34 insertions(+), 18 deletions(-)

diff --git a/cpukit/include/rtems/rtems/partdata.h b/cpukit/include/rtems/rtems/partdata.h
index 3be94b6cd1..d012367b2b 100644
--- a/cpukit/include/rtems/rtems/partdata.h
+++ b/cpukit/include/rtems/rtems/partdata.h
@@ -3,7 +3,8 @@
  *
  * @ingroup ClassicPartImpl
  *
- * @brief Classic Partition Manager Data Structures
+ * @brief This header file provides the API used by the Application
+ *   Configuration to define the Partition Manager information.
  */
 
 /* COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/include/rtems/rtems/partimpl.h b/cpukit/include/rtems/rtems/partimpl.h
index b2bbd90f76..5006f5cdc1 100644
--- a/cpukit/include/rtems/rtems/partimpl.h
+++ b/cpukit/include/rtems/rtems/partimpl.h
@@ -3,7 +3,8 @@
  *
  * @ingroup ClassicPartImpl
  *
- * @brief Classic Partition Manager Implementation
+ * @brief This header file provides interfaces used by the Partition Manager
+ *   implementation.
  */
 
 /*  COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/rtems/src/part.c b/cpukit/rtems/src/part.c
index 34713682f3..0d7e352b60 100644
--- a/cpukit/rtems/src/part.c
+++ b/cpukit/rtems/src/part.c
@@ -1,9 +1,10 @@
 /**
  * @file
  *
- * @ingroup ClassicPart
+ * @ingroup ClassicPartImpl
  *
- * @brief Classic Partition Information with Zero Objects
+ * @brief This source file contains a definition of ::_Partition_Information
+ *   with zero objects.
  */
 
 /*
diff --git a/cpukit/rtems/src/partcreate.c b/cpukit/rtems/src/partcreate.c
index 3ccf868a64..9d4c7df283 100644
--- a/cpukit/rtems/src/partcreate.c
+++ b/cpukit/rtems/src/partcreate.c
@@ -1,9 +1,10 @@
 /**
  * @file
  *
- * @ingroup ClassicPart Partitions
+ * @ingroup ClassicPartImpl
  *
- * @brief RTEMS Partition Create
+ * @brief This source file contains the implementation of
+ *   rtems_partition_create().
  */
 
 /*
diff --git a/cpukit/rtems/src/partdelete.c b/cpukit/rtems/src/partdelete.c
index cec94880f0..12f6bd6025 100644
--- a/cpukit/rtems/src/partdelete.c
+++ b/cpukit/rtems/src/partdelete.c
@@ -1,8 +1,10 @@
 /**
- *  @file
+ * @file
  *
- *  @brief RTEMS Delete Partition
- *  @ingroup ClassicPart
+ * @ingroup ClassicPartImpl
+ *
+ * @brief This source file contains the implementation of
+ *   rtems_partition_delete().
  */
 
 /*
diff --git a/cpukit/rtems/src/partgetbuffer.c b/cpukit/rtems/src/partgetbuffer.c
index 8e5350acb1..c92664ef61 100644
--- a/cpukit/rtems/src/partgetbuffer.c
+++ b/cpukit/rtems/src/partgetbuffer.c
@@ -1,8 +1,10 @@
 /**
- *  @file
+ * @file
  *
- *  @brief RTEMS Get Partition Buffer
- *  @ingroup ClassicPart
+ * @ingroup ClassicPartImpl
+ *
+ * @brief This source file contains the implementation of
+ *   rtems_partition_get_buffer().
  */
 
 /*
diff --git a/cpukit/rtems/src/partident.c b/cpukit/rtems/src/partident.c
index 5e7140f8d9..fb509fddfd 100644
--- a/cpukit/rtems/src/partident.c
+++ b/cpukit/rtems/src/partident.c
@@ -3,9 +3,10 @@
 /**
  * @file
  *
- * @ingroup ClassicPartitionImpl
+ * @ingroup ClassicPartImpl
  *
- * @brief rtems_partition_ident() Implementation
+ * @brief This source file contains the implementation of
+ *   rtems_partition_ident().
  */
 
 /*
diff --git a/cpukit/rtems/src/partmp.c b/cpukit/rtems/src/partmp.c
index 99af7adf71..f97c3373c8 100644
--- a/cpukit/rtems/src/partmp.c
+++ b/cpukit/rtems/src/partmp.c
@@ -1,9 +1,10 @@
 /**
  * @file
  *
- * @ingroup ClassicPartMP Partition MP Support
+ * @ingroup ClassicPartMP
  *
- * @brief Partition_MP_Send_process_packet
+ * @brief This source file contains the implementation of the Partition Manager
+ *   MPCI support.
  */
 
 /*
diff --git a/cpukit/rtems/src/partreturnbuffer.c b/cpukit/rtems/src/partreturnbuffer.c
index 6d762c4197..73d5438225 100644
--- a/cpukit/rtems/src/partreturnbuffer.c
+++ b/cpukit/rtems/src/partreturnbuffer.c
@@ -1,7 +1,13 @@
-/*
- *  Partition Manager
+/**
+ * @file
  *
+ * @ingroup ClassicPartImpl
  *
+ * @brief This source file contains the implementation of
+ *   rtems_partition_return_buffer().
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2014.
  *  On-Line Applications Research Corporation (OAR).
  *
-- 
2.26.2