diff options
| author | Akos Kiss <akiss@inf.u-szeged.hu> | 2016-02-16 18:11:33 +0100 |
|---|---|---|
| committer | Akos Kiss <akiss@inf.u-szeged.hu> | 2016-02-16 21:05:58 +0100 |
| commit | 0d7ea70b41bc1b097c6e3e0c29317c0bbf581e4c (patch) | |
| tree | dc1808584951ac836752cc32bb972c54f2c3d74d /jerry-core/ecma/builtin-objects/ecma-builtin-global.c | |
| parent | ed12df5c8d18b6c6c1073cf79ca7acb3972d6620 (diff) | |
Eliminating doxygen warnings by fixing the documentation
* Fix "end of file while inside a group" doxygen warnings.
* Fix "unknown command" doxygen warnings caused by incorrect
argument references. Instead of `@foo`, `@a foo` is the proper
format.
* Fix "unknown command" doxygen warnings caused by incorrect
parameter direction specifications. Instead of `@in`, `@out`,
and `@in-out`, `[in]`, `[out]`, and `[in,out]` are the proper
formats.
* Wrapping special characters in quotes to avoid doxygen
confusion. Raw pipe, semicolon, dot, backslash, etc. characters
can drive doxygen into various misinterpretations and warnings.
E.g.:
```
End of list marker found without any preceding list items
Found unknown command
```
Putting quotes around such text snipets eliminates the errors.
* Fix the documentation of `ecma_builtin_global_object_print`. Raw
<> and \ sequences confused doxygen in various ways (it tried to
interpret them as XML tags and doxygen commands).
* Fix "ignoring title that does not match old title" doxygen
warnings. At some places, the group titles were out of sync, at
others, the group names were incorrect.
* Fix "parameters are not documented" doxygen warnings. Fixing
various typos in the inline parameter documentations (`/*`,
`/**`, `/** <`, and `/**>` are all considered incorrect, the
right format is `/**<`).
JerryScript-DCO-1.0-Signed-off-by: Akos Kiss akiss@inf.u-szeged.hu
Diffstat (limited to 'jerry-core/ecma/builtin-objects/ecma-builtin-global.c')
| -rw-r--r-- | jerry-core/ecma/builtin-objects/ecma-builtin-global.c | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/jerry-core/ecma/builtin-objects/ecma-builtin-global.c b/jerry-core/ecma/builtin-objects/ecma-builtin-global.c index f91e04f2..28f7e84b 100644 --- a/jerry-core/ecma/builtin-objects/ecma-builtin-global.c +++ b/jerry-core/ecma/builtin-objects/ecma-builtin-global.c @@ -53,8 +53,8 @@ * * The routine converts all of its arguments to strings and outputs them using 'printf'. * - * Code points, with except of <NUL> character, that are representable with one utf8-byte - * are outputted as is, using '%c' format argument, and other code points are outputted as '\uhhll', + * Code points, with except of NUL character, that are representable with one utf8-byte + * are outputted as is, using "%c" format argument, and other code points are outputted as "\uhhll", * where hh and ll are values of code point's high and low bytes, correspondingly. * * @return completion value |