Easy Developer Task: Running doxygen on source tree.

[tschak909]

We need a script that can be run on the code to generate a full doxygen source code listing with full API, and we need for that source code listing to be checked at least once before we do a final check.

The goal here is to create a complete API map. You'll know it's complete by the size of it. There are several million lines of code, so if you only get one page of doxygen back, you need to refine the script some more.

Once this is working, work with us to graft this onto the build server so that it is updated every build turn.

Thanks,
-Thom

[coley]

dang, beat me to it!
was trying to start this yesterday but my svn checkout failed, kicked it off again but won't know until I get home.
Was there an original doxygen config file used to get the pluto doxygen output?

thx
-Coley.

[niz23]

Running this on my machine now. Had it working about a year ago.
Had a problem today with glibc barfing out a backtrace when doxygen parse external/alsa.
If you disable "follow symlink" it´ll work. (there is problably a symlink loo in external/alsa somewhere. Have not looked so it might be something else)

Take a while to run though and consume a good amount of ram. Mine is using above 600MB only for doxygen.

Will post the result later today when my last run is finished.

And yes. There is some doxygen config files in svn. If you use them doxygen will complain about outdated config options.
But as a start you can look at them.

/niz23

[coley]

I know this is dragging up an old thread - but I looked at this again.
Ran Doxygen on an svn checkout of 0810 - took forever and dot crashed a few times on generating diagrams.
I can post my doxyfile here and maybe some one can check if I have too many options selected.
Before I re-run Doxygen one or two questions:
 - Should it be run over the entire tree?
 - Is there a way of specifying an overall @mainpage? at the moment the enOcean Mainpage is the landing point.
 - what is the output format of choice? I used php and the searching works nicely - I just copied all the output to a new dir under /var/www/ on my core.

-Coley.

[tschak909]

doxygen should only be run over src/

-Thom

[coley]

Yep, was run over src/.

Output when compressed to a tgz file is close to 2Gb.
Attached is the doxyfile I used if anyone as any comments - additions/subtractions.

-Coley.

[tschak909]

Thanks, Coley

Anyone want to give this a whirl?

-Thom