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

document and improve the generated documentation process #31

Open
aoberoi opened this issue Feb 7, 2015 · 1 comment
Open

document and improve the generated documentation process #31

aoberoi opened this issue Feb 7, 2015 · 1 comment

Comments

@aoberoi
Copy link
Contributor

aoberoi commented Feb 7, 2015

  • We should be using the XML Generated docs so that Visual Studio can power Intellisense completions.
  • The simplest option for generating HTML docs from an assemble and the XML Generated docs would be docu. The most robust solution seems to be Sandcastle, but its known to be difficult to use/configure.
  • Formatting https://msdn.microsoft.com/en-us/library/vstudio/b2s063f7(v=vs.100).aspx
@aoberoi
Copy link
Contributor Author

aoberoi commented Feb 8, 2015

the title of this issue is confusing, but i meant what i said. particularly, i want to not only revise the process of generating documentation, but also document the process itself in DEVELOPING.md.

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