NIL documentation build works.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@7565 35acf78f-673a-0410-8e92-d51de3d6d3f4
master
gdisirio 2014-12-08 19:18:25 +00:00
parent 787956f72e
commit ef61ab2e4a
8 changed files with 55 additions and 9 deletions

View File

@ -361,7 +361,7 @@ EXTRACT_PRIVATE = NO
# If the EXTRACT_STATIC tag is set to YES all static members of a file # If the EXTRACT_STATIC tag is set to YES all static members of a file
# will be included in the documentation. # 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) # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation. # defined locally in source files will be included in the documentation.
@ -644,6 +644,7 @@ WARN_LOGFILE =
# with spaces. # with spaces.
INPUT = ./src \ INPUT = ./src \
../../os/nil/dox \
../../os/nil/src \ ../../os/nil/src \
../../os/nil/include \ ../../os/nil/include \
../../os/nil/templates ../../os/nil/templates

View File

@ -35,7 +35,7 @@
* - Easily portable. * - Easily portable.
* - Preemptive scheduling. * - Preemptive scheduling.
* - Each thread has its own priority level. * - Each thread has its own priority level.
* - Offers tasks, task queues, semaphores, event flags, timeouts. * - Offers tasks, time, semaphores, event flags, timeouts.
* - Fully static. * - Fully static.
* - Minimal system requirements: about 700 bytes ROM with all options enabled. * - Minimal system requirements: about 700 bytes ROM with all options enabled.
* - Almost totally written in C with little ASM code required for ports. * - Almost totally written in C with little ASM code required for ports.

46
os/nil/dox/nil.dox Normal file
View File

@ -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 <http://www.gnu.org/licenses/>.
*/
/**
* @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
*/

View File

@ -23,7 +23,7 @@
* @details This header includes all the required kernel headers so it is the * @details This header includes all the required kernel headers so it is the
* only header you usually need to include in your application. * only header you usually need to include in your application.
* *
* @addtogroup NIL * @addtogroup NIL_KERNEL
* @{ * @{
*/ */

View File

@ -21,8 +21,7 @@
* @file nil.c * @file nil.c
* @brief Nil RTOS main source file. * @brief Nil RTOS main source file.
* *
* @defgroup NIL API * @addtogroup NIL_KERNEL
* @details Nil RTOS services.
* @{ * @{
*/ */

View File

@ -20,7 +20,7 @@
* @details A copy of this file must be placed in each project directory, it * @details A copy of this file must be placed in each project directory, it
* contains the application specific kernel settings. * contains the application specific kernel settings.
* *
* @addtogroup config * @addtogroup NIL_CONFIG
* @details Kernel related settings and hooks. * @details Kernel related settings and hooks.
* @{ * @{
*/ */

View File

@ -244,8 +244,8 @@ static inline syssts_t port_get_irq_status(void) {
* @param[in] sts the interrupt status word * @param[in] sts the interrupt status word
* *
* @return The interrupt status. * @return The interrupt status.
* @retvel false the word specified a disabled interrupts status. * @retval false the word specified a disabled interrupts status.
* @retvel true the word specified an enabled interrupts status. * @retval true the word specified an enabled interrupts status.
*/ */
static inline bool port_irq_enabled(syssts_t sts) { static inline bool port_irq_enabled(syssts_t sts) {

View File

@ -21,7 +21,7 @@
* @file templates/niltypes.h * @file templates/niltypes.h
* @brief Port system types. * @brief Port system types.
* *
* @addtogroup NIL_CORE * @addtogroup NIL_TYPES
* @{ * @{
*/ */