memarray: fixed formatting and typos

tobhe · moenoel · commit dad52dc2923d · 2018-03-13T15:42:46.000+01:00
diff --git a/sys/include/memarray.h b/sys/include/memarray.h
@@ -34,6 +34,7 @@ typedef struct {
 
 /**
  * @brief Define static memory pool
+ *
  * @param[out] name    name for defined memarray pool
  * @param[in]  size    size of single memory chunk
  * @param[in]  num     number of chunks in pool
@@ -44,6 +45,7 @@ typedef struct {
 
 /**
  * @brief Initialize memarray pool with free list
+ *
  * @param[out]  mem     memarray pool to initialize
  * @param[in]   size    size of single memory chunk
  * @param[in]   num     number of chunks in pool
@@ -52,14 +54,16 @@ void memarray_init(memarray_t *mem, size_t num, size_t size);
 
 /**
  * @brief Allocate memory chunk in memarray pool
+ *
  * @param[in,out]  mem      memarray pool to allocate block in
- * @return pointer to newly allocated memarray chunk
+ *
  * @return NULL on failure
  */
 void *memarray_alloc(memarray_t *mem);
 
 /**
  * @brief Free memory chunk in memarray pool
+ *
  * @param[in,out]  mem      memarray pool to free block in
  * @param[in]      ptr      pointer to memarray chunk
  */
diff --git a/sys/memarray/memarray.c b/sys/memarray/memarray.c
@@ -21,7 +21,7 @@ void *memarray_alloc(memarray_t *mem)
 
 void memarray_init(memarray_t *mem, size_t size, size_t num)
 {
-    for (size_t i = 0; i < num - 1; i++) {
+    for (size_t i = 0; i < (num - 1); i++) {
         void *next = ((char *)mem->first_free) + ((i + 1) * size);
         memcpy(((char *)mem->first_free) + (i * size), &next, sizeof(void *));
     }
diff --git a/tests/memarray/Makefile b/tests/memarray/Makefile
@@ -8,9 +8,4 @@ USEMODULE += memarray
 USEMODULE += shell_commands
 USEMODULE += ps
 
-# Comment this out to disable code in RIOT that does safety checking
-# which is not needed in a production environment but helps in the
-# development process:
-CFLAGS += -DDEVELHELP
-
 include $(RIOTBASE)/Makefile.include
diff --git a/tests/memarray/README.md b/tests/memarray/README.md
@@ -11,7 +11,7 @@ This test is passed if the memory used by the main thread remains static.
 Background
 ==========
 
-The module `memarray` is the static memory allocator for RIOT O.S.
+The module `memarray` is the static memory allocator for RIOT-OS
 
 This test application is therefore specialized for only testing the use of the module.
 
diff --git a/tests/memarray/main.c b/tests/memarray/main.c
@@ -25,9 +25,9 @@
 
 #include "memarray.h"
 
-#define MAX_NUMBER_BLOCKS 10
-#define MESSAGE_SIZE 8
-#define NUMBER_OF_TESTS 12
+#define MAX_NUMBER_BLOCKS    (10U)
+#define MESSAGE_SIZE         (8U)
+#define NUMBER_OF_TESTS      (12U)
 
 extern int _ps_handler(int argc, char **argv);
 
@@ -40,7 +40,6 @@ struct block_t {
 
 MEMARRAY(block_storage, sizeof(struct block_t), MAX_NUMBER_BLOCKS)
 
-
 int total = 0;
 
 static void memory_block_init(void)
@@ -76,7 +75,6 @@ void free_memory(struct block_t *head)
     struct block_t *old;
 
     while (head) {
-
         total -= sizeof(struct block_t);
         printf("\tFree (%i) %d Bytes at 0x%p, total %d\n", \
                head->number, sizeof(struct block_t), (void *)head, total);
@@ -96,7 +94,6 @@ void free_memory(struct block_t *head)
 
 int main(void)
 {
-
     memory_block_init();
     int count = 0;
 

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ void memarray_alloc(memarray_t mem)`
`21`	`21`
`22`	`22`	`void memarray_init(memarray_t *mem, size_t size, size_t num)`
`23`	`23`	`{`
`24`		`- for (size_t i = 0; i < num - 1; i++) {`
	`24`	`+ for (size_t i = 0; i < (num - 1); i++) {`
`25`	`25`	`void next = ((char )mem->first_free) + ((i + 1) * size);`
`26`	`26`	`memcpy(((char )mem->first_free) + (i size), &next, sizeof(void *));`
`27`	`27`	`}`