[CF-Devel] Re: Code documentation?

[crossfire-devel at archives.real-time.com]

Todd Mitchell wrote:

>
     
      http:/crossfire.real-time.com/code
     
     >
     
     
     >
     
      Still working on the stylesheet a bit however ;)
     
     
Code documentation is always a good idea.

Since the CFJavaEditor shows up on the link provided,
this reminds me that the editor is pretty well documented
in javadoc style.
I don't have a problem with doxygen being used to format
CFJavaEditor sources, however I would like developers who
might be working on the java code to write javadoc comments
(in case there is any difference, which I'm not sure about).

Anyways, I have added a javadoc build target to to the ant
build file for the editor. Javadocs can now be generated by
the command "ant doc".

As an example, javadocs from current CVS can be downloaded from:
     
     http://home.in.tum.de/~vogl/crossfire/CFJavaEditor_docs.zip
     
     

(This is just a one-time example. I don't plan to update the link
when code changes occur).

AndreasV


-- 
NEU FÜR ALLE - GMX MediaCenter - für Fotos, Musik, Dateien...
Fotoalbum, File Sharing, MMS, Multimedia-Gruß, GMX FotoService

Jetzt kostenlos anmelden unter 
     
     http://www.gmx.net
     
     

+++ GMX - die erste Adresse für Mail, Message, More! +++


_______________________________________________
crossfire-devel mailing list
     
     crossfire-devel at lists.real-time.com
     
     
     https://mailman.real-time.com/mailman/listinfo/crossfire-devel