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"> + + + Building the Doxygen help for OpenFOAM - - - + + +
@@ -141,15 +255,15 @@ for the JavaScript code in this tag.

Table of Contents

-
-

1 Doxygen

+
+

1 Doxygen

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.

-
-

2 Configuration

+
+

2 Configuration

-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

-
-

3 Running Doxygen

+
+

3 Running Doxygen

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
-

Date: 18th June 2016

-

Created: 2016-06-18 Sat 10:13

-

Emacs 24.5 (Org mode 8.2.10)

+

Date: 11nd June 2023

+

Created: 2023-07-11 Tue 16:44

Validate

diff --git a/doc/Doxygen/README.org b/doc/Doxygen/README.org index 07568578a4..eb22760aec 100644 --- a/doc/Doxygen/README.org +++ b/doc/Doxygen/README.org @@ -2,10 +2,10 @@ # #+TITLE: Building the Doxygen help for OpenFOAM #+AUTHOR: The OpenFOAM Foundation -#+DATE: 18th June 2016 +#+DATE: 11nd June 2023 #+LINK: http://www.openfoam.org #+OPTIONS: author:nil ^:{} -# Copyright (c) 2015-2016 OpenFOAM Foundation. +# Copyright (c) 2015-2023 OpenFOAM Foundation. * Doxygen The HTML documentation of OpenFOAM can be built using the Doxygen software. @@ -22,7 +22,7 @@ permission for the directory that Doxygen writes files to. * Configuration - 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: