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.
Index › Processing Development › Libraries,  Tool Development › Documentation Tools..
‹ Previous Topic | Next Topic ›
Page Index Toggle Pages: 1
Documentation Tools.. (Read 1566 times)
scloopy
Documentation Tools..
Feb 10th, 2006, 6:17am  
Hey, I'm just about ready to make some docs for a library.. Does anyone know of a good documentation generation tool? I know there is JavaDoc, but the output from that is really messy and hard to understand, judging by the java API website.

To anybody that has created a library: What do you use to create documentation? I know a lot of people do it by hand, but for a library with lots of classes it would save a lot of time to generate it automatically.

Thanks!
Back to top
 
WWW  
tex
Re: Documentation Tools..
Reply #1 - Feb 10th, 2006, 11:43am  
Check this. I build a custom java doc to document my libs.

http://texone.org/prodoc/
Back to top
 
WWW texone.org  
scloopy
Re: Documentation Tools..
Reply #2 - Feb 10th, 2006, 6:30pm  
Thanks tex! This is exactly what I needed. And I can customize the template. Awesome!
Back to top
 
WWW  
scloopy
Re: Documentation Tools..
Reply #3 - Feb 10th, 2006, 11:26pm  
Hi tex. I'm getting this error when i try to generate the javadoc in either Eclipse or the command line..

Code:
java.lang.UnsupportedClassVersionError: prodoc/StartDoclet (Unsupported major.minor version 49.0)
at java.lang.ClassLoader.defineClass0(Native Method)
at java.lang.ClassLoader.defineClass(ClassLoader.java:539)
at java.security.SecureClassLoader.defineClass(SecureClassLoader.java:123)
at java.net.URLClassLoader.defineClass(URLClassLoader.java:251)
at java.net.URLClassLoader.access$100(URLClassLoader.java:55)
at java.net.URLClassLoader$1.run(URLClassLoader.java:194)
at java.security.AccessController.doPrivileged(Native Method)
at java.net.URLClassLoader.findClass(URLClassLoader.java:187)
at java.lang.ClassLoader.loadClass(ClassLoader.java:289)
at java.lang.ClassLoader.loadClass(ClassLoader.java:235)
at com.sun.tools.javadoc.DocletInvoker.<init>(DocletInvoker.java:69)
at com.sun.tools.javadoc.Start.setDocletInvoker(Start.java:343)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:170)
at com.sun.tools.javadoc.Start.begin(Start.java:121)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
javadoc: fatal error
1 error

Do you have any idea what the reason is? I thought it was because I needed Java 1.5 but I have that installed.

Hmm, actually I just checked, and java reports the version as 1.4.2_09. Strange. Is there something I need to do to enable 1.5, or will 1.4.2 work? I'm on Mac OS 10.4 BTW.

Thanks
Back to top
 
WWW  
tex
Re: Documentation Tools..
Reply #4 - Feb 10th, 2006, 11:58pm  
The exception you posted is a typical wrong version exception, prodoc does definitely require java 1.5. Make sure java 1.5 is your current version in eclipse, you can add and set any jdk in the workspace settings.
Back to top
 
WWW texone.org  
scloopy
Re: Documentation Tools..
Reply #5 - Feb 11th, 2006, 2:47am  
Ah yeah.. I just had to enable it there. Tongue Thanks again tex.
Back to top
 
WWW  
Page Index Toggle Pages: 1
‹ Previous Topic | Next Topic ›