diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Doxyfile | 12 | ||||
-rw-r--r-- | docs/src/articles.dox | 2 | ||||
-rw-r--r-- | docs/src/atomic.dox | 2 | ||||
-rw-r--r-- | docs/src/concepts.dox | 2 | ||||
-rw-r--r-- | docs/src/design.dox | 2 | ||||
-rw-r--r-- | docs/src/goals.dox | 2 | ||||
-rw-r--r-- | docs/src/interrupts.dox | 2 | ||||
-rw-r--r-- | docs/src/jitter.dox | 2 | ||||
-rw-r--r-- | docs/src/licfaq.dox | 2 | ||||
-rw-r--r-- | docs/src/main.dox | 21 | ||||
-rw-r--r-- | docs/src/mutualexcl.dox | 2 | ||||
-rw-r--r-- | docs/src/portguide.dox | 2 | ||||
-rw-r--r-- | docs/src/saveram.dox | 2 | ||||
-rw-r--r-- | docs/src/stacks.dox | 2 | ||||
-rw-r--r-- | docs/src/timing.dox | 2 |
15 files changed, 25 insertions, 34 deletions
diff --git a/docs/Doxyfile b/docs/Doxyfile index d6c461d6c..a7ee51445 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -573,10 +573,11 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = ../src/include \ +INPUT = ../docs/src \ + ../src/include \ ../src/templates \ ../src \ - ../docs/src \ + ../test \ ../src/lib \ ../ports/ARM7 \ ../ports/ARM7/crt0.s \ @@ -637,7 +638,7 @@ FILE_PATTERNS = *.c \ # should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. -RECURSIVE = YES +RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should # excluded from the INPUT source files. This way you can easily exclude a @@ -1298,17 +1299,12 @@ PREDEFINED = __DOXYGEN__ \ CH_USE_CONDVARS_TIMEOUT=1 \ CH_USE_EVENTS=1 \ CH_USE_EVENTS_TIMEOUT=1 \ - CH_USE_EXIT_EVENT=1 \ CH_USE_QUEUES=1 \ - CH_USE_QUEUES_TIMEOUT=1 \ - CH_USE_QUEUES_HALFDUPLEX=1 \ CH_USE_SERIAL_FULLDUPLEX=1 \ - CH_USE_SERIAL_HALFDUPLEX=1 \ CH_USE_HEAP=1 \ CH_USE_MEMPOOLS=1 \ CH_USE_MESSAGES=1 \ CH_USE_MAILBOXES=1 \ - CH_USE_MESSAGES_EVENT=1 \ CH_USE_DYNAMIC=1 \ CH_DBG_ENABLE_ASSERTS=1 \ CH_DBG_ENABLE_CHECKS=1 \ diff --git a/docs/src/articles.dox b/docs/src/articles.dox index 66268f9d7..e9849782c 100644 --- a/docs/src/articles.dox +++ b/docs/src/articles.dox @@ -19,7 +19,6 @@ /**
* @page articles Articles
- * @{
* ChibiOS/RT Articles and Code Examples:
* - @subpage article_stacks
* - @subpage article_mutual_exclusion
@@ -32,4 +31,3 @@ * - @subpage article_design
* .
*/
-/** @} */
diff --git a/docs/src/atomic.dox b/docs/src/atomic.dox index 5fb0bc628..5e2fb58cd 100644 --- a/docs/src/atomic.dox +++ b/docs/src/atomic.dox @@ -19,7 +19,6 @@ /**
* @page article_atomic Invoking multiple primitives as a single atomic operation
- * @{
* It is often necessary to invoke multiple operations involving a
* reschedulation as a single atomic operation.<br>
* ChibiOS/RT already implements APIs that perform complex operations, as
@@ -56,4 +55,3 @@ * API. An extra @p chSchRescheduleS() can be present at the very end of the
* block, it only reschedules if a reschedulation is still required.
*/
-/** @} */
diff --git a/docs/src/concepts.dox b/docs/src/concepts.dox index ed37ed349..8a7418b53 100644 --- a/docs/src/concepts.dox +++ b/docs/src/concepts.dox @@ -19,7 +19,6 @@ /**
* @page concepts Concepts and Architecture
- * @{
* @brief ChibiOS/RT Concepts and Architecture
* - @ref naming
* - @ref api_suffixes
@@ -261,4 +260,3 @@ * extra layers, this is just not part of the kernel architecture but part of
* the overall system design.
*/
-/** @} */
diff --git a/docs/src/design.dox b/docs/src/design.dox index 4b6780a7a..bc88edf6f 100644 --- a/docs/src/design.dox +++ b/docs/src/design.dox @@ -19,7 +19,6 @@ /**
* @page article_design Designing an embedded application
- * @{
* ChibiOS/RT offers a variety of mechanisms and primitives, often it is
* better to focus on a single approach for the system design and use only
* part of the available subsystems.<br>
@@ -109,4 +108,3 @@ * it. The OS is a toolbox that offers a lot of tools but you don't have
* to use them all necessarily.
*/
-/** @} */
diff --git a/docs/src/goals.dox b/docs/src/goals.dox index 46c092086..e7a26fb3f 100644 --- a/docs/src/goals.dox +++ b/docs/src/goals.dox @@ -19,7 +19,6 @@ /**
* @page goals Project Goals
- * @{
* <h2>Another RTOS?</h2>
* The first question to be answered is: there was really the need for YET
* ANOTHER RTOS?<br>
@@ -87,4 +86,3 @@ * code is released as well, all the included demos are capable of executing
* the test suite and the OS benchmarks.
*/
-/** @} */
diff --git a/docs/src/interrupts.dox b/docs/src/interrupts.dox index d2dfb70b5..95bd6c281 100644 --- a/docs/src/interrupts.dox +++ b/docs/src/interrupts.dox @@ -19,7 +19,6 @@ /**
* @page article_interrupts Writing interrupt handlers under ChibiOS/RT
- * @{
* Since version 1.1.0 ChibiOS/RT offers a cross-platform method for writing
* interrupt handlers. Port-related and compiler-related details are
* encapsulated within standard system macros.<br>
@@ -50,5 +49,4 @@ CH_IRQ_HANDLER(myIRQ) { * please read about it in the ARM7 port section: @ref ARM7_IH
* .
*/
-/** @} */
\ No newline at end of file diff --git a/docs/src/jitter.dox b/docs/src/jitter.dox index 747a07a7e..5f4e7ff5e 100644 --- a/docs/src/jitter.dox +++ b/docs/src/jitter.dox @@ -19,7 +19,6 @@ /**
* @page article_jitter Response Time and Jitter
- * @{
* Response time jitter is one of the most sneaky source of problems when
* designing a real time system. When using a RTOS like ChibiOS/RT one must
* be aware of what the jitter is and how it can affect the performance of the
@@ -134,4 +133,3 @@ * subsystem can improve the overall response time and reduce jitter but it is
* not a magic wand, a proper system design comes first.
*/
-/** @} */
diff --git a/docs/src/licfaq.dox b/docs/src/licfaq.dox index f3bf3c3a1..58e99a2bb 100644 --- a/docs/src/licfaq.dox +++ b/docs/src/licfaq.dox @@ -19,7 +19,6 @@ /**
* @page lic_faq License and F.A.Q.
- * @{
* ChibiOS/RT is a <a href="http://www.gnu.org/licenses" target="_top">
* GPL3</a>-licensed product but it offers a linking exception in its stable
* releases.<br>
@@ -89,5 +88,4 @@ Program code and other code used in conjunction with the Program except the Non-GPL Code covered by this exception.
*
*/
-/** @} */
\ No newline at end of file diff --git a/docs/src/main.dox b/docs/src/main.dox index 2e76e0a75..bf6eecd54 100644 --- a/docs/src/main.dox +++ b/docs/src/main.dox @@ -65,6 +65,27 @@ */
/**
+ * @page TEST_SUITE Tests Description
+ * <h2>Descriptions</h2>
+ * Most of the ChibiOS/RT demos link a set of software modules (test suite) in
+ * order to verify the proper working of the kernel, the port and the demo
+ * itself.<br>
+ * Each Test Module performs a series of tests on a specified subbsystem or
+ * subsystems and can report a failure/success status and/or a performance
+ * index as the test suite output.<br>
+ * The test suite is usually activated in the demo applications by pressing a
+ * button on the target board, see the readme into the various demos
+ * directories. The test suite output is usually sent through a serial port and
+ * can be examined by using a terminal emulator program.
+ *
+ * <h2>Test Modules</h2>
+ * - @subpage test_threads
+ * - @subpage test_queues
+ * - @subpage test_serial
+ * .
+ */
+
+/**
* @defgroup Ports Ports
* This section describes the technical details for the various supported
* ChibiOS/RT ports.
diff --git a/docs/src/mutualexcl.dox b/docs/src/mutualexcl.dox index ae6f57c0a..69eb65dc8 100644 --- a/docs/src/mutualexcl.dox +++ b/docs/src/mutualexcl.dox @@ -19,7 +19,6 @@ /**
* @page article_mutual_exclusion Mutual Exclusion guide
- * @{
* The most common problem when writing multithreaded code is the
* synchronization on the shared resources/services.<br>
* ChibiOS/RT offers a rich variety of mechanisms that apparently solve the
@@ -209,4 +208,3 @@ * - Requires a dedicated thread as server.
* .
*/
-/** @} */
diff --git a/docs/src/portguide.dox b/docs/src/portguide.dox index 57216885d..14a3c2eca 100644 --- a/docs/src/portguide.dox +++ b/docs/src/portguide.dox @@ -19,7 +19,6 @@ /**
* @page article_portguide Porting ChibiOS/RT for Dummies
- * @{
* Porting the operating system on a new platform is one of the most common
* tasks. The difficulty can range from easy to very difficult depending
* on several factors.<br>
@@ -111,4 +110,3 @@ * the OS template files, the hardest part is decide the correct and efficient
* way to implement the context switching.
*/
-/** @} */
diff --git a/docs/src/saveram.dox b/docs/src/saveram.dox index 7a1f6f662..6682fe0fe 100644 --- a/docs/src/saveram.dox +++ b/docs/src/saveram.dox @@ -19,7 +19,6 @@ /**
* @page article_saveram Saving RAM by declaring thread functions "noreturn"
- * @{
* One of the problems, when writing embedded multi-threaded applications,
* is that the thread functions do save the registers in the function
* entry code even if the system does not require it, exiting such
@@ -80,4 +79,3 @@ main() { * need to save registers. The code will be a bit less readable and less
* portable on other compilers however.
*/
-/** @} */
diff --git a/docs/src/stacks.dox b/docs/src/stacks.dox index a27c2e1b9..6035e1277 100644 --- a/docs/src/stacks.dox +++ b/docs/src/stacks.dox @@ -19,7 +19,6 @@ /**
* @page article_stacks Stacks and stack sizes
- * @{
* In a RTOS like ChibiOS/RT there are several dedicated stacks, each stack
* has a dedicated RAM space that must have a correctly sized assigned area.
* <h2>The stacks</h2>
@@ -104,4 +103,3 @@ * end of your development cycle.
* .
*/
-/** @} */
diff --git a/docs/src/timing.dox b/docs/src/timing.dox index 9e013c412..a09db8575 100644 --- a/docs/src/timing.dox +++ b/docs/src/timing.dox @@ -19,7 +19,6 @@ /**
* @page article_timing Reliable timings using Threads
- * @{
* One common task is to have threads do something at regular, scheduled,
* intervals.
* An obvious solution is to write something like this:
@@ -58,4 +57,3 @@ msg_t my_thread(void *param) { * deadline time and the error will not accumulate over time regardless of
* the execution time and delays inserted by other threads.
*/
-/** @} */
|