Refactor the Doxygen structure (#880)
This commit is contained in:
committed by
Henrik Ekblad
parent
1cd2c6df05
commit
f3ab329ad3
@@ -1,10 +1,44 @@
|
||||
/**
|
||||
@mainpage MySensors library and examples documentation
|
||||
|
||||
@copyright (C) 2013-2015 Sensnology AB
|
||||
Are you a sketch developer/user, see @ref publics
|
||||
|
||||
Are you a core/library developerer, see @ref internals
|
||||
|
||||
@copyright (C) 2013-2017 Sensnology AB
|
||||
|
||||
Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
|
||||
*/
|
||||
|
||||
/*
|
||||
* Doxygen groups that are spread across files/sections
|
||||
*/
|
||||
/**
|
||||
@defgroup internals MySensors internal APIs and functionalities
|
||||
* @defgroup publics MySensors public APIs and functionalities
|
||||
* @brief The public APIs and functionalities are directly accessible to sketch developers/users.
|
||||
*
|
||||
* @defgroup internals MySensors internal APIs and functionalities
|
||||
* @brief The interal APIs and functionalities should only be used by library developers/advanced
|
||||
* users.
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup MyConfigGrp Library customisation
|
||||
* @ingroup publics
|
||||
*
|
||||
* @brief The MySensors library can be customized in various ways.
|
||||
*
|
||||
* All customizations are set in the sketch. @note It is important to define any customizations
|
||||
* before including the primary library header. @see MySensors.h
|
||||
*/
|
||||
/**
|
||||
* @defgroup memorysavings Tips for reducing memory footprint
|
||||
* @ingroup MyConfigGrp
|
||||
*
|
||||
* @brief Some settings are optional but add significantly to the memory footprint size.
|
||||
*
|
||||
* By disabeling optional features that you don't need you can save memory which can be a valuable
|
||||
* resource on cheaper hardware like the atmega328p.
|
||||
* These options can be defined in your sketch to disable such features.
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user