Divided public and private/internal modules

Public modules can be declared as normal. Internal modules should have @ingroup internals after the group definition.
2015-12-11 00:40:03 +01:00
parent a69f2889bf
commit 941503b24f
10 changed files with 17 additions and 0 deletions
@@ -5,3 +5,6 @@

 Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
 */
+/**
+@defgroup internals MySensors internal APIs and functionalities
+*/
@@ -21,6 +21,11 @@
 * @file MyMessage.h
 *
 * @brief API and type declarations for MySensors messages
+ * @defgroup MyMessagegrp MyMessage
+ * @{
+ *
+ * @brief Here you can find all message types used my the MySensors protocol as well as macros for
+ * parsing and manipulating messages.
 */
 #ifndef MyMessage_h
 #define MyMessage_h
@@ -334,3 +339,4 @@ uint8_t array[HEADER_SIZE + MAX_PAYLOAD + 1];
 #endif

 #endif
+/** @}*/
@@ -18,6 +18,7 @@
 */
 /**
 * @defgroup MySigninggrp MySigning
+ * @ingroup internals
 * @{
 *
 * @brief The signing driver provides a generic API for various signing backends to offer
@@ -349,6 +349,7 @@ class AES

 /**
 * @defgroup aeslib AES library for Arduino and Raspberry pi
+ * @ingroup internals
 *
 * @section Goals design Goals
 *
@@ -22,6 +22,7 @@
 * @brief Fast Digital Pin functions
 *
 * @defgroup digitalPin Fast Pin I/O
+ * @ingroup internals
 * @details  Fast Digital I/O functions and template class.
 * @{
 */
@@ -22,6 +22,7 @@
 * @brief  Two Wire Interface constants.
 *
 * @defgroup twoWire I2C constants
+ * @ingroup internals
 * @details  Two Wire Interface library.
 * @{
 */
@@ -22,6 +22,7 @@
 * @brief Digital AVR port I/O with runtime pin number.
 *
 * @defgroup runtimeDigital Runtime Pin I/O
+ * @ingroup internals
 * @details  Two Wire Interface library.
 * @{
 */
@@ -24,6 +24,7 @@
 * @brief Software I2C library
 *
 * @defgroup softI2C Software I2C
+ * @ingroup internals
 * @details  Software Two Wire Interface library.
 * @{
 */
@@ -22,6 +22,7 @@
 * @brief  Software SPI.
 *
 * @defgroup softSPI Software SPI
+ * @ingroup internals
 * @details  Software SPI Template Class.
 * @{
 */
@@ -1000,6 +1000,7 @@ private:

 /**
 * @defgroup rf24 Optimized High Speed Driver for nRF24L01(+) 2.4GHz Wireless Transceiver
+ * @ingroup internals
 *
 * @section Goals Design Goals
 *