diff options
| -rw-r--r-- | doc/nil/Doxyfile_chm | 6 | ||||
| -rw-r--r-- | doc/nil/Doxyfile_html | 6 | ||||
| -rw-r--r-- | doc/rt/Doxyfile_chm | 4 | ||||
| -rw-r--r-- | doc/rt/Doxyfile_html | 4 | ||||
| -rw-r--r-- | os/common/oslib/include/chheap.h | 1 | ||||
| -rw-r--r-- | os/rt/dox/rt.dox | 25 | ||||
| -rw-r--r-- | os/rt/include/chalign.h | 2 | ||||
| -rw-r--r-- | readme.txt | 2 |
8 files changed, 28 insertions, 22 deletions
diff --git a/doc/nil/Doxyfile_chm b/doc/nil/Doxyfile_chm index 031e5f867..828d37757 100644 --- a/doc/nil/Doxyfile_chm +++ b/doc/nil/Doxyfile_chm @@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/NIL # could be handy for archiving the generated documentation or if some version
# control system is used.
-PROJECT_NUMBER = 1.1.0
+PROJECT_NUMBER = 2.0.0
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
@@ -790,7 +790,9 @@ INPUT = ./src \ ../../os/nil/dox \
../../os/nil/src \
../../os/nil/include \
- ../../os/nil/templates
+ ../../os/nil/templates \
+ ../../os/common/oslib/src \
+ ../../os/common/oslib/include
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
diff --git a/doc/nil/Doxyfile_html b/doc/nil/Doxyfile_html index a19efd4d3..6fbc345ec 100644 --- a/doc/nil/Doxyfile_html +++ b/doc/nil/Doxyfile_html @@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/NIL # could be handy for archiving the generated documentation or if some version
# control system is used.
-PROJECT_NUMBER = 1.1.0
+PROJECT_NUMBER = 2.0.0
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
@@ -790,7 +790,9 @@ INPUT = ./src \ ../../os/nil/dox \
../../os/nil/src \
../../os/nil/include \
- ../../os/nil/templates
+ ../../os/nil/templates \
+ ../../os/common/oslib/src \
+ ../../os/common/oslib/include
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
diff --git a/doc/rt/Doxyfile_chm b/doc/rt/Doxyfile_chm index bc45ba1c6..1ec12fca1 100644 --- a/doc/rt/Doxyfile_chm +++ b/doc/rt/Doxyfile_chm @@ -790,7 +790,9 @@ INPUT = ./src \ ../../os/rt/dox \
../../os/rt/src \
../../os/rt/include \
- ../../os/rt/templates
+ ../../os/rt/templates \
+ ../../os/common/oslib/src \
+ ../../os/common/oslib/include
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
diff --git a/doc/rt/Doxyfile_html b/doc/rt/Doxyfile_html index bbf952ec4..e1cb9952f 100644 --- a/doc/rt/Doxyfile_html +++ b/doc/rt/Doxyfile_html @@ -790,7 +790,9 @@ INPUT = ./src \ ../../os/rt/dox \
../../os/rt/src \
../../os/rt/include \
- ../../os/rt/templates
+ ../../os/rt/templates \
+ ../../os/common/oslib/src \
+ ../../os/common/oslib/include
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
diff --git a/os/common/oslib/include/chheap.h b/os/common/oslib/include/chheap.h index db8b70269..0447d546d 100644 --- a/os/common/oslib/include/chheap.h +++ b/os/common/oslib/include/chheap.h @@ -163,6 +163,7 @@ static inline void *chHeapAlloc(memory_heap_t *heapp, size_t size) { * same value aligned to the next @p CH_HEAP_ALIGNMENT multiple.
*
* @param[in] p pointer to the memory block
+ * @return Size of the block.
*
* @api
*/
diff --git a/os/rt/dox/rt.dox b/os/rt/dox/rt.dox index 78b1baa09..0972a1dd5 100644 --- a/os/rt/dox/rt.dox +++ b/os/rt/dox/rt.dox @@ -34,11 +34,6 @@ */
/**
- * @defgroup types Kernel Types
- * @ingroup kernel
- */
-
-/**
* @defgroup base Base Kernel Services
* @details Base kernel services, the base subsystems are always included in
* the OS builds.
@@ -112,6 +107,12 @@ */
/**
+ * @defgroup mem Memory Alignment
+ * @details Memory Alignment services.
+ * @ingroup kernel
+ */
+
+/**
* @defgroup memory Memory Management
* @details Memory Management services.
* @ingroup kernel
@@ -137,24 +138,18 @@ * @ingroup memory
*/
- /**
- * @defgroup streams Streams and Files
- * @details Stream and Files interfaces.
- * @ingroup kernel
- */
-
/**
- * @defgroup data_streams Abstract Sequential Streams
- * @ingroup streams
+ * @defgroup registry Registry
+ * @ingroup kernel
*/
/**
- * @defgroup registry Registry
+ * @defgroup debug Debug
* @ingroup kernel
*/
/**
- * @defgroup debug Debug
+ * @defgroup trace Trace
* @ingroup kernel
*/
diff --git a/os/rt/include/chalign.h b/os/rt/include/chalign.h index ae1a2184f..ac3b30d96 100644 --- a/os/rt/include/chalign.h +++ b/os/rt/include/chalign.h @@ -70,7 +70,7 @@ /*lint -restore*/
/**
- * @brief Aligns to the new aligned memory address.
+ * @brief Aligns to the next aligned memory address.
*
* @param[in] p variable to be aligned
* @param[in] a alignment, must be a power of two
diff --git a/readme.txt b/readme.txt index 19425b5f9..9d824a2b5 100644 --- a/readme.txt +++ b/readme.txt @@ -88,5 +88,7 @@ *****************************************************************************
*** Next ***
+- NIL: Fixed documentation-related issues (bug #850)(backported 17.6.1).
+- RT: Fixed documentation-related issues (bug #850)(backported 17.6.1).
- RT: Fixed leftover chcustomer.h file (bug #849)(backported 17.6.1).
- RT: Fixed invalid check in chchecks.h (bug #848)(backported 17.6.1).
|