Post by Admin on Jul 16, 2016 4:29:36 GMT
Simon Schmid @sschmid Oct 05 2015 06:10
@gjroelofs Initially I decided not to add documentation in the code, because I think it adds so much noise and makes refactoring harder. I thought, it's not so important, since it is open source anyway. But as the api has gotten pretty stable now and more concept were added that might need some explanation, I'm now thinking about taking the time and add documentation.
Simon Schmid @sschmid Oct 05 2015 06:16
Can you recommend any tools to generate a html based on the documentation?
Adrian Papari @junkdog Oct 05 2015 06:18
doxygen - it supports writing api doc in markdown too, way more readable than xml.
i sometimes use it instead of javadoc, because it can generate class diagrams and such too.
@gjroelofs Initially I decided not to add documentation in the code, because I think it adds so much noise and makes refactoring harder. I thought, it's not so important, since it is open source anyway. But as the api has gotten pretty stable now and more concept were added that might need some explanation, I'm now thinking about taking the time and add documentation.
Simon Schmid @sschmid Oct 05 2015 06:16
Can you recommend any tools to generate a html based on the documentation?
Adrian Papari @junkdog Oct 05 2015 06:18
doxygen - it supports writing api doc in markdown too, way more readable than xml.
i sometimes use it instead of javadoc, because it can generate class diagrams and such too.
