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

Adding options to configure the documentation output #16

Open
rtopfer opened this issue Jun 22, 2020 · 0 comments
Open

Adding options to configure the documentation output #16

rtopfer opened this issue Jun 22, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@rtopfer
Copy link
Contributor

rtopfer commented Jun 22, 2020

As it stands, Documentor will include pretty much all the available info; however, incorporating more options (by means of a parameters struct input to Documentor, or a config (e.g. json) file, or...) would be useful. For instance to:

  1. have the option of writing simplified 'user' documentation

    • e.g. a boolean parameter—isDetailed—is currently among the only supported options, which includes/excludes hidden methods & attributes in the printed output)
  2. or (in the other direction) include implementation details

  3. generate an overview/table of contents file consisting of the code names and the summary header line.

    • This might be similar to MATLAB's Contents.m files, or the displayed return from lookfor
      e.g. see
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant