CFD Online Logo CFD Online URL
Home > Forums > OpenFOAM

Could Somebody Please Explain Doxygen to me

Register Blogs Members List Search Today's Posts Mark Forums Read

LinkBack Thread Tools Display Modes
Old   March 24, 2011, 10:35
Default Could Somebody Please Explain Doxygen to me
Join Date: Oct 2010
Location: UK
Posts: 41
Rep Power: 7
dandalf is on a distinguished road
Hi all, I'm still relatively new to Open Foam. (And Linux generaly for that matter).

I have been having trouble figuring out what the input requirements are for the various patch types in the Open Foam Dictionaries.

Several sites have mentioned the use of Doxygen to create a users manual from the code. Unfortunately years of being a slave to Windows has left me unable to fathom how to use the doxygen comands.

For example If i wish to learn more about a open foam library how do I generate a corresponding doxygen pdf file.

The acceptable command seems to be
doxygen -w latex headerFile styleSheetFile [configFile]
However I don't know what the various parts mean.

Doxygen version 1.6.3
CAELinux 2010
I would apreciate any help you can give

dandalf is offline   Reply With Quote


Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are On

Similar Threads
Thread Thread Starter Forum Replies Last Post
Can someone explain the Y plus value jeff bennet Main CFD Forum 17 April 1, 2014 14:34
which png renderer for Doxygen documentation generation mirko OpenFOAM Installation 2 December 4, 2010 18:12
Doxygen files are not same as 1.6 in 1.7 maysmech OpenFOAM 1 August 27, 2010 09:36
Please explain this commands. sri31049 FLUENT 3 March 20, 2009 05:38
Please explain Abby CFX 1 April 25, 2006 06:18

All times are GMT -4. The time now is 04:13.