Doc comment maintenance

Fixed doc comments issues:

* Fixed mistyped param doc comments (`/**<` is OK, `/** <` is not).

* Put special characters (e.g., pipe, backslash, etc.) in quotes, as they can
  confuse doxygen and it will print lots of various warnings. For the sake of
  completeness and consistent style, also quote some special characters in
  re-bytecode.h

* Added missing `@{`s, removed extra `@}`s.

* Turned `/*` comments to `/**<` doc comments.

Ensured same style for doc groups everywhere:

* Where `\addtogroup`, `@{`, and `@}` doxygen commands are used, the order to be
  followed is: license, `#ifndef` guards (in headers), includes, `\addtogroup`
  and `@{`, main code content, `@}`, `#endif` guards (in headers).

* Multiple `\addtogroup`s or multiple `@}`s should be in the same doc comment.

* First `\addtogroup` should be on the very first line of a doc comment, i.e.,
  `/** \addtogroup`.

JerryScript-DCO-1.0-Signed-off-by: Akos Kiss akiss@inf.u-szeged.hu
This commit is contained in:
Akos Kiss
2016-04-09 21:27:43 +02:00
parent a7f015ef47
commit 9aca0086b9
34 changed files with 177 additions and 214 deletions
-1
View File
@@ -25,7 +25,6 @@
#include "mem-poolman.h"
#define MEM_ALLOCATOR_INTERNAL
#include "mem-allocator-internal.h"
/**
+6 -6
View File
@@ -13,10 +13,6 @@
* limitations under the License.
*/
/** \addtogroup mem Memory allocation
* @{
*/
/**
* Allocator interface
*/
@@ -28,6 +24,10 @@
#include "mem-heap.h"
#include "mem-poolman.h"
/** \addtogroup mem Memory allocation
* @{
*/
/**
* Compressed pointer
*/
@@ -125,8 +125,8 @@ extern void mem_stats_reset_peak (void);
extern void mem_stats_print (void);
#endif /* MEM_STATS */
#endif /* !MEM_ALLOCATOR_H */
/**
* @}
*/
#endif /* !MEM_ALLOCATOR_H */
+7 -8
View File
@@ -14,13 +14,6 @@
* limitations under the License.
*/
/** \addtogroup mem Memory allocation
* @{
*
* \addtogroup heap Heap
* @{
*/
/**
* Heap implementation
*/
@@ -33,9 +26,15 @@
#include "mem-heap.h"
#define MEM_ALLOCATOR_INTERNAL
#include "mem-allocator-internal.h"
/** \addtogroup mem Memory allocation
* @{
*
* \addtogroup heap Heap
* @{
*/
/*
* Valgrind-related options and headers
*/
+6 -7
View File
@@ -14,13 +14,6 @@
* limitations under the License.
*/
/** \addtogroup mem Memory allocation
* @{
*
* \addtogroup heap Heap
* @{
*/
/**
* Heap allocator interface
*/
@@ -29,6 +22,12 @@
#include "jrt.h"
/** \addtogroup mem Memory allocation
* @{
*
* \addtogroup heap Heap
* @{
*/
extern void mem_heap_init (void);
extern void mem_heap_finalize (void);
+7 -9
View File
@@ -14,13 +14,6 @@
* limitations under the License.
*/
/** \addtogroup mem Memory allocation
* @{
*
* \addtogroup poolman Memory pool manager
* @{
*/
/**
* Memory pool manager implementation
*/
@@ -34,6 +27,13 @@
#define MEM_ALLOCATOR_INTERNAL
#include "mem-allocator-internal.h"
/** \addtogroup mem Memory allocation
* @{
*
* \addtogroup poolman Memory pool manager
* @{
*/
/**
* Node for free chunk list
*/
@@ -308,7 +308,5 @@ mem_pools_stat_dealloc (void)
/**
* @}
*/
/**
* @}
*/
+12 -16
View File
@@ -14,14 +14,6 @@
* limitations under the License.
*/
/** \addtogroup mem Memory allocation
* @{
*/
/** \addtogroup poolman Memory pool manager
* @{
*/
/**
* Pool manager interface
*/
@@ -30,6 +22,13 @@
#include "jrt.h"
/** \addtogroup mem Memory allocation
* @{
*
* \addtogroup poolman Memory pool manager
* @{
*/
extern void mem_pools_init (void);
extern void mem_pools_finalize (void);
extern void *mem_pools_alloc (void);
@@ -66,12 +65,9 @@ extern void mem_pools_stats_reset_peak (void);
extern void mem_pools_stats_print (void);
#endif /* MEM_STATS */
/**
* @}
* @}
*/
#endif /* !MEM_POOLMAN_H */
/**
* @}
*/
/**
* @}
*/