shared vmeUniverse: Improve Doxygen

6 files changed, 77 insertions, 6 deletions

diff --git a/c/src/lib/libbsp/shared/include/coverhd.h b/c/src/lib/libbsp/shared/include/coverhd.h
index 67fc5305f3..833bad2530 100644
--- a/c/src/lib/libbsp/shared/include/coverhd.h
+++ b/c/src/lib/libbsp/shared/include/coverhd.h
@@ -1,7 +1,13 @@
-/* coverhd.h
+/**
+ *  @file
+ *
+ *  @ingroup shared_coverhd
  *
- *  This include file has defines to represent the overhead associated
+ *  @brief This include file has defines to represent the overhead associated
  *  with calling a particular directive from C on this target.
+ */
+
+/* coverhd.h
  *
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/c/src/lib/libbsp/shared/include/default-initial-extension.h b/c/src/lib/libbsp/shared/include/default-initial-extension.h
index 44938c8de3..c5655cfeda 100644
--- a/c/src/lib/libbsp/shared/include/default-initial-extension.h
+++ b/c/src/lib/libbsp/shared/include/default-initial-extension.h
@@ -1,3 +1,11 @@
+/**
+ *  @file
+ *
+ *  @ingroup shared_defaultinitialextension
+ *
+ *  @brief DEFAULT_INITIAL_EXTENSION Support
+ */
+
 /*
  * Copyright (c) 2012 embedded brains GmbH.  All rights reserved.
  *
@@ -21,6 +29,14 @@
 extern "C" {
 #endif /* __cplusplus */
 
+/**
+ *  @defgroup shared_defaultinitialextension DEFAULT_INITIAL_EXTENSION Support
+ *
+ *  @ingroup shared_include
+ *
+ *  @brief DEFAULT_INITIAL_EXTENSION Support Package
+ */
+
 void bsp_fatal_extension(
   rtems_fatal_source source,
   bool is_internal,
diff --git a/c/src/lib/libbsp/shared/include/doxygen.h b/c/src/lib/libbsp/shared/include/doxygen.h
new file mode 100644
index 0000000000..3069a1fe6a
--- /dev/null
+++ b/c/src/lib/libbsp/shared/include/doxygen.h
@@ -0,0 +1,7 @@
+/**
+ *  @defgroup shared_include SHARED INCLUDE Modules
+ *
+ *  @ingroup bsp_shared
+ *
+ *  @brief SHARED INCLUDE Modules
+ */
\ No newline at end of file
diff --git a/c/src/lib/libbsp/shared/include/mm.h b/c/src/lib/libbsp/shared/include/mm.h
index 1a1eb7ffa2..3d904cba2a 100644
--- a/c/src/lib/libbsp/shared/include/mm.h
+++ b/c/src/lib/libbsp/shared/include/mm.h
@@ -1,3 +1,11 @@
+/**
+ *  @file
+ *
+ *  @ingroup shared_mm
+ *
+ *  @brief MM Support
+ */
+
 /*
  * Copyright (c) 2013 Hesham AL-Matary.
  * Copyright (c) 2013 Gedare Bloom.
@@ -17,6 +25,14 @@
 extern "C" {
 #endif
 
+/**
+ *  @defgroup shared_mm MM Support
+ *
+ *  @ingroup shared_include
+ *
+ *  @brief MM Support Package
+ */
+
 void bsp_memory_management_initialize(void);
 
 #ifdef __cplusplus
diff --git a/c/src/lib/libbsp/shared/include/tm27.h b/c/src/lib/libbsp/shared/include/tm27.h
index b01c2beb0f..d1106757d3 100644
--- a/c/src/lib/libbsp/shared/include/tm27.h
+++ b/c/src/lib/libbsp/shared/include/tm27.h
@@ -1,6 +1,12 @@
-/*
- *  Empty stub for tm27.h
+/**
+ *  @file
+ *
+ *  @ingroup shared_tm27
  *
+ *  @brief Empty stub for tm27.h
+ */
+
+/*
  *  The license and distribution terms for this file may be
  *  found in the file LICENSE in this distribution or at
  *  http://www.rtems.com/license/LICENSE.
@@ -13,8 +19,12 @@
 #ifndef __tm27_h
 #define __tm27_h
 
-/*
- *  Stuff for Time Test 27
+/**
+ *  @defgroup shared_tm27 Time Test 27
+ *
+ *  @ingroup shared_include
+ *
+ *  @brief Stuff for Time Test 27
  */
 
 #define MUST_WAIT_FOR_INTERRUPT 0
diff --git a/c/src/lib/libbsp/shared/include/u-boot.h b/c/src/lib/libbsp/shared/include/u-boot.h
index b2427dcfc1..68df5babe4 100644
--- a/c/src/lib/libbsp/shared/include/u-boot.h
+++ b/c/src/lib/libbsp/shared/include/u-boot.h
@@ -1,3 +1,11 @@
+/**
+ *  @file
+ *
+ *  @ingroup shared_uboot
+ *
+ *  @brief U_BOOT Support
+ */
+
 /*
  * Copyright (c) 2010 embedded brains GmbH.  All rights reserved.
  *
@@ -27,6 +35,14 @@ extern "C" {
 
 extern bd_t bsp_uboot_board_info;
 
+/**
+ *  @defgroup shared_uboot U_BOOT Support
+ *
+ *  @ingroup shared_include
+ *
+ *  @brief U_BOOT Support Package
+ */
+
 void bsp_uboot_copy_board_info(const bd_t *src);
 
 #ifdef __cplusplus