CFD Online Discussion Forums

CFD Online Discussion Forums (https://www.cfd-online.com/Forums/)
-   OpenFOAM (https://www.cfd-online.com/Forums/openfoam/)
-   -   Could Somebody Please Explain Doxygen to me (https://www.cfd-online.com/Forums/openfoam/86512-could-somebody-please-explain-doxygen-me.html)

dandalf March 24, 2011 09:35

Could Somebody Please Explain Doxygen to me
 
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
Code:

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

Dan


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