We closed this forum 18 June 2010. It has served us well since 2005 as the ALPHA forum did before it from 2002 to 2005. New discussions are ongoing at the new URL http://forum.processing.org. You'll need to sign up and get a new user account. We're sorry about that inconvenience, but we think it's better in the long run. The content on this forum will remain online.
IndexProcessing DevelopmentLibraries,  Tool Development › proDOC doclet for processing libraries
Page Index Toggle Pages: 1
proDOC doclet for processing libraries (Read 2019 times)
proDOC doclet for processing libraries
Jul 11th, 2005, 8:01pm
 
Just for the case anyone is building a new library. I nearly finnished a doclet. That simplifies building documentation of processing libraries.

proDOC uses the javadoc funtion to build the documentation, so all you have to do is to comment your library and let proDOC generate the html files. I have included some special tags for example to include example code directly from pde files.

proDOC builds up on html template files, you can build your own to achieve an unique design, you have to include some tags in the template files as placeholders for the information.

Okay I hope I finnish it soon, I have to do a bit more testing and complete the documentation, but it should be online in the end of this week.

tex
Re: proDOC doclet for processing libraries
Reply #1 - Jul 17th, 2005, 8:17pm
 
I finnished proDOC here is the link:

http://www.texone.org/prodoc/
Re: proDOC doclet for processing libraries
Reply #2 - Jul 17th, 2005, 9:27pm
 
Wonderful Christian! I hope this helps people with their documentation. As we all know, writing documentation is not the most glamorous part of making a Library, but it's one of the most important.

A few notes:
- In reading the docs, I noticed you mispelled the word "description" throughout as "describtion"
- It would be good to have a Java code example to see how you are embedding the source tags within the code

I think the system you've set up is certainly easy for some people, but different people prefer working in different ways. There's another way to produce Processing documentation using XML reference files which are parsed into HTML. If someone wants to use this system, just write to me and I'll send the files.
Re: proDOC doclet for processing libraries
Reply #3 - Jul 17th, 2005, 10:15pm
 
Thank you Casey!

I fixed the description problem, I will add some code examples to the documentation later.
Page Index Toggle Pages: 1