From 941503b24f126397a08eb7872f2d440d5d74c363 Mon Sep 17 00:00:00 2001 From: Patrick Fallberg Date: Wed, 9 Dec 2015 10:46:59 +0100 Subject: [PATCH] Divided public and private/internal modules Public modules can be declared as normal. Internal modules should have @ingroup internals after the group definition. --- Documentation/mainpage.dox | 3 +++ libraries/MySensors/core/MyMessage.h | 6 ++++++ libraries/MySensors/core/MySigning.h | 1 + libraries/MySensors/drivers/AES/AES.h | 1 + libraries/MySensors/drivers/AVR/DigitalIO/DigitalPin.h | 1 + libraries/MySensors/drivers/AVR/DigitalIO/I2cConstants.h | 1 + libraries/MySensors/drivers/AVR/DigitalIO/PinIO.h | 1 + libraries/MySensors/drivers/AVR/DigitalIO/SoftI2cMaster.h | 1 + libraries/MySensors/drivers/AVR/DigitalIO/SoftSPI.h | 1 + libraries/MySensors/drivers/RF24/RF24.h | 1 + 10 files changed, 17 insertions(+) diff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox index 380c9b6..6e91055 100644 --- a/Documentation/mainpage.dox +++ b/Documentation/mainpage.dox @@ -5,3 +5,6 @@ Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors */ +/** +@defgroup internals MySensors internal APIs and functionalities +*/ diff --git a/libraries/MySensors/core/MyMessage.h b/libraries/MySensors/core/MyMessage.h index cbdf321..c84494a 100644 --- a/libraries/MySensors/core/MyMessage.h +++ b/libraries/MySensors/core/MyMessage.h @@ -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 +/** @}*/ \ No newline at end of file diff --git a/libraries/MySensors/core/MySigning.h b/libraries/MySensors/core/MySigning.h index 1435fee..9591295 100644 --- a/libraries/MySensors/core/MySigning.h +++ b/libraries/MySensors/core/MySigning.h @@ -18,6 +18,7 @@ */ /** * @defgroup MySigninggrp MySigning + * @ingroup internals * @{ * * @brief The signing driver provides a generic API for various signing backends to offer diff --git a/libraries/MySensors/drivers/AES/AES.h b/libraries/MySensors/drivers/AES/AES.h index f391766..a37a1e5 100644 --- a/libraries/MySensors/drivers/AES/AES.h +++ b/libraries/MySensors/drivers/AES/AES.h @@ -349,6 +349,7 @@ class AES /** * @defgroup aeslib AES library for Arduino and Raspberry pi + * @ingroup internals * * @section Goals design Goals * diff --git a/libraries/MySensors/drivers/AVR/DigitalIO/DigitalPin.h b/libraries/MySensors/drivers/AVR/DigitalIO/DigitalPin.h index d7adb8b..1b0066b 100644 --- a/libraries/MySensors/drivers/AVR/DigitalIO/DigitalPin.h +++ b/libraries/MySensors/drivers/AVR/DigitalIO/DigitalPin.h @@ -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. * @{ */ diff --git a/libraries/MySensors/drivers/AVR/DigitalIO/I2cConstants.h b/libraries/MySensors/drivers/AVR/DigitalIO/I2cConstants.h index 7b2c749..eb99c6b 100644 --- a/libraries/MySensors/drivers/AVR/DigitalIO/I2cConstants.h +++ b/libraries/MySensors/drivers/AVR/DigitalIO/I2cConstants.h @@ -22,6 +22,7 @@ * @brief Two Wire Interface constants. * * @defgroup twoWire I2C constants + * @ingroup internals * @details Two Wire Interface library. * @{ */ diff --git a/libraries/MySensors/drivers/AVR/DigitalIO/PinIO.h b/libraries/MySensors/drivers/AVR/DigitalIO/PinIO.h index b944664..d91aae3 100644 --- a/libraries/MySensors/drivers/AVR/DigitalIO/PinIO.h +++ b/libraries/MySensors/drivers/AVR/DigitalIO/PinIO.h @@ -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. * @{ */ diff --git a/libraries/MySensors/drivers/AVR/DigitalIO/SoftI2cMaster.h b/libraries/MySensors/drivers/AVR/DigitalIO/SoftI2cMaster.h index 33e11fc..309232a 100644 --- a/libraries/MySensors/drivers/AVR/DigitalIO/SoftI2cMaster.h +++ b/libraries/MySensors/drivers/AVR/DigitalIO/SoftI2cMaster.h @@ -24,6 +24,7 @@ * @brief Software I2C library * * @defgroup softI2C Software I2C + * @ingroup internals * @details Software Two Wire Interface library. * @{ */ diff --git a/libraries/MySensors/drivers/AVR/DigitalIO/SoftSPI.h b/libraries/MySensors/drivers/AVR/DigitalIO/SoftSPI.h index da59cbf..86f9d94 100644 --- a/libraries/MySensors/drivers/AVR/DigitalIO/SoftSPI.h +++ b/libraries/MySensors/drivers/AVR/DigitalIO/SoftSPI.h @@ -22,6 +22,7 @@ * @brief Software SPI. * * @defgroup softSPI Software SPI + * @ingroup internals * @details Software SPI Template Class. * @{ */ diff --git a/libraries/MySensors/drivers/RF24/RF24.h b/libraries/MySensors/drivers/RF24/RF24.h index 801f80b..8cbfc7c 100644 --- a/libraries/MySensors/drivers/RF24/RF24.h +++ b/libraries/MySensors/drivers/RF24/RF24.h @@ -1000,6 +1000,7 @@ private: /** * @defgroup rf24 Optimized High Speed Driver for nRF24L01(+) 2.4GHz Wireless Transceiver + * @ingroup internals * * @section Goals Design Goals *