From ef61ab2e4a28aebb2a661f891cb9fa074bb38ab9 Mon Sep 17 00:00:00 2001 From: gdisirio Date: Mon, 8 Dec 2014 19:18:25 +0000 Subject: [PATCH] NIL documentation build works. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@7565 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- doc/nil/Doxyfile_html | 3 ++- doc/nil/src/main.dox | 2 +- os/nil/dox/nil.dox | 46 +++++++++++++++++++++++++++++++++++++ os/nil/include/nil.h | 2 +- os/nil/src/nil.c | 3 +-- os/nil/templates/nilconf.h | 2 +- os/nil/templates/nilcore.h | 4 ++-- os/nil/templates/niltypes.h | 2 +- 8 files changed, 55 insertions(+), 9 deletions(-) create mode 100644 os/nil/dox/nil.dox diff --git a/doc/nil/Doxyfile_html b/doc/nil/Doxyfile_html index 78db3865a..f4cc2b442 100644 --- a/doc/nil/Doxyfile_html +++ b/doc/nil/Doxyfile_html @@ -361,7 +361,7 @@ EXTRACT_PRIVATE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. -EXTRACT_STATIC = NO +EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # defined locally in source files will be included in the documentation. @@ -644,6 +644,7 @@ WARN_LOGFILE = # with spaces. INPUT = ./src \ + ../../os/nil/dox \ ../../os/nil/src \ ../../os/nil/include \ ../../os/nil/templates diff --git a/doc/nil/src/main.dox b/doc/nil/src/main.dox index 4a3a3fae6..3ce29ecaa 100644 --- a/doc/nil/src/main.dox +++ b/doc/nil/src/main.dox @@ -35,7 +35,7 @@ * - Easily portable. * - Preemptive scheduling. * - Each thread has its own priority level. - * - Offers tasks, task queues, semaphores, event flags, timeouts. + * - Offers tasks, time, semaphores, event flags, timeouts. * - Fully static. * - Minimal system requirements: about 700 bytes ROM with all options enabled. * - Almost totally written in C with little ASM code required for ports. diff --git a/os/nil/dox/nil.dox b/os/nil/dox/nil.dox new file mode 100644 index 000000000..f3db9e5bb --- /dev/null +++ b/os/nil/dox/nil.dox @@ -0,0 +1,46 @@ +/* + ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010, + 2011,2012,2013,2014 Giovanni Di Sirio. + + This file is part of ChibiOS/RT. + + ChibiOS/RT is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + ChibiOS/RT is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +*/ + +/** + * @defgroup NIL NIL Kernel + * @details The kernel is the portable part of ChibiOS/NIL, this section + * documents the various kernel subsystems. + */ + +/** + * @defgroup NIL_CONFIG Configuration + * @ingroup NIL + */ + +/** + * @defgroup NIL_TYPES Kernel Types + * @ingroup NIL + */ + +/** + * @defgroup NIL_KERNEL API + * @ingroup NIL + */ + +/** + * @defgroup NIL_CORE Port Layer + * @ingroup NIL + */ + \ No newline at end of file diff --git a/os/nil/include/nil.h b/os/nil/include/nil.h index 815b5ead4..e6644f1e9 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_KERNEL * @{ */ diff --git a/os/nil/src/nil.c b/os/nil/src/nil.c index e79fdca27..f5c0d99dc 100644 --- a/os/nil/src/nil.c +++ b/os/nil/src/nil.c @@ -21,8 +21,7 @@ * @file nil.c * @brief Nil RTOS main source file. * - * @defgroup NIL API - * @details Nil RTOS services. + * @addtogroup NIL_KERNEL * @{ */ diff --git a/os/nil/templates/nilconf.h b/os/nil/templates/nilconf.h index bf815eb44..394ef30cb 100644 --- a/os/nil/templates/nilconf.h +++ b/os/nil/templates/nilconf.h @@ -20,7 +20,7 @@ * @details A copy of this file must be placed in each project directory, it * contains the application specific kernel settings. * - * @addtogroup config + * @addtogroup NIL_CONFIG * @details Kernel related settings and hooks. * @{ */ diff --git a/os/nil/templates/nilcore.h b/os/nil/templates/nilcore.h index 2317ee852..a985c8642 100644 --- a/os/nil/templates/nilcore.h +++ b/os/nil/templates/nilcore.h @@ -244,8 +244,8 @@ static inline syssts_t port_get_irq_status(void) { * @param[in] sts the interrupt status word * * @return The interrupt status. - * @retvel false the word specified a disabled interrupts status. - * @retvel true the word specified an enabled interrupts status. + * @retval false the word specified a disabled interrupts status. + * @retval true the word specified an enabled interrupts status. */ static inline bool port_irq_enabled(syssts_t sts) { diff --git a/os/nil/templates/niltypes.h b/os/nil/templates/niltypes.h index 64ae606ee..9e5ea0a99 100644 --- a/os/nil/templates/niltypes.h +++ b/os/nil/templates/niltypes.h @@ -21,7 +21,7 @@ * @file templates/niltypes.h * @brief Port system types. * - * @addtogroup NIL_CORE + * @addtogroup NIL_TYPES * @{ */