Improve doxygen comments in code.

This commit is contained in:
2021-10-11 19:45:13 +02:00
parent c82ca7d8f0
commit 6fde4cfd66
9 changed files with 298 additions and 19 deletions

View File

@@ -18,9 +18,19 @@
* If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @addtogroup main-cycle-counter
* @{
*/
#include <reflow-controller/main-cycle-counter.h>
#include <helper-macros/helper-macros.h>
/**
* @brief Variable storing the main cycle counter.
* @note This variable should not be accessed directly.
* Use the main_cycle_counter_get() or main_cycle_counter_inc() functions.
*/
static uint64_t IN_SECTION(.ccm.bss) main_cycle_counter;
void main_cycle_counter_init(void)
@@ -37,3 +47,5 @@ uint64_t main_cycle_counter_get(void)
{
return main_cycle_counter;
}
/** @} */