[HACKYSTAT-DEV-L] Doxygen update

[Aaron Kagawa]

Thanks to Mike,

I've successfully integrated doxygen and the ant-doxygen with stackyHack on my local version... It took some clever filtering (that I found on the internet) of several properties to set the PROJECT_NAME and OUTPUT_DIRECTORY, because the ant task doesn't support overwriting the properties in the cfg file.  Anyway, the ant code looks something like the following:

Philip: We have a couple of options (1) doxygen could be installed separately, (2) maybe the .exe can go in a lib directory, or (3) something else.  In the first case, the developer will have to specify the path to the doxygen.exe.  In the second case, we will know the location, which would be something like <system.name>/lib.  Not to mention we will also need to add the ant-doxygen.jar file.

Let me know which you prefer and I can start to add it into an initial module like stackyHacky.. BTW, stackyHack has a broken build sensor, do you can't even build the system.. I can fix that too, later on.

thanks, aaron

  <!-- *********************************************************************** -->
  <target name= "doxygen" depends= "compile" description= "Create an html version of the source code." >
    <taskdef name= "doxygen" classname= "org.doxygen.tools.DoxygenTask" />
    <copy file= "doxygen.cfg" tofile= "tmp.doxygen.cfg" overwrite= "true" >
      <filterset>
        <filter token= "OUTPUT_DIRECTORY" value= "${build.dir}/doxygen" />
        <filter token= "PROJECT_NAME" value= "${system.name}" />
      </filterset>
    </copy>
    <property name= "doxygenPath" location= "C:\Program Files\doxygen\bin\doxygen.exe" />
    <doxygen doxygenPath= "${doxygenPath}" configFilename= "tmp.doxygen.cfg" >
    </doxygen>
  </target>

At 09:42 AM 8/24/2005, you wrote:

Hey Aaron,

I attached the Doxyfile configuration file for the Truss code.  If you want to import the module from CVS, it is called "hpcs".  Once you download it, navigate to the pbb -> truss -> doc directory.

If you have any questions about the configuration, just let me know. 
Actually, the "wizard" packaged with Doxygen is simple and surprisingly useful for generating docs.

Best regards,
Mike

P.S.  Haha you wrote an email at 8:45am.  If you were in CSDL you would still be sleeping.  Working man....


Aaron Akihisa Kagawa wrote:

Hey,

When you get a chance.. Can you send me over the configuration file that
you used for doxygen. Or just send me the name of the truss cvs module.

thanks, aaron

----- Original Message -----
From: Mike Paulding <[EMAIL PROTECTED]>
Date: Tuesday, August 23, 2005 9:18 pm
Subject: Re: [HACKYSTAT-DEV-L] Investigating upgrade to Java 1.5

 

Hey Aaron,

I would recommend the Doxygen tool for supporting Java 5 code.  I used this tool on the Truss code (which was in C/C++), but I have also generated docs for Java 5 code.  I think its output really looks good. 
The Doxygen project is open source and on Sourceforge and the link to its main page is:

http://www.stack.nl/~dimitri/doxygen/

Doxygen was designed for Java, C and C++ documentation.  It also creates UML diagrams as an option.

You can check out the Doxygen documentation for the Truss code here:

http://csdl.ics.hawaii.edu/Research/Truss/doc/html/index.html

Good luck,
Mike


Aaron Akihisa Kagawa wrote:

  

Hey Guys,
Hey Guys,

It appears that the corrent version of java2html (that was downloaded
    

from < http://www.java2html.com/> doesn't support the new Java 5

syntax.>I did some googling and found another java2html project
  

< http://www.java2html.de/> that doesn't depend on a "strict     

grammar" and
  

seems to be working for Java 5 syntax. 

On the other hand, the java2html.com version provides a better     

report.>java2html.de just converts the files to html and doesn't provide a nice
  

report.
Anyway, I was wondering what direction we want to go.  I seem to like
java2html.com better but the last changes were made in May 2003.     

So, its
  

seems like we will have to move on.

Does any one know of any other HTML browsable Java converters     

that are
  

better and work with Java 5?

thanks, aaron