CFD Online Discussion Forums

CFD Online Discussion Forums (http://www.cfd-online.com/Forums/)
-   OpenFOAM Installation (http://www.cfd-online.com/Forums/openfoam-installation/)
-   -   how to use Doxygen to generate a PDF with OpenFOAM's source code documentation? (http://www.cfd-online.com/Forums/openfoam-installation/82413-how-use-doxygen-generate-pdf-openfoams-source-code-documentation.html)

Rajshekar November 25, 2010 10:31

how to use Doxygen to generate a PDF with OpenFOAM's source code documentation?
 
hi,
am new to openfoam. wanted to know how to get source code using Doxygen right
from get-install to getting source into pdf.

thanking you

wyldckat November 25, 2010 11:21

Greetings Rajshekar,

For building the Doxygen documentation of OpenFOAM, you can see this post: http://www.cfd-online.com/Forums/ope...tml#post269231

If you don't want to waste time building it, you can see online in the official site www.openfoam.com under "Documentation->C++ Source Guide".

As for converting it to PDF, you'll have to see how to do it in Doxygen's website.

Best regards,
Bruno

wenxu May 25, 2014 07:24

Quote:

Originally Posted by Rajshekar (Post 284799)
hi,
am new to openfoam. wanted to know how to get source code using Doxygen right
from get-install to getting source into pdf.

thanking you



hi,Rajshekar. Had you got the pdf using Doxygen, I also want to get the pdf of the source code. If you have got it,please tell me how can i get it, than you in advance.

wyldckat May 25, 2014 07:36

Greetings wenxu and welcome to the forum!

Using Doxygen to generate a PDF with OpenFOAM's source code, won't work well, as explained here: http://www.cfd-online.com/Forums/ope...g-doxygen.html

On the other hand, if you're looking for the PDF files for the User Guide and Programmer's Guide, have a look into the folder that is indicated by this command:
Code:

echo $WM_PROJECT_DIR/doc/Guides-a4
Best regards,
Bruno

wenxu May 25, 2014 08:03

Quote:

Originally Posted by wyldckat (Post 494003)
Greetings wenxu and welcome to the forum!

Using Doxygen to generate a PDF with OpenFOAM's source code, won't work well, as explained here: http://www.cfd-online.com/Forums/ope...g-doxygen.html

On the other hand, if you're looking for the PDF files for the User Guide and Programmer's Guide, have a look into the folder that is indicated by this command:
Code:

echo $WM_PROJECT_DIR/doc/Guides-a4
Best regards,
Bruno


Thank you for your prompt reply. I am a new here and i have finished the two guides, could you tell me how should i start to learn the source code of OF, i mean start from "where" or which "directory":)?

wyldckat May 25, 2014 08:24

Quote:

Originally Posted by wenxu (Post 494005)
Thank you for your prompt reply. I am a new here and i have finished the two guides, could you tell me how should i start to learn the source code of OF, i mean start from "where" or which "directory":)?

My advice: don't go directly to OpenFOAM's source code, until you know what exactly you're looking for.
If you've already read the 2 Guides, then try these sources of information:
After reading/studying those pages, you should get a clearer picture of how you should approach OpenFOAM's source code.

Best regards,
Bruno

wenxu May 25, 2014 08:31

Quote:

Originally Posted by wyldckat (Post 494010)
My advice: don't go directly to OpenFOAM's source code, until you know what exactly you're looking for.
If you've already read the 2 Guides, then try these sources of information:
After reading/studying those pages, you should get a clearer picture of how you should approach OpenFOAM's source code.

Best regards,
Bruno


ok, thank you very much, Brun.:)


best regards.
wenxu

elvis June 2, 2014 04:26

Hi,

Bruno gave you very good links to get more insight into OF!

there is also "C++ applied to OpenFOAM online course"
well the price tag is 200€

hcs129 June 3, 2014 22:33

Hi Bruno!
Can I see the source code in win7 system? Cause I use SSH to do my jod in win7.
Thanks in advance.

wyldckat June 8, 2014 13:55

Greetings hcs129,

See the source code? In what sense?
  1. Are you referring to the source code of OpenFOAM itself?
  2. Or are you referring to the code documentation?
Either way, the simplest solution is to simply copy the files you want to see from the remote machine to the local machine, by using WinSCP or a similar application.
The other possibility is to browse online the git repository, for example for OpenFOAM 2.3.x: https://github.com/OpenFOAM/OpenFOAM-2.3.x/

Best regards,
Bruno

hcs129 June 10, 2014 03:18

Hi Bruno
I want to see source code of openfoam.For convenience,an doxygen index is desirable.
Perhaps I should install UBUNTU in my PC.Thankx!


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