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

Add Doxygen (Developer) Documentation #5

Closed
tzanio opened this issue Dec 11, 2017 · 2 comments
Closed

Add Doxygen (Developer) Documentation #5

tzanio opened this issue Dec 11, 2017 · 2 comments
Assignees
@jedbrown
Labels
documentation
Milestone
Initial Release (...

Comments

@tzanio
Copy link
Member

tzanio commented Dec 11, 2017

Document fully the structures and functions in the code using Doxygen, see e.g.

https://github.com/CEED/libCEED/blob/master/ceed-impl.h#L101-L147
@tzanio tzanio changed the title Add Doxygen Documentation Add Doxygen (Developer) Documentation Dec 11, 2017
@tzanio tzanio added this to the Initial Release milestone Dec 11, 2017
@tzanio
Copy link
Member Author

tzanio commented Jan 3, 2018

Document the assumptions in the current implementation.

@tzanio
Copy link
Member Author

tzanio commented Jan 3, 2018

Separate documentation for frontend and backend?

@tzanio tzanio closed this as completed Mar 28, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jedbrown jedbrown

Labels
documentation
Projects
None yet
Milestone
Initial Release (v0.1)
Development

No branches or pull requests
2 participants
@jedbrown @tzanio