diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-05-09 16:46:49 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-05-09 16:46:49 +0000 |
| commit | 83d50f08219d05f65b55f686e74e5cb4e7352092 (patch) | |
| tree | a7739c63144965ec54fbab9f0551b5b4ad84e151 /test/testpools.c | |
| parent | a6feec221cd3050e0f2d56950abd39677790d79f (diff) | |
| download | ChibiOS-83d50f08219d05f65b55f686e74e5cb4e7352092.tar.gz ChibiOS-83d50f08219d05f65b55f686e74e5cb4e7352092.tar.bz2 ChibiOS-83d50f08219d05f65b55f686e74e5cb4e7352092.zip | |
Finished adding tests documentation to the general documentation.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@963 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'test/testpools.c')
| -rw-r--r-- | test/testpools.c | 37 |
1 files changed, 36 insertions, 1 deletions
diff --git a/test/testpools.c b/test/testpools.c index abf63d700..78f19a91c 100644 --- a/test/testpools.c +++ b/test/testpools.c @@ -21,13 +21,48 @@ #include "test.h"
+/**
+ * @page test_pools Memory Pools test
+ *
+ * <h2>Description</h2>
+ * This module implements the test sequence for the @ref MemoryPools 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>
+ *
+ * <h2>Preconditions</h2>
+ * The module requires the following kernel options:
+ * - @p CH_USE_MEMPOOLS
+ * .
+ * In case some of the required options are not enabled then some or all tests
+ * may be skipped.
+ *
+ * <h2>Test Cases</h2>
+ * - @subpage test_pools_001
+ * .
+ * @file testpools.c
+ * @brief Memory Pools test source file
+ * @file testpools.h
+ * @brief Memory Pools test header file
+ */
+
#if CH_USE_MEMPOOLS
static MemoryPool mp1;
+/**
+ * @page test_pools_001 Allocation and enqueuing test
+ *
+ * <h2>Description</h2>
+ * Five memory blocks are added to a memory pool then removed.<br>
+ * The test expects to find the pool queue in the proper status after each
+ * operation.
+ */
+
static char *pools1_gettest(void) {
- return "Memory Pools, allocation and enqueuing test";
+ return "Memory Pools, queue/dequeue";
}
static void pools1_setup(void) {
|