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

Extract documentation to HTML #2

Open
tsahi opened this issue Jan 4, 2020 · 0 comments
Open

Extract documentation to HTML #2

tsahi opened this issue Jan 4, 2020 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed P2 Priority 2

Comments

@tsahi
Copy link
Owner

tsahi commented Jan 4, 2020

Is your feature request related to a problem? Please describe.
The code contains API documentation. We should extract this documentation to HTML and post it on a web site, such as on github.io.

Describe the solution you'd like
To alternatives I know of:

  1. Doxygen
  2. Sandcastle

Both can produce decent HTML, but Doxygen is much faster, because it extracts the text from the source, while Sandcastle reflects on the binaries.

Describe alternatives you've considered
The API documentation of the latest release is available at https://docs.microsoft.com/en-us/previous-versions/msp-n-p/dn170426(v=pandp.60), but as we add new functionality, we will need to have an updated version.

@tsahi tsahi added enhancement New feature or request help wanted Extra attention is needed P2 Priority 2 labels Jan 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed P2 Priority 2
Projects
None yet
Development

No branches or pull requests

1 participant