Documentation reorganization.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1133 35acf78f-673a-0410-8e92-d51de3d6d3f4

10 files changed, 25 insertions, 34 deletions

diff --git a/test/testdyn.c b/test/testdyn.c
index a7c685623..44e6ffaa4 100644
--- a/test/testdyn.c
+++ b/test/testdyn.c
@@ -29,8 +29,7 @@
  * APIs.

  *

  * <h2>Objective</h2>

- * Objective of the test module is to cover 100% of the dynamic APIs code

- * as a necessary step in order to assess their maturity.

+ * Objective of the test module is to cover 100% of the dynamic APIs code.

  *

  * <h2>Preconditions</h2>

  * The module requires the following kernel options:

diff --git a/test/testevt.c b/test/testevt.c
index 3eb3d71b3..eb7e9275c 100644
--- a/test/testevt.c
+++ b/test/testevt.c
@@ -25,11 +25,10 @@
  * @page test_events Events test

  *

  * <h2>Description</h2>

- * This module implements the test sequence for the @ref Events subsystem.

+ * This module implements the test sequence for the @ref events subsystem.

  *

  * <h2>Objective</h2>

- * Objective of the test module is to cover 100% of the @ref Events subsystem

- * code as a necessary step in order to assess its maturity level.

+ * Objective of the test module is to cover 100% of the @ref events subsystem.

  *

  * <h2>Preconditions</h2>

  * The module requires the following kernel options:

diff --git a/test/testheap.c b/test/testheap.c
index 3a684f415..6e68c11be 100644
--- a/test/testheap.c
+++ b/test/testheap.c
@@ -25,11 +25,10 @@
  * @page test_heap Memory Heap test

  *

  * <h2>Description</h2>

- * This module implements the test sequence for the @ref Heap subsystem.

+ * This module implements the test sequence for the @ref heap subsystem.

  *

  * <h2>Objective</h2>

- * Objective of the test module is to cover 100% of the @ref Heap subsystem

- * code as a necessary step in order to assess its maturity level.

+ * Objective of the test module is to cover 100% of the @ref heap subsystem.

  *

  * <h2>Preconditions</h2>

  * The module requires the following kernel options:

diff --git a/test/testmbox.c b/test/testmbox.c
index a485c3a4e..96cf543ce 100644
--- a/test/testmbox.c
+++ b/test/testmbox.c
@@ -25,13 +25,12 @@
  * @page test_mbox Mailboxes test

  *

  * <h2>Description</h2>

- * This module implements the test sequence for the @ref Mailboxes subsystem.

+ * This module implements the test sequence for the @ref mailboxes subsystem.

  *

  * <h2>Objective</h2>

- * Objective of the test module is to cover 100% of the @ref Mailboxes

- * subsystem code as a necessary step in order to assess its maturity

- * level.<br>

- * Note that the @ref Mailboxes subsystem depends on the @ref Semaphores

+ * Objective of the test module is to cover 100% of the @ref mailboxes

+ * subsystem code.<br>

+ * Note that the @ref mailboxes subsystem depends on the @ref semaphores

  * subsystem that has to met its testing objectives as well.

  *

  * <h2>Preconditions</h2>

diff --git a/test/testmsg.c b/test/testmsg.c
index a44686ba6..015639d16 100644
--- a/test/testmsg.c
+++ b/test/testmsg.c
@@ -25,11 +25,11 @@
  * @page test_msg Messages test

  *

  * <h2>Description</h2>

- * This module implements the test sequence for the @ref Messages subsystem.

+ * This module implements the test sequence for the @ref messages subsystem.

  *

  * <h2>Objective</h2>

- * Objective of the test module is to cover 100% of the @ref Messages

- * subsystem code as a necessary step in order to assess its maturity level.

+ * Objective of the test module is to cover 100% of the @ref messages

+ * subsystem code.

  *

  * <h2>Preconditions</h2>

  * The module requires the following kernel options:

diff --git a/test/testmtx.c b/test/testmtx.c
index 6027aca7e..368b98fd9 100644
--- a/test/testmtx.c
+++ b/test/testmtx.c
@@ -25,14 +25,13 @@
  * @page test_mtx Mutexes test

  *

  * <h2>Description</h2>

