Gamestudio Links
Zorro Links
Newest Posts
loading historical data 1st time
by AndrewAMD. 04/14/23 12:54
Trade at bar open
by juanex. 04/13/23 19:43
Bug in Highpass2 filter
by rki. 04/13/23 09:54
Adding Limit Orders For IB
by scatters. 04/11/23 16:16
FisherN
by rki. 04/11/23 08:38
AUM Magazine
Latest Screens
SHADOW (2014)
DEAD TASTE
Tactics of World War I
Hecknex World
Who's Online Now
1 registered members (Grant), 999 guests, and 2 spiders.
Key: Admin, Global Mod, Mod
Newest Members
rki, FranzIII, indonesiae, The_Judge, storrealba
18919 Registered Users
Previous Thread
Next Thread
Print Thread
Rate Thread
Doxygen experiences #327171
06/04/10 21:55
06/04/10 21:55
Joined: Apr 2005
Posts: 4,506
Germany
F
fogman Offline OP
Expert
fogman  Offline OP
Expert
F

Joined: Apr 2005
Posts: 4,506
Germany
I would like to use doxygen to improve my style and my documentation.

I´ve found some old threads for it but I don´t really know were to start.
It would be nice if you could share your experiences with doxygen, the pros and cons as well as some tipps about the integration with Lite-c.

Thank you very much & stay pixelated


no science involved
Re: Doxygen experiences [Re: fogman] #327184
06/04/10 22:50
06/04/10 22:50
Joined: Apr 2010
Posts: 265
V
Vinous_Beret Offline
Member
Vinous_Beret  Offline
Member
V

Joined: Apr 2010
Posts: 265
hi buddy,i am not sure but once i wanted to learn it,and i found very good tutorial about it,just give some time i will find it for you. wink

Re: Doxygen experiences [Re: Vinous_Beret] #327266
06/05/10 16:03
06/05/10 16:03
Joined: Apr 2005
Posts: 4,506
Germany
F
fogman Offline OP
Expert
fogman  Offline OP
Expert
F

Joined: Apr 2005
Posts: 4,506
Germany
No one uses Doxygen here? I can´t believe it somehow.
I´ll try to get the hang of it, if I´m successful I´ll share my experiences.


no science involved
Re: Doxygen experiences [Re: fogman] #327307
06/05/10 20:09
06/05/10 20:09
Joined: Apr 2007
Posts: 3,751
Canada
WretchedSid Offline
Expert
WretchedSid  Offline
Expert

Joined: Apr 2007
Posts: 3,751
Canada
I use Doxygen, but not for Lite-C, so I can't help you with this (but I think it should work like a normal C application).

Well, the pros are that it's really nice and has alot of features, the cons are the UI. I can only talk about the Mac UI, but, it's a pain. Really.


Shitlord by trade and passion. Graphics programmer at Laminar Research.
I write blog posts at feresignum.com
Re: Doxygen experiences [Re: WretchedSid] #327460
06/06/10 14:16
06/06/10 14:16
Joined: Sep 2003
Posts: 9,859
F
FBL Offline
Senior Expert
FBL  Offline
Senior Expert
F

Joined: Sep 2003
Posts: 9,859
What do you need to know?

I'm using Doxygen with Lite-C and it's working just fine:

http://firoball.de/stuff/toolbox_manual/


You need to know what you want to have int he manual. And then run the Doxygen wizard to setup everything right.
In my case I disabled the inclusion of source listings in the help files.
And I installed the Microsoft HTML Help workshop to build up a .chm file right away with a single click.


Sample of a doxied code file: http://pastebin.com/c3fK7VZ4

My "Doxyfile": http://pastebin.com/nTYiXBxH

My batchfile to generate the documentation: http://pastebin.com/re9qs19W

Will need path adjustment.
I'm placing the documentation in a subfolder of the project.

So I have the following line in the doxy config for finding the project files:
INPUT = ..

and output is placed into the same folder as the Doxygen config. I have only tried to do HTML help, so I've set the HTML output folder like this (the folder is named "html"):
HTML_OUTPUT = html

The batch script shown above starts Doxygen, then starts the HTML Help workshop and finally copies the final .chm file out of the "html" folder.






Re: Doxygen experiences [Re: FBL] #327466
06/06/10 14:46
06/06/10 14:46
Joined: Apr 2005
Posts: 4,506
Germany
F
fogman Offline OP
Expert
fogman  Offline OP
Expert
F

Joined: Apr 2005
Posts: 4,506
Germany
Really nice!
I´ll examine it in the evening, because I´ve got some work to do.
Thank you very much!


no science involved

Moderated by  aztec, Blink, HeelX 

Gamestudio download | chip programmers | Zorro platform | shop | Data Protection Policy

oP group Germany GmbH | Birkenstr. 25-27 | 63549 Ronneburg / Germany | info (at) opgroup.de

Powered by UBB.threads™ PHP Forum Software 7.7.1