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:
@@ -14,13 +14,6 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/** \addtogroup ecma ECMA
|
||||
* @{
|
||||
*
|
||||
* \addtogroup ecmahelpers Helpers for operations with ECMA data types
|
||||
* @{
|
||||
*/
|
||||
|
||||
#include "ecma-alloc.h"
|
||||
#include "ecma-gc.h"
|
||||
#include "ecma-globals.h"
|
||||
@@ -34,6 +27,13 @@
|
||||
#include "lit-literal-storage.h"
|
||||
#include "vm.h"
|
||||
|
||||
/** \addtogroup ecma ECMA
|
||||
* @{
|
||||
*
|
||||
* \addtogroup ecmahelpers Helpers for operations with ECMA data types
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* Maximum length of strings' concatenation
|
||||
*/
|
||||
@@ -745,11 +745,11 @@ ecma_string_get_heap_number_size (mem_cpointer_t number_cp) /**< Compressed poin
|
||||
* NULL - otherwise
|
||||
*/
|
||||
const lit_utf8_byte_t *
|
||||
ecma_string_raw_chars (const ecma_string_t *string_p, /* ecma-string */
|
||||
lit_utf8_size_t *size_p, /* [out] size of the ecma string */
|
||||
bool *is_ascii_p) /* [out] true, if the string is an ascii
|
||||
* character sequence (size == length)
|
||||
* false, otherwise */
|
||||
ecma_string_raw_chars (const ecma_string_t *string_p, /**< ecma-string */
|
||||
lit_utf8_size_t *size_p, /**< [out] size of the ecma string */
|
||||
bool *is_ascii_p) /**< [out] true, if the string is an ascii
|
||||
* character sequence (size == length)
|
||||
* false, otherwise */
|
||||
{
|
||||
ecma_length_t length;
|
||||
lit_utf8_size_t size;
|
||||
|
||||
Reference in New Issue
Block a user