search

bluemagicsource / magic-config

bluemagic properties library
9 stars 6 forks source link

Write documentation for usage #5

Closed jackrod closed 12 years ago

jackrod commented 12 years ago

Use wiki on bluemagicsource.org

jackrod commented 12 years ago

Look into transformation of java based comments into html

PeterPlatt commented 12 years ago

Probably should consider doxygen which can transform source comments to documentation. I'll look into this soon too. Below is a link to getting started documentaion

http://www.stack.nl/~dimitri/doxygen/starting.html

PeterPlatt commented 12 years ago

Actually may not need to be that complicated. Seems the java docs converts to HTML very easily. I'll examine that approach instead

PeterPlatt commented 12 years ago

we can use javadoc to generate our documentation. The only thing that concerns me is that our public methods aren't all well documented. I'll begin the process of attempting to transform our comments soon.

PeterPlatt commented 12 years ago

Used javadoc to generate basic HTML pages. Email sent to Jrod we may need to do some more CSS work to clean up the look and feel, but I feel the focus should be on good documentation first.