Merge pull request #9842 from jia200x/pr/doc_math

doc: add `math` group to Doxygen
This commit is contained in:
Alexandre Abadie 2018-08-27 10:34:09 +02:00 committed by GitHub
commit 0cfdaab246
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 22 additions and 10 deletions

View File

@ -1,7 +1,7 @@
/** /**
* @defgroup pkg_libfixmath Cross platform fixed point maths library * @defgroup pkg_libfixmath Cross platform fixed point maths library
* @ingroup pkg * @ingroup pkg
* @ingroup sys * @ingroup sys_math
* @brief Provides a cross platform fixed point maths library to RIOT. * @brief Provides a cross platform fixed point maths library to RIOT.
* @see https://github.com/PetteriAimonen/libfixmath * @see https://github.com/PetteriAimonen/libfixmath
*/ */

View File

@ -22,3 +22,9 @@
* See http://wiki.osdev.org/Stack_Smashing_Protector for a more detailed * See http://wiki.osdev.org/Stack_Smashing_Protector for a more detailed
* description. * description.
*/ */
/**
* @defgroup sys_math Math libraries and utilities
* @ingroup sys
* @brief Provides math libraries and utilities for RIOT
*/

View File

@ -9,13 +9,13 @@
/** /**
* @defgroup sys_div Integer division functions * @defgroup sys_div Integer division functions
* @ingroup sys * @ingroup sys_math
* *
* This header provides some integer division functions that can be used * This header provides some integer division functions that can be used
* to prevent linking in compiler-generated ones, which are often larger. * to prevent linking in compiler-generated ones, which are often larger.
* *
* @file * @file
* @ingroup sys * @ingroup sys_div
* @author Kaspar Schleiser <kaspar@schleiser.de> * @author Kaspar Schleiser <kaspar@schleiser.de>
* @author Joakim Nohlgård <joakim.nohlgard@eistec.se> * @author Joakim Nohlgård <joakim.nohlgard@eistec.se>
* @{ * @{

View File

@ -7,9 +7,7 @@
*/ */
/** /**
* @defgroup sys_matstat Matstat - Integer mathematical statistics library * @ingroup sys_matstat
* @ingroup sys
* @brief Library for computing 1-pass statistics
* *
* The Matstat library uses single pass algorithms to compute statistic measures * The Matstat library uses single pass algorithms to compute statistic measures
* such as mean and variance over many values. The values can be immediately * such as mean and variance over many values. The values can be immediately

View File

@ -7,9 +7,7 @@
*/ */
/** /**
* @defgroup sys_seq Serial Number Arithmetic * @ingroup sys_seq
* @ingroup sys
* @brief Serial Number Arithmetic (RFC 1982)
* @{ * @{
* *
* @file * @file

5
sys/matstat/doc.txt Normal file
View File

@ -0,0 +1,5 @@
/**
* @defgroup sys_matstat Matstat - Integer mathematical statistics library
* @ingroup sys_math
* @brief Library for computing 1-pass statistics
*/

5
sys/seq/doc.txt Normal file
View File

@ -0,0 +1,5 @@
/**
* @defgroup sys_seq Serial Number Arithmetic
* @ingroup sys_math
* @brief Serial Number Arithmetic (RFC 1982)
*/