Add more documentation - Githubissues

CartwrightLab / dawg

Simulating Sequence Evolution

GNU General Public License v2.0

11 stars 3 forks source link

Add more documentation #40

Closed zmertens closed 6 years ago

zmertens commented 6 years ago

I want to add some more Doxygen comments which I think it might make it easier in the future to add documentation. Develop also currently supports building Doxygen so for this issue to be closed:

There needs to be enough boilerplate documentation to look consistent enough throughout the project.
Document the command line parameters
Document an example of the API being used (such as the code in SpartaABC)

zmertens commented 6 years ago

Closed since this is an ongoing thing, maybe it would fit in the "Projects" area. I was thinking of taking parts from dawg-related publications and using those as comments.