Get Basic Documentation in place

skotchvail / Love-Potion-Camp

Code related to the Burning Man camp called "Love Potion"

8 stars 3 forks source link

Get Basic Documentation in place #4

Open skotchvail opened 11 years ago

skotchvail commented 11 years ago

Investigate JavaDoc or other information so that we can start getting some documentation into place.

rdosser commented 11 years ago

I don't think javadoc per se is going to work. "Processing" isn't really java, and javadoc barfs on the syntax differences.

I think some javadoc-style inline commenting would be useful for people trying to work with the code, and it might be possible/not too difficult to whip up a quick script to scrape that into some basic HTML documentation.