CFD Online Discussion Forums

CFD Online Discussion Forums (http://www.cfd-online.com/Forums/)
-   OpenFOAM (http://www.cfd-online.com/Forums/openfoam/)
-   -   run Doxygen offline (http://www.cfd-online.com/Forums/openfoam/103144-run-doxygen-offline.html)

anishtain4 June 12, 2012 06:35

run Doxygen offline
 
there is a page for it in the wiki:
http://openfoamwiki.net/index.php/Ho..._while_offline
, I did install the apache and it works fine, but when it comes to the part to change the DocumentRoot I can't find the file named default-server.conf in the apache folder. grep was useful to find this line in some files but the changing those paths was of no help. any idea?

wyldckat June 12, 2012 16:43

Greetings Mahdi,

Here's some old instructions of mine, which are far more up-to-date than those: Building Code Documentation on OpenFOAM 2.0.0/x

Best regards,
Bruno

anishtain4 June 13, 2012 07:49

Thanks Bruno, you are a life saver. I will check it once I get home

anishtain4 June 14, 2012 13:10

1 Attachment(s)
I did try that, the page does come up but there is nothing I can do in it!
when I open the html file the shape is like the one in the picture and nothing happens by searching

wyldckat June 14, 2012 15:55

Hi Mahdi,

What Ubuntu version did you use? And which Doxygen version did you use?

Best regards,
Bruno

anishtain4 June 15, 2012 04:50

Ubuntu 10.04 LTS
Doxygen 1.6.3

and I did run ./Allwmake from doc folder ( I did installed my openfoam from source because I had problems with openmpi), doc/Doxygen folder and "doxygen Doxyfile" from doc/Doxygen
here is my docmake.log

Code:

+ chmod a+rX /opt/OpenFOAM/OpenFOAM-2.1.0 /opt/OpenFOAM/OpenFOAM-2.1.0/doc Doxygen
+ Doxygen/Allwmake
+ rm -rf latex man
+ mv html html-stagedRemove3031
+ umask 22
+ doxygen
+ rm -rf html-stagedRemove3031
Searching for include files...
Searching for example files...
Searching for images...
Searching for dot files...
Searching for files to exclude
Searching for files to process...
Searching for files in directory /opt/OpenFOAM/OpenFOAM-2.1.0/doc/Doxygen
Reading and parsing tag files
Building group list...
Building directory list...
Building namespace list...
Building file list...
Building class list...
Associating documentation with classes...
Computing nesting relations for classes...
Building example list...
Searching for enumerations...
Searching for documented typedefs...
Searching for members imported via using declarations...
Searching for included using directives...
Searching for documented variables...
Building member list...
Searching for friends...
Searching for documented defines...
Computing class inheritance relations...
Computing class usage relations...
Flushing cached template relations that have become invalid...
Creating members for template instances...
Computing class relations...
Add enum values to enums...
Searching for member function documentation...
Building page list...
Search for main page...
Computing page relations...
Determining the scope of groups...
Sorting lists...
Freeing entry tree
Determining which enums are documented
Computing member relations...
Building full member lists recursively...
Adding members to member groups.
Computing member references...
Inheriting documentation...
Generating disk names...
Adding source references...
Adding xrefitems...
Counting data structures...
Resolving user defined references...
Finding anchors and sections in the documentation...
Combining using relations...
Adding members to index pages...
Generating style sheet...
Generating index page...
Generating page index...
Generating example documentation...
Generating file sources...
Generating file documentation...
Generating page documentation...
Generating group documentation...
Generating group index...
Generating class documentation...
Generating annotated compound index...
Generating alphabetical compound index...
Generating hierarchical class index...
Generating member index...
Generating namespace index...
Generating namespace member index...
Generating graph info page...
Generating file index...
Generating example index...
Generating file member index...
+ chmod -R a+rX html latex man
+ echo

+ echo Done doxygen
Done doxygen
+ echo

but all there is in the html folder of doxygen are:
doxygen.css index.html search tab_l.gif tabs.css
doxygen.png installdox tab_b.gif tab_r.gif

wyldckat June 16, 2012 04:51

Hi Mahdi,

Why are you doing this in the "/opt" folder? Are you doing this as "root" (superuser)?

For now, my advice is to install (basically just unpack) OpenFOAM 2.1.0 in your personal home folder as normal user: http://www.openfoam.org/download/source.php
Well, you might want the latest 2.1.1 instead, since it's the latest stable release.
Then follow the instructions for generating the Doxygen information.

Note: You don't need to build the code for generating the help.

I say this because when doing things as root, you're just asking for trouble. One wrong key press and you end up having to wait another 30-60 minutes to reinstall the whole operating system :(

Good luck!
Bruno

anishtain4 June 17, 2012 04:45

It's done now :D all good

GerhardHolzinger November 27, 2014 10:36

For the sake of completeness:

  1. I have installed OpenFOAM or foam-extend in /opt, i.e. because I installed it via the *.deb
  2. I want to build the Doxygen documentation
In order to build the Doxygen documentation, you need to
  1. Become root - otherwise you can't access the files in /opt/FOAM/src
    sudo -i
  2. Set the environment variables
    source $WM_PROJECT_DIR/etc/bashrc
  3. Build the Doxygen stuff
    cd $WM_PROJECT_DIR/doc
    ./Allwmake


All times are GMT -4. The time now is 19:44.