Merge pull request #5372 from SenRamakri/sen_PlatformDoxygenUpdates

Doxygen comments fixes

Author: 0xc0170

doxyfile_options

@@ -32,7 +32,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "My Project"
+PROJECT_NAME           = "Mbed OS Reference"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version

doxygen_options.json

@@ -1,4 +1,5 @@
 {
+    "PROJECT_NAME": "Mbed OS Reference",
     "ENABLE_PREPROCESSING": "YES",
     "MACRO_EXPANSION": "YES",
     "EXPAND_ONLY_PREDEF": "NO",

drivers/UARTSerial.h

@@ -39,6 +39,13 @@
 
 namespace mbed {
 
+/** \addtogroup drivers */
+
+/** Class providing buffered UART communication functionality using separate circular buffer for send and receive channels
+ *  
+ * @ingroup drivers
+ */
+
 class UARTSerial : private SerialBase, public FileHandle, private NonCopyable<UARTSerial> {
 
 public:

platform/ATCmdParser.h

@@ -24,6 +24,15 @@
 #include <cstdarg>
 #include "Callback.h"
 
+namespace mbed {
+
+/** \addtogroup platform */
+/** @{*/
+/**
+ * \defgroup platform_ATCmdParser ATCmdParser class
+ * @{
+ */
+
 /**
  * Parser class for parsing AT commands
  *
@@ -43,8 +52,6 @@
  * @endcode
  */
 
-namespace mbed {
-
 class ATCmdParser : private NonCopyable<ATCmdParser>
 {
 private:
@@ -299,6 +306,11 @@ class ATCmdParser : private NonCopyable<ATCmdParser>
     */
     bool process_oob(void);
 };
+
+/**@}*/
+
+/**@}*/
+
 } //namespace mbed
 
 #endif //MBED_ATCMDPARSER_H

platform/CThunk.h

@@ -1,6 +1,10 @@
 
 /** \addtogroup platform */
 /** @{*/
+/**
+ * \defgroup platform_CThunk CThunk class
+ * @{
+ */
 /* General C++ Object Thunking class
  *
  * - allows direct callbacks to non-static C++ class functions
@@ -73,13 +77,11 @@
 
 /* IRQ/Exception compatible thunk entry function */
 typedef void (*CThunkEntry)(void);
-/** @}*/
 
 /**
  * Class for created a pointer with data bound to it
  *
  * @note Synchronization level: Not protected
- * @ingroup platform
  */
 template<class T>
 class CThunk
@@ -243,5 +245,9 @@ class CThunk
         }
 };
 
+/**@}*/
+
+/**@}*/
+
 #endif/*__CTHUNK_H__*/
 

platform/CallChain.h

@@ -22,7 +22,17 @@
 #include <string.h>
 
 namespace mbed {
+
+
+typedef Callback<void()> *pFunctionPointer_t;
+class CallChainLink;
+
 /** \addtogroup platform */
+/** @{*/
+/**
+ * \defgroup platform_CallChain CallChain class
+ * @{
+ */
 
 /** Group one or more functions in an instance of a CallChain, then call them in
  * sequence using CallChain::call(). Used mostly by the interrupt chaining code,
@@ -60,12 +70,7 @@ namespace mbed {
  *     chain.call();
  * }
  * @endcode
- * @ingroup platform
  */
-
-typedef Callback<void()> *pFunctionPointer_t;
-class CallChainLink;
-
 class CallChain : private NonCopyable<CallChain> {
 public:
     /** Create an empty chain
@@ -209,6 +214,10 @@ class CallChain : private NonCopyable<CallChain> {
     CallChainLink *_chain;
 };
 
+/**@}*/
+
+/**@}*/
+
 } // namespace mbed
 
 #endif

platform/Callback.h

@@ -24,12 +24,15 @@
 
 namespace mbed {
 /** \addtogroup platform */
-
+/** @{*/
+/**
+ * \defgroup platform_Callback Callback class
+ * @{
+ */
 
 /** Callback class based on template specialization
  *
  * @note Synchronization level: Not protected
- * @ingroup platform
  */
 template <typename F>
 class Callback;
@@ -67,7 +70,6 @@ namespace detail {
 /** Callback class based on template specialization
  *
  * @note Synchronization level: Not protected
- * @ingroup platform
  */
 template <typename R>
 class Callback<R()> {
@@ -642,7 +644,6 @@ class Callback<R()> {
 /** Callback class based on template specialization
  *
  * @note Synchronization level: Not protected
- * @ingroup platform
  */
 template <typename R, typename A0>
 class Callback<R(A0)> {
@@ -1218,7 +1219,6 @@ class Callback<R(A0)> {
 /** Callback class based on template specialization
  *
  * @note Synchronization level: Not protected
- * @ingroup platform
  */
 template <typename R, typename A0, typename A1>
 class Callback<R(A0, A1)> {
@@ -1795,7 +1795,6 @@ class Callback<R(A0, A1)> {
 /** Callback class based on template specialization
  *
  * @note Synchronization level: Not protected
- * @ingroup platform
  */
 template <typename R, typename A0, typename A1, typename A2>
 class Callback<R(A0, A1, A2)> {
@@ -2373,7 +2372,6 @@ class Callback<R(A0, A1, A2)> {
 /** Callback class based on template specialization
  *
  * @note Synchronization level: Not protected
- * @ingroup platform
  */
 template <typename R, typename A0, typename A1, typename A2, typename A3>
 class Callback<R(A0, A1, A2, A3)> {
@@ -2952,7 +2950,6 @@ class Callback<R(A0, A1, A2, A3)> {
 /** Callback class based on template specialization
  *
  * @note Synchronization level: Not protected
- * @ingroup platform
  */
 template <typename R, typename A0, typename A1, typename A2, typename A3, typename A4>
 class Callback<R(A0, A1, A2, A3, A4)> {
@@ -4546,6 +4543,9 @@ Callback<R(A0, A1, A2, A3, A4)> callback(const volatile U *obj, R (*func)(const
     return Callback<R(A0, A1, A2, A3, A4)>(func, obj);
 }
 
+/**@}*/
+
+/**@}*/
 
 } // namespace mbed
 

platform/CircularBuffer.h

@@ -20,11 +20,15 @@
 
 namespace mbed {
 /** \addtogroup platform */
+/** @{*/
+/**
+ * \defgroup platform_CircularBuffer CircularBuffer functions
+ * @{
+ */
 
 /** Templated Circular buffer class
  *
  *  @note Synchronization level: Interrupt safe
- *  @ingroup platform
  */
 template<typename T, uint32_t BufferSize, typename CounterType = uint32_t>
 class CircularBuffer {
@@ -112,6 +116,10 @@ class CircularBuffer {
     volatile bool _full;
 };
 
+/**@}*/
+
+/**@}*/
+
 }
 
 #endif

platform/CriticalSectionLock.h

@@ -22,6 +22,13 @@
 
 namespace mbed {
 
+/** \addtogroup platform */
+/** @{*/
+/**
+ * \defgroup platform_CriticalSectionLock CriticalSectionLock functions
+ * @{
+ */
+
 /** RAII object for disabling, then restoring, interrupt state
   * Usage:
   * @code
@@ -65,6 +72,9 @@ class CriticalSectionLock {
     }
 };
 
+/**@}*/
+
+/**@}*/
 
 } // namespace mbed
 

platform/DeepSleepLock.h

@@ -22,6 +22,12 @@
 
 namespace mbed {
 
+/** \addtogroup platform */
+/** @{*/
+/**
+ * \defgroup platform_DeepSleepLock DeepSleepLock functions
+ * @{
+ */
 
 /** RAII object for disabling, then restoring the deep sleep mode
   * Usage:
@@ -82,6 +88,11 @@ class DeepSleepLock {
     }
 };
 
+/**@}*/
+
+/**@}*/
+
+
 }
 
 #endif