Pages: [1]   Go Down
Author Topic: Source Documentation with doxygen?  (Read 1092 times)
0 Members and 1 Guest are viewing this topic.
Austria
Offline Offline
Newbie
*
Karma: 0
Posts: 4
View Profile
 Bigger Bigger  Smaller Smaller  Reset Reset

hello,

i tired to make a html-documentation of my source-code with doxygen - but all i get was an empty sheed.

is there something i have to take care of when i create a documentation?

at the moment the source & comments looks like this example:
Code:
/**
* int
* choose the input pin (for a pushbutton)
*/

int inPin_1 = 3;  /**< int value inPin_1, connected to pin3. */  
int inPin_2 = 4;  /**< int value inPin_2, connected to pin4. */  
int inPin_3 = 5;  /**< int value inPin_3, connected to pin5. */  


any ideas where i made a mistake?

greetings,
selestra
Logged

"The old Europe"
Offline Offline
Edison Member
*
Karma: 1
Posts: 2005
Bootloaders suck!
View Profile
WWW
 Bigger Bigger  Smaller Smaller  Reset Reset

Did you create a config file ?

Code:
doxygen -g config_file_name

Then you'll have to edit it to suite your needs. There's also a quite detailed PDF manual that comes with it (at least on suse).
Logged

• Upload doesn't work? Do a loop-back test.
• There's absolutely NO excuse for not having an ISP!
• Your AVR needs a brain surgery? Use the online FUSE calculator.
My projects: RGB LED matrix, RGB LED ring, various ATtiny gadgets...
• Microsoft is not the answer. It is the question, and the answer is NO!

Austria
Offline Offline
Newbie
*
Karma: 0
Posts: 4
View Profile
 Bigger Bigger  Smaller Smaller  Reset Reset

the doxygen-wizard created the config-file automatically. - i also added *.pde files to the file_pattern.

creating a documentation of the doxygen-examples works really fine. so the error has do be somewhere inside my code- but i have no idea where i have to look. doxygen is able to read *.pde-files - isn't it?

is there something i have to watch out when i create comments? - i use the  
/**
*
*/
methode - but i also enabled the using of java-doc style.

lg
selestra


EDIT: no idea what was wrong yesterday. i wrote the commants new today - and now it works.  :smiley
« Last Edit: February 14, 2009, 04:29:06 am by Selestra » Logged

0
Offline Offline
Newbie
*
Karma: 0
Posts: 14
Arduino rocks
View Profile
 Bigger Bigger  Smaller Smaller  Reset Reset

If anybody else has this problem, for me it only started to work after I set:

EXTRACT_ALL = YES
Logged

Pages: [1]   Go Up
Jump to: