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

Incorrect usage of @section in Doxygen documentation? #680

Open
PengZheng opened this issue Oct 30, 2023 · 0 comments
Open

Incorrect usage of @section in Doxygen documentation? #680

PengZheng opened this issue Oct 30, 2023 · 0 comments

Comments

@PengZheng
Copy link
Contributor

PengZheng commented Oct 30, 2023

There is the following warning in section command's documentation:

This command only works inside related page documentation and not in other documentation blocks!

In our coding convention, it is recommended to be used for error codes documentation:

  • If a function can return multiple error codes, use a errors section (@section errors_section Errors) to document the
    possible errors. Use man 2 write as an example for a good errors section.

I found one usage of @section in celix_threads.h, and checked our online documentation. Unfortunately, utils library is not included in the documentation.
I'm not sure whether the current usage is correct and can produce the intended documentation.

PS: Currently I am working on Celix documentation translation so that it can be used for some internal training program in my day job. I'll go back to this issue after the translation is complete.

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

No branches or pull requests

1 participant