CHDK Sourcecode Documentation (Doxygen) - General Discussion and Assistance - CHDK Forum

CHDK Sourcecode Documentation (Doxygen)

  • 13 Replies
  • 11136 Views
CHDK Sourcecode Documentation (Doxygen)
« on: 30 / August / 2008, 09:02:05 »
Advertisements
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.
« Last Edit: 25 / September / 2008, 07:29:56 by justme »

*

Offline dzsemx

  • ****
  • 302
  • [SX40HS][A650][A630]
Re: Doxygen'ed the CHDK sources (automatic source documentation)
« Reply #1 on: 31 / August / 2008, 03:41:24 »
nice, it may help new developers a lot

Re: Doxygen'ed the CHDK sources (automatic source documentation)
« Reply #2 on: 01 / September / 2008, 07:12:31 »
-
« Last Edit: 24 / September / 2008, 15:52:17 by justme »

*

srpenney

Re: Doxygen'ed the CHDK sources (automatic source documentation)
« Reply #3 on: 19 / September / 2008, 17:23:55 »
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?


Re: Doxygen'ed the CHDK sources (automatic source documentation)
« Reply #4 on: 24 / September / 2008, 11:25:39 »
I will investigate this issue, maybe I can force doxygen to filter by function name.
« Last Edit: 24 / September / 2008, 11:27:53 by justme »

*

srpenney

Re: Doxygen'ed the CHDK sources (automatic source documentation)
« Reply #5 on: 24 / September / 2008, 12:09:29 »
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)=

Re: Doxygen'ed the CHDK sources (automatic source documentation)
« Reply #6 on: 24 / September / 2008, 12:16:40 »
Thanks srpenney, just updated my doxygen configuration file.

*

srpenney

Re: Doxygen'ed the CHDK sources (automatic source documentation)
« Reply #7 on: 24 / September / 2008, 12:18:36 »
Here's hoping it works!


*

Offline PhyrePhoX

  • *****
  • 2254
  • make RAW not WAR
    • PhyreWorX
Re: Doxygen'ed the CHDK sources (automatic source documentation)
« Reply #8 on: 24 / September / 2008, 12:50:59 »
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 :)
« Last Edit: 24 / September / 2008, 12:54:58 by PhyrePhoX »

Re: Doxygen'ed the CHDK sources (automatic source documentation)
« Reply #9 on: 24 / September / 2008, 12:54:19 »
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)

 

Related Topics