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.

Sign up for GitHub

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

Jump to bottom

Include version in API reference documentation #8

Closed
ap0llo opened this issue Dec 29, 2019 · 0 comments · Fixed by #52
Closed

Include version in API reference documentation #8

ap0llo opened this issue Dec 29, 2019 · 0 comments · Fixed by #52
Labels
area-apireference feature New feature or request

Comments

@ap0llo
Copy link
Owner

ap0llo commented Dec 29, 2019

  • For generated commandline reference, the version of the application is already included in the documentation. It should also be included in API reference documentation.
  • Just like for commandline reference, there should be a --no-version commandline switch to prevent version from being included
@ap0llo ap0llo changed the title [apireference]: Include version in documentation Include version in documentation Dec 29, 2019
@ap0llo ap0llo changed the title Include version in documentation Include version in API reference documentation Dec 29, 2019
@ap0llo ap0llo mentioned this issue Jun 6, 2020
Merged
3 tasks
@ap0llo ap0llo closed this as completed in #52 Jun 7, 2020
ap0llo added a commit that referenced this issue Jun 7, 2020
@ap0llo
feat(apireference): Include assembly version in generated API Referen…
a552945 
…ce documentation

By default, include the assembly version in the generated API reference documentation on pages for types and type members. Additionally, the documentation for type members will now also include the namespace and assembly name of the declaring type.

The inclusion of the assembly version can be disabled in the configuration file or using the '--no-version' command line switch of the 'apireference' command (analogous to the 'commandlinehelp' command).

Closes: #8
Pull-Request: #52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area-apireference feature New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add assembly version to API Reference documentation ap0llo/mddocs
1 participant
@ap0llo