CHDK Sourcecode Documentation (Doxygen)

[justme]

CHDK Sourcecode Documentation

To improve this automatically generated documentation, please add a doxygen-description-tag to your part of the code and use your own words to explain it.  Here's a nice example at the bottom how to do it. 

Remember:
* Documentate your code!
* Use Doxygen-Tags!
* The faster somebody else can understand your code, the sooner they will contribute their own ideas!


The documentation will be rebuild every night at 3:00 o'clock GMT if there's a change in the SVN.

[dzsemx]

nice, it may help new developers a lot

[justme]

-

[srpenney]

One thing I came across when browsing the CHDK Doxygen'd documentation (which is quite handy and would be oh so much handier if comments with Doxygen TAGs were used) is that the __attribute__((...)) directives get picked up as function names.  Would it be worth attempting to get the c-preprocessor to cull these?

[justme]

I will investigate this issue, maybe I can force doxygen to filter by function name.

[srpenney]

There's an example of how to do this here: http://www.nabble.com/struct---__attribute__((packed))-not-working--td18967383.html

From link:
You can let doxygen's C-preprocessor remove the __attribute__ stuff with the following settings:

Code: [Select]

ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
PREDEFINED             = __attribute__(x)=

[justme]

Thanks srpenney, just updated my doxygen configuration file.

[srpenney]

Here's hoping it works!

[PhyrePhoX]

thanks, stickified. this replaces whims manual way of cross-referencing the source i guess (http://chdk.setepontos.com/index.php/topic,549.60.html). one thing i noticed though: it isnt called allbest anymore, it's just CHDK

[justme]

Ok, thanks for making my post sticky. Everything will be renamed to CHDK tomorrow (i don't want to touch the cronjob process right now)

[msl]

Doxgen is a helpfull tool to check the chdk source code.

It is possible to update the doxygen pages? The last version is from 06-17-2009.

Thx msl