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

Add ability to add "Sections" in code #75

Open
2 tasks
martindsouza opened this issue May 23, 2018 · 0 comments
Open
2 tasks

Add ability to add "Sections" in code #75

martindsouza opened this issue May 23, 2018 · 0 comments

Comments

@martindsouza
Copy link
Member

martindsouza commented May 23, 2018

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)

log

...

Some things to think of:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant