aboutsummaryrefslogtreecommitdiffstats
path: root/doc/nil
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2014-12-08 18:01:38 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2014-12-08 18:01:38 +0000
commit787956f72ea99e5cbac58964d02f78d4212aaaf9 (patch)
tree032f7f795c7ac3f25186a3e3d55ffe125bef83e3 /doc/nil
parenta6e69a827cb0eddd569df4670f32a93159be3c35 (diff)
downloadChibiOS-787956f72ea99e5cbac58964d02f78d4212aaaf9.tar.gz
ChibiOS-787956f72ea99e5cbac58964d02f78d4212aaaf9.tar.bz2
ChibiOS-787956f72ea99e5cbac58964d02f78d4212aaaf9.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@7564 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'doc/nil')
-rw-r--r--doc/nil/Doxyfile_html14
-rw-r--r--doc/nil/src/main.dox3
2 files changed, 9 insertions, 8 deletions
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).
*
* <h2>Why Nil?</h2>
+ * 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.
* .
*/