From 497dcb950c17387521476c938c32430a1054b3c4 Mon Sep 17 00:00:00 2001 From: Jose Alamos Date: Fri, 24 Aug 2018 17:50:37 +0200 Subject: [PATCH 1/5] doc: add sys_math group --- sys/doc.txt | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/sys/doc.txt b/sys/doc.txt index 9dda1b2c8f..7fa868c9c9 100644 --- a/sys/doc.txt +++ b/sys/doc.txt @@ -22,3 +22,9 @@ * See http://wiki.osdev.org/Stack_Smashing_Protector for a more detailed * description. */ + +/** + * @defgroup sys_math Math libraries and utilities + * @ingroup sys + * @brief Provides math libraries and utilities for RIOT + */ From d87199420ce9510f5a31a0c3c178f6b94c9e5bef Mon Sep 17 00:00:00 2001 From: Jose Alamos Date: Fri, 24 Aug 2018 17:51:11 +0200 Subject: [PATCH 2/5] sys/div.h: change ingroup directive --- sys/include/div.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sys/include/div.h b/sys/include/div.h index 54bfa15242..bdb633f184 100644 --- a/sys/include/div.h +++ b/sys/include/div.h @@ -9,13 +9,13 @@ /** * @defgroup sys_div Integer division functions - * @ingroup sys + * @ingroup sys_math * * This header provides some integer division functions that can be used * to prevent linking in compiler-generated ones, which are often larger. * * @file - * @ingroup sys + * @ingroup sys_div * @author Kaspar Schleiser * @author Joakim NohlgÄrd * @{ From 58295ab757eab39b4fa1a0a843b088b79b2ec051 Mon Sep 17 00:00:00 2001 From: Jose Alamos Date: Fri, 24 Aug 2018 17:55:15 +0200 Subject: [PATCH 3/5] sys/matstat: change ingroup directive --- sys/include/matstat.h | 4 +--- sys/matstat/doc.txt | 5 +++++ 2 files changed, 6 insertions(+), 3 deletions(-) create mode 100644 sys/matstat/doc.txt diff --git a/sys/include/matstat.h b/sys/include/matstat.h index 74c99df101..95e322f735 100644 --- a/sys/include/matstat.h +++ b/sys/include/matstat.h @@ -7,9 +7,7 @@ */ /** - * @defgroup sys_matstat Matstat - Integer mathematical statistics library - * @ingroup sys - * @brief Library for computing 1-pass statistics + * @ingroup sys_matstat * * The Matstat library uses single pass algorithms to compute statistic measures * such as mean and variance over many values. The values can be immediately diff --git a/sys/matstat/doc.txt b/sys/matstat/doc.txt new file mode 100644 index 0000000000..f51cecd850 --- /dev/null +++ b/sys/matstat/doc.txt @@ -0,0 +1,5 @@ +/** + * @defgroup sys_matstat Matstat - Integer mathematical statistics library + * @ingroup sys_math + * @brief Library for computing 1-pass statistics + */ From 70420197edfe686d81c61928845a42d56e612273 Mon Sep 17 00:00:00 2001 From: Jose Alamos Date: Fri, 24 Aug 2018 17:57:55 +0200 Subject: [PATCH 4/5] sys/seq: change ingroup directive --- sys/include/seq.h | 4 +--- sys/seq/doc.txt | 5 +++++ 2 files changed, 6 insertions(+), 3 deletions(-) create mode 100644 sys/seq/doc.txt diff --git a/sys/include/seq.h b/sys/include/seq.h index 942c0d4a2f..e9f007b32e 100644 --- a/sys/include/seq.h +++ b/sys/include/seq.h @@ -7,9 +7,7 @@ */ /** - * @defgroup sys_seq Serial Number Arithmetic - * @ingroup sys - * @brief Serial Number Arithmetic (RFC 1982) + * @ingroup sys_seq * @{ * * @file diff --git a/sys/seq/doc.txt b/sys/seq/doc.txt new file mode 100644 index 0000000000..167da65bc9 --- /dev/null +++ b/sys/seq/doc.txt @@ -0,0 +1,5 @@ +/** + * @defgroup sys_seq Serial Number Arithmetic + * @ingroup sys_math + * @brief Serial Number Arithmetic (RFC 1982) + */ From 961cc9d0d1d63144f58543bdc03e0ed4266d3e0e Mon Sep 17 00:00:00 2001 From: Jose Alamos Date: Fri, 24 Aug 2018 18:01:38 +0200 Subject: [PATCH 5/5] pkg/libfixmath: change ingroup directive --- pkg/libfixmath/doc.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pkg/libfixmath/doc.txt b/pkg/libfixmath/doc.txt index 34caa8fecb..1871b992b8 100644 --- a/pkg/libfixmath/doc.txt +++ b/pkg/libfixmath/doc.txt @@ -1,7 +1,7 @@ /** * @defgroup pkg_libfixmath Cross platform fixed point maths library * @ingroup pkg - * @ingroup sys + * @ingroup sys_math * @brief Provides a cross platform fixed point maths library to RIOT. * @see https://github.com/PetteriAimonen/libfixmath - */ \ No newline at end of file + */