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

Clean up Comments - Switch to YARDoc #24

Closed
mdaines-r7 opened this issue Sep 6, 2012 · 1 comment
Closed

Clean up Comments - Switch to YARDoc #24

mdaines-r7 opened this issue Sep 6, 2012 · 1 comment

Comments

@mdaines-r7
Copy link
Contributor

Adjust the comments throughout the code to produce useful RDoc. For example, if you visit the gem page (i.e., through http://rubygems.org/gems/nexpose), there is no clear starting point, and it isn't clear that many of the useful methods are actually exposed through the Nexpose::NexposeAPI module's documentation.

When adding new documentation, covert to using YARDoc style.

@mdaines-r7
Copy link
Contributor Author

This is mostly done. As methods get touched, comments are added.

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

No branches or pull requests

1 participant