CFD Online Logo CFD Online URL
www.cfd-online.com
[Sponsors]
Home > Forums > OpenFOAM Installation

how to use Doxygen to generate a PDF with OpenFOAM's source code documentation?

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

Like Tree1Likes
  • 1 Post By wyldckat

Reply
 
LinkBack Thread Tools Display Modes
Old   November 25, 2010, 10:31
Default how to use Doxygen to generate a PDF with OpenFOAM's source code documentation?
  #1
New Member
 
Rajshekar
Join Date: Nov 2010
Posts: 16
Rep Power: 6
Rajshekar is on a distinguished road
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
Rajshekar is offline   Reply With Quote

Old   November 25, 2010, 11:21
Default
  #2
Super Moderator
 
Bruno Santos
Join Date: Mar 2009
Location: Lisbon, Portugal
Posts: 8,488
Blog Entries: 34
Rep Power: 86
wyldckat is just really nicewyldckat is just really nicewyldckat is just really nicewyldckat is just really nice
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
wyldckat is offline   Reply With Quote

Old   May 25, 2014, 07:24
Default
  #3
Senior Member
 
Wen Xu
Join Date: May 2014
Posts: 150
Rep Power: 3
wenxu is on a distinguished road
Quote:
Originally Posted by Rajshekar View Post
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.
wenxu is offline   Reply With Quote

Old   May 25, 2014, 07:36
Default
  #4
Super Moderator
 
Bruno Santos
Join Date: Mar 2009
Location: Lisbon, Portugal
Posts: 8,488
Blog Entries: 34
Rep Power: 86
wyldckat is just really nicewyldckat is just really nicewyldckat is just really nicewyldckat is just really nice
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: Error when generating pdfLatex using Doxygen

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
wyldckat is offline   Reply With Quote

Old   May 25, 2014, 08:03
Smile
  #5
Senior Member
 
Wen Xu
Join Date: May 2014
Posts: 150
Rep Power: 3
wenxu is on a distinguished road
Quote:
Originally Posted by wyldckat View Post
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: Error when generating pdfLatex using Doxygen

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"?
wenxu is offline   Reply With Quote

Old   May 25, 2014, 08:24
Default
  #6
Super Moderator
 
Bruno Santos
Join Date: Mar 2009
Location: Lisbon, Portugal
Posts: 8,488
Blog Entries: 34
Rep Power: 86
wyldckat is just really nicewyldckat is just really nicewyldckat is just really nicewyldckat is just really nice
Quote:
Originally Posted by wenxu View Post
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
babala likes this.
wyldckat is offline   Reply With Quote

Old   May 25, 2014, 08:31
Default
  #7
Senior Member
 
Wen Xu
Join Date: May 2014
Posts: 150
Rep Power: 3
wenxu is on a distinguished road
Quote:
Originally Posted by wyldckat View Post
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
wenxu is offline   Reply With Quote

Old   June 2, 2014, 04:26
Default
  #8
Senior Member
 
Elvis
Join Date: Mar 2009
Location: Sindelfingen, Germany
Posts: 579
Blog Entries: 5
Rep Power: 13
elvis is on a distinguished road
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€
elvis is offline   Reply With Quote

Old   June 3, 2014, 22:33
Default
  #9
New Member
 
Chenshu HU
Join Date: Jan 2014
Posts: 12
Rep Power: 3
hcs129 is on a distinguished road
Hi Bruno!
Can I see the source code in win7 system? Cause I use SSH to do my jod in win7.
Thanks in advance.
hcs129 is offline   Reply With Quote

Old   June 8, 2014, 13:55
Default
  #10
Super Moderator
 
Bruno Santos
Join Date: Mar 2009
Location: Lisbon, Portugal
Posts: 8,488
Blog Entries: 34
Rep Power: 86
wyldckat is just really nicewyldckat is just really nicewyldckat is just really nicewyldckat is just really nice
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
wyldckat is offline   Reply With Quote

Old   June 10, 2014, 03:18
Default
  #11
New Member
 
Chenshu HU
Join Date: Jan 2014
Posts: 12
Rep Power: 3
hcs129 is on a distinguished road
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!
hcs129 is offline   Reply With Quote

Reply

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
Swak4FOAM 0.2.3 / OF2.2.x installation error FerdiFuchs OpenFOAM Installation 27 April 16, 2014 15:14
Swak4Foam funkyDoCalc with OF2.3 massflow NiFl OpenFOAM 8 March 24, 2014 21:06
centOS 5.6 : paraFoam not working yossi OpenFOAM Installation 2 October 9, 2013 01:41
Doxygen documentation Tanay OpenFOAM Installation 9 September 23, 2011 11:40
DxFoam reader update hjasak OpenFOAM Post-Processing 69 April 24, 2008 01:24


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