diff options
| author | Máté Tokodi <mate.tokodi@szteszoftver.hu> | 2023-11-15 09:49:04 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-15 09:49:04 +0100 |
| commit | ff9ff8f36c967890b5ebb240d9fa90d6e351aa01 (patch) | |
| tree | 30441be6d50401d92ccbde9db18b1ff7aa0a5a2b /jerry-core/api/jerry-snapshot.c | |
| parent | bc408b159b9de16cb3b8fe84f683c561e2d26000 (diff) | |
Update doxygen and fix documentation (#5106)
Update Doxyfile to version 1.9.1
Re-enable doxygen CI checker
Fix some regular comments that should have been doc comments
Document void return types for some inline functions explicitly
Move start of some doxygen groups so they are included always, and not left
out of certain ifdefs
Ignore some doxygen warnings:
Member (function) is not documented in headers
Documented empty return type in headers
Argument has multiple @param documentation sections
JerryScript-DCO-1.0-Signed-off-by: Máté Tokodi mate.tokodi@szteszoftver.hu
Diffstat (limited to 'jerry-core/api/jerry-snapshot.c')
| -rw-r--r-- | jerry-core/api/jerry-snapshot.c | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/jerry-core/api/jerry-snapshot.c b/jerry-core/api/jerry-snapshot.c index 35478e4b..924dae86 100644 --- a/jerry-core/api/jerry-snapshot.c +++ b/jerry-core/api/jerry-snapshot.c @@ -31,6 +31,10 @@ #include "lit-char-helpers.h" #include "re-compiler.h" +/** \addtogroup jerrysnapshot Jerry snapshot operations + * @{ + */ + #if JERRY_SNAPSHOT_SAVE || JERRY_SNAPSHOT_EXEC /** @@ -88,9 +92,6 @@ typedef struct bool class_found; } snapshot_globals_t; -/** \addtogroup jerrysnapshot Jerry snapshot operations - * @{ - */ /** * Write data into the specified buffer. @@ -1045,10 +1046,6 @@ jerry_exec_snapshot (const uint32_t *snapshot_p, /**< snapshot */ #endif /* JERRY_SNAPSHOT_EXEC */ } /* jerry_exec_snapshot */ -/** - * @} - */ - #if JERRY_SNAPSHOT_SAVE /** @@ -1716,3 +1713,7 @@ jerry_get_literals_from_snapshot (const uint32_t *snapshot_p, /**< input snapsho return 0; #endif /* JERRY_SNAPSHOT_SAVE */ } /* jerry_get_literals_from_snapshot */ + +/** + * @} + */ |