Fixed bug #850.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@10272 35acf78f-673a-0410-8e92-d51de3d6d3f4

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

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

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

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

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
  */

os/rt/dox/rt.dox

@@ -33,11 +33,6 @@
  * @ingroup kernel
  */
 
-/**
- * @defgroup types Kernel Types
- * @ingroup kernel
- */
-
 /**
  * @defgroup base Base Kernel Services
  * @details Base kernel services, the base subsystems are always included in
@@ -111,6 +106,12 @@
  * @ingroup synchronization
  */
 
+/**
+ * @defgroup mem Memory Alignment
+ * @details Memory Alignment services.
+ * @ingroup kernel
+ */
+
 /**
  * @defgroup memory Memory Management
  * @details Memory Management services.
@@ -137,17 +138,6 @@
  * @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
@@ -158,6 +148,11 @@
  * @ingroup kernel
  */
 
+/**
+ * @defgroup trace Trace
+ * @ingroup kernel
+ */
+
 /**
  * @defgroup time_measurement Time Measurement
  * @ingroup kernel

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

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).