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
Sometimes I want to group common functions together and provide an overview of these functions. Example is Logger. All the functions (log, log_warning, log_error, etc) all have the same APIs. A brief description for all of them is warranted.
Currently the only way to do this is put all the "general" documentation in the first API call. Instead I'd like the ability to add a level "higher" than a function.
The TOC should look like this:
Types
Constants
Main Logger Functions
log
log_warning
...
Utility Functions
to_char
etc...
The documentation would look like this:
...
Main Logger Functions
Some full description along with examples (no special tags)
Sometimes I want to group common functions together and provide an overview of these functions. Example is Logger. All the functions (
log
,log_warning
,log_error
,etc
) all have the same APIs. A brief description for all of them is warranted.Currently the only way to do this is put all the "general" documentation in the first API call. Instead I'd like the ability to add a level "higher" than a function.
The TOC should look like this:
log
log_warning
to_char
etc...
The documentation would look like this:
...
Main Logger Functions
Some full description along with examples (no special tags)
log
...
Some things to think of:
@header
)?The text was updated successfully, but these errors were encountered: