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

Doxygen Refresh #35

Open
jackoalan opened this issue Aug 31, 2015 · 3 comments
Open

Doxygen Refresh #35

jackoalan opened this issue Aug 31, 2015 · 3 comments
Labels
enhancement releaseblocker
Milestone
2.5.0

Comments

@jackoalan
Copy link
Member

Athena has changed considerably since the doxygen comments were last updated.
Several APIs (notably the DNA and YAML classes) have no docs at all.

This issue tracks the refresh/update of these docs starting from 2.4.0 release.
@jackoalan jackoalan added this to the 2.5.0 milestone Aug 31, 2015
@Antidote
Copy link
Member

We should start by documenting the DNA structs, since those are completely devoid of them. Then we'll use that as our new document standard.

@jackoalan
Copy link
Member Author

Agreed, we can also fill up the org's Jekyll site with usage examples

@Antidote
Copy link
Member

Yeah, Jekyll should provide usage examples, while the doxygen should simply document use cases in general.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement releaseblocker
Projects
None yet
Milestone
2.5.0
Development

No branches or pull requests
2 participants
@jackoalan @Antidote