diff --git a/doc/Doxygen/README.html b/doc/Doxygen/README.html index 1804b7f393..b6fc1f794d 100644 --- a/doc/Doxygen/README.html +++ b/doc/Doxygen/README.html @@ -3,22 +3,29 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+ + +
The HTML documentation of OpenFOAM can be built using the Doxygen software.
@@ -158,9 +272,9 @@ graphviz software package. To build the documentation on the Ubuntu GNU/Linux
system, for example, the user should install both doxygen and graphviz
packages, e.g. by typing in a terminal window:
sudo apt-get install doxygen graphviz
-sudo apt-get install doxygen graphviz@@ -172,20 +286,20 @@ permission for the directory that Doxygen writes files to.
-The Doygen configuration file, Doxyfile, in the $WM_PROJECT_DIR/doc/Doxygen
+The Doxygen configuration file, Doxyfile, in the $WM_PROJECT_DIR/doc/Doxygen
directory is configured to work with Doxygen versions 1.6.3-1.8.5.
The Header, Footer, and Stylesheet are generated automatically:
+doxygen -w html header.html footer.html customdoxygen.css
-doxygen -w html header.html footer.html customdoxygen.css@@ -194,33 +308,30 @@ See: https
In the $WM_PROJECT_DIR/doc/Doxygen directory type
./Allwmake
-./Allwmake
which will generate the $WM_PROJECT_DIR/doc/Doxygen/html directory
containing the OpenFOAM source code documentation. Load the index.html file
-into a browser, e.g.
+into a browser, \e.g.\
firefox $WM_PROJECT_DIR/doc/Doxygen/html/index.html
-firefox html/index.html