Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update doxygen #5106

Merged
merged 1 commit into from
Nov 15, 2023
Merged

Conversation

matetokodi
Copy link
Contributor

@matetokodi matetokodi commented Oct 25, 2023

This patch depends on #5096

In this patch:

  • 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 functions explicitly
  • Move start of some doxygen groups so they are included always, and not left out of certain ifdefs
  • Sync mismatched doc comments between some headers and c files
  • Ignore some doxygen warnings:
    • Member (function) is not documented in headers
    • Documented empty return type in headers

@matetokodi matetokodi force-pushed the update_doxygen branch 2 times, most recently from 6e283fe to 72d8816 Compare October 25, 2023 15:35
@matetokodi matetokodi marked this pull request as ready for review October 26, 2023 12:25
Copy link
Member

@zherczeg zherczeg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

jerry-port/common/jerry-port-io.c Outdated Show resolved Hide resolved
jerry-port/common/jerry-port-context.c Outdated Show resolved Hide resolved
jerry-core/jmem/jmem-heap.c Show resolved Hide resolved
/** \addtogroup ecma ECMA
* @{
*
* \addtogroup ecmabuiltinhelpers ECMA builtin helper operations
* @{
*/

#if JERRY_BUILTIN_JSON

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel this change (or these changes) somewhat arbitrary. There are lots of such C files, e.g., in the builtin-objects directory, that use the #if-@{-@}-#endif structure. This file used the #if-@{-#endif-@} pattern, which of course needs to be fixed, but I am not sure whether the @{-#if-#endif-@} structure is the way to go. But if we go that way, we should apply it consistently throughout the whole codebase.

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
Copy link
Member

@akosthekiss akosthekiss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@akosthekiss akosthekiss merged commit ff9ff8f into jerryscript-project:master Nov 15, 2023
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants