Documenting Code

General Discussion Other

juanzulo

in General Discussion • Other • 2 years ago

Hi all:

I wanna documenting my code, using a document code generator, like doxygen or javadoc for example.

My question is if anybody has document code? Can teach me howto do this?

I tried with doxygen, but it obviate some classes and doesn't work properly (i don't know if i do something wrong in the doxy wizard).

I'm working with processing IDE (not in eclipse).

Replies(2)

PhiLho

Re: Documenting Code

2 years ago

Most libraries for Processing just use the JavaDoc tool, as it is standard in Java, and used by Processing. I doubt many people use JavaDoc on simple sketches, it is more suited to reusable code, ie. libraries (or large code bases).
I like Doxygen's extended syntax (no need to repeat the parameter names, for example), but I admit I haven't used it yet for Java.
One problem of using Doxygen (or JavaDoc, perhaps) on sketches in the Processing syntax (as opposed to the pure Java syntax you use in Eclipse) is that it doesn't follow strictly Java syntax, by the lack of enclosing class (it is actually implicit).
It might be better to export the sketch, and run the tool on the generated Java files instead.

juanzulo

Re: Documenting Code

2 years ago

Thanks a lot phi.lho !!!

I can get now documentation with doxygen from the code .java generated exporting applet in Processing iDE.

Top Reply