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

Searchable Doumentation

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

Reply
 
LinkBack Thread Tools Display Modes
Old   April 15, 2002, 08:22
Default The online code documentation
  #1
Mattijs Janssens (Mattijs)
Guest
 
Posts: n/a
The online code documentation in Foam (accessible through FoamX under Help->Code Documentation) can be made searchable if you have access to the cgi-bin script of your http server. Very useful for finding member functions, classes etc.

These are the steps:
0] download and install doxygen. Make sure doxysearch is executable. Try and run it. It should output some html.

1] Find the cgi-bin/ directory of your htpp server. (on my Suse Linux machine: /usr/local/httpd/cgi-bin/)
In there:
- mkdir foam
- cp $WM_PROJECT_DIR/doc/Doxygen/search.cgi foam/doxysearch.foam2.1.cgi
- chmod a+x foam/doxysearch.foam2.1.cgi

2] in this script, foam/doxysearch.foam2.1.cgi, add at the start
DOXYSEARCH=/usr/local/doxygen-1.2.13.1/bin/doxysearch
DOXYPATH=/home/penfold/mattijs/foam/foam2.1/doc/Doxygen/html

with of course the paths to correspond to your setup. DOXYSEARCH is the full path to the executable (has to be executable by the user running http), DOXYPATH is the directory under Foam2.1 containing the html documentation. Note that these have to be absolute paths and can contain none of the FOAM environment variables.

3] in this DOXYPATH, (for me /home/penfold/mattijs/foam/foam2.1/doc/Doxygen/html),
edit search.cfg and
A] change the file:// entry to point to the installation directory:
- substitute '/home/escher/henry/foam/foam2.1' by the value of $WM_PROJECT_DIR.
B] change the http:// entry to the URL of the search script.

4] In the Doxygen html start page there is a 'search' button at the top right. This will take you to a search screen where you can search for any text inside the documentation.
  Reply With Quote

Old   April 16, 2002, 03:56
Default I've added one here:http://tfd
  #2
Niklas Nordin (Niklas)
Guest
 
Posts: n/a
I've added one here:http://tfdpc67.tfd.chalmers.se/foam/foam2.1/html
  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



All times are GMT -4. The time now is 08:26.