diff --git a/doc/nil/Doxyfile_html b/doc/nil/Doxyfile_html index 5f0a2e810..78db3865a 100644 --- a/doc/nil/Doxyfile_html +++ b/doc/nil/Doxyfile_html @@ -25,13 +25,13 @@ DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. -PROJECT_NAME = ChibiOS/RT +PROJECT_NAME = ChibiOS/NIL # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = 3.0.0dev +PROJECT_NUMBER = 1.0.0dev # 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 @@ -644,11 +644,9 @@ WARN_LOGFILE = # with spaces. INPUT = ./src \ - ../../os/rt/dox \ - ../../os/rt/src \ - ../../os/rt/include \ - ../../os/rt/templates \ - ../../test/rt + ../../os/nil/src \ + ../../os/nil/include \ + ../../os/nil/templates # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is @@ -1023,7 +1021,7 @@ GENERATE_HTMLHELP = NO # can add a path in front of the file if the result should not be # written to the html output directory. -CHM_FILE = ../../ChibiOS_RT.chm +CHM_FILE = ../../ChibiOS_NIL.chm # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can # be used to specify the location (absolute path including file name) of diff --git a/doc/nil/src/main.dox b/doc/nil/src/main.dox index 02e51ccc3..4a3a3fae6 100644 --- a/doc/nil/src/main.dox +++ b/doc/nil/src/main.dox @@ -23,6 +23,7 @@ * @author Giovanni Di Sirio (gdisirio@users.sourceforge.net). * *

Why Nil?

+ * Of course because it is so small that it is almost nil. * I wrote Nil because I wanted to experiment with an idea I had * regarding a minimal RTOS. Basically I wanted to verify how small * could be an RTOS while retaining useful features. @@ -39,5 +40,7 @@ * - Minimal system requirements: about 700 bytes ROM with all options enabled. * - Almost totally written in C with little ASM code required for ports. * - Compatible with ChibiOS/HAL. + * - API compatible with ChibiOS/RT of which, ChibiOS/NIL, is functionally + * a subset. * . */ diff --git a/doc/rt/src/main.dox b/doc/rt/src/main.dox index 357a45e81..e99d55db8 100644 --- a/doc/rt/src/main.dox +++ b/doc/rt/src/main.dox @@ -55,8 +55,7 @@ * speed optimizations on. The size can shrink under 2KiB by disabling the * the unused subsystems and optimizing for size. * - Almost totally written in C with little ASM code required for ports. - * - Optional Hardware Abstraction Layer (HAL) with support for many device - * driver models and device driver implementations. + * - Compatible with ChibiOS/HAL. * . *

Related pages

* - @subpage concepts diff --git a/os/nil/include/nil.h b/os/nil/include/nil.h index 47f93af0b..815b5ead4 100644 --- a/os/nil/include/nil.h +++ b/os/nil/include/nil.h @@ -23,7 +23,7 @@ * @details This header includes all the required kernel headers so it is the * only header you usually need to include in your application. * - * @addtogroup nil + * @addtogroup NIL * @{ */ @@ -758,7 +758,7 @@ typedef struct { * @note The counter can reach its maximum and then restart from zero. * @note This function can be called from any context but its atomicity * is not guaranteed on architectures whose word size is less than - * @systime_t size. + * @p systime_t size. * * @return The system time in ticks. * diff --git a/os/nil/src/nil.c b/os/nil/src/nil.c index 48f640b09..e79fdca27 100644 --- a/os/nil/src/nil.c +++ b/os/nil/src/nil.c @@ -21,7 +21,7 @@ * @file nil.c * @brief Nil RTOS main source file. * - * @defgroup nil + * @defgroup NIL API * @details Nil RTOS services. * @{ */ @@ -118,6 +118,8 @@ void chSysInit(void) { * in debug mode. * @note Can be invoked from any system state. * + * @param[in] reason pointer to an error string + * * @special */ void chSysHalt(const char *reason) {