- * This module implements the test sequence for the @ref Mutexes and

- * @ref CondVars subsystems.<br>

+ * This module implements the test sequence for the @ref mutexes and

+ * @ref condvars subsystems.<br>

  * Tests on those subsystems are particularly critical because the system-wide

  * implications of the Priority Inheritance mechanism.

  *

  * <h2>Objective</h2>

- * Objective of the test module is to cover 100% of the subsystem code

- * as a necessary step in order to assess their maturity level.

+ * Objective of the test module is to cover 100% of the subsystems code.

  *

  * <h2>Preconditions</h2>

  * The module requires the following kernel options:

diff --git a/test/testpools.c b/test/testpools.c
index ce6716444..97356126e 100644
--- a/test/testpools.c
+++ b/test/testpools.c
@@ -25,11 +25,10 @@
  * @page test_pools Memory Pools test

  *

  * <h2>Description</h2>

- * This module implements the test sequence for the @ref MemoryPools subsystem.

+ * This module implements the test sequence for the @ref pools subsystem.

  *

  * <h2>Objective</h2>

- * Objective of the test module is to cover 100% of the @ref MemoryPools

- * code as a necessary step in order to assess its maturity level.<br>

+ * Objective of the test module is to cover 100% of the @ref pools code.

  *

  * <h2>Preconditions</h2>

  * The module requires the following kernel options:

diff --git a/test/testqueues.c b/test/testqueues.c
index fe79712eb..aff42334c 100644
--- a/test/testqueues.c
+++ b/test/testqueues.c
@@ -25,15 +25,14 @@
  * @page test_queues I/O Queues test

  *

  * <h2>Description</h2>

- * This module implements the test sequence for the @ref IOQueues subsystem.

+ * This module implements the test sequence for the @ref io_queues subsystem.

  * The tests are performed by inserting and removing data from queues and by

  * checking both the queues status and the correct sequence of the extracted

  * data.

  *

  * <h2>Objective</h2>

- * Objective of the test module is to cover 100% of the @ref IOQueues code

- * as a necessary step in order to assess its maturity level.<br>

- * Note that the @ref IOQueues subsystem depends on the @ref Semaphores

+ * Objective of the test module is to cover 100% of the @ref io_queues code.<br>

+ * Note that the @ref io_queues subsystem depends on the @ref semaphores

  * subsystem that has to met its testing objectives as well.

  *

  * <h2>Preconditions</h2>

diff --git a/test/testsem.c b/test/testsem.c
index 46c6a7941..77025fc71 100644
--- a/test/testsem.c
+++ b/test/testsem.c
@@ -25,11 +25,10 @@
  * @page test_sem Semaphores test

  *

  * <h2>Description</h2>

- * This module implements the test sequence for the @ref Semaphores subsystem.

+ * This module implements the test sequence for the @ref semaphores subsystem.

  *

  * <h2>Objective</h2>

- * Objective of the test module is to cover 100% of the @ref Semaphores

- * code as a necessary step in order to assess its maturity level.<br>

+ * Objective of the test module is to cover 100% of the @ref semaphores code.

  *

  * <h2>Preconditions</h2>

  * The module requires the following kernel options:

diff --git a/test/testthd.c b/test/testthd.c
index 2758e5223..bc9b40cd1 100644
--- a/test/testthd.c
+++ b/test/testthd.c
@@ -25,15 +25,14 @@
  * @page test_threads Threads and Scheduler test

  *

  * <h2>Description</h2>

- * This module implements the test sequence for the @ref Scheduler,

- * @ref Threads and @ref Time subsystems.<br>

+ * This module implements the test sequence for the @ref scheduler,

+ * @ref threads and @ref time subsystems.<br>

  * Note that the tests on those subsystems are formally required but most of

  * their functionality is already demonstrated because the test suite itself

  * depends on them, anyway double check is good.

  *

  * <h2>Objective</h2>

- * Objective of the test module is to cover 100% of the subsystems code

- * as a necessary step in order to assess their maturity level.

+ * Objective of the test module is to cover 100% of the subsystems code.

  *

  * <h2>Preconditions</h2>

  * None.