You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
There is the following warning in section command's documentation:
In our coding convention, it is recommended to be used for error codes documentation:
@section errors_section Errors
) to document thepossible errors. Use
man 2 write
as an example for a good errors section.I found one usage of
@section
incelix_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.
The text was updated successfully, but these errors were encountered: