| <?xml version="1.0" encoding="utf-8"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> |
| <head> |
| |
| <meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <title>Building the Doxygen help for OpenFOAM</title> |
| <meta name="generator" content="Org mode" /> |
| <style type="text/css"> |
| <!-- |
| .title { text-align: center; |
| margin-bottom: .2em; } |
| .subtitle { text-align: center; |
| font-size: medium; |
| font-weight: bold; |
| margin-top:0; } |
| .todo { font-family: monospace; color: red; } |
| .done { font-family: monospace; color: green; } |
| .priority { font-family: monospace; color: orange; } |
| .tag { background-color: #eee; font-family: monospace; |
| padding: 2px; font-size: 80%; font-weight: normal; } |
| .timestamp { color: #bebebe; } |
| .timestamp-kwd { color: #5f9ea0; } |
| .org-right { margin-left: auto; margin-right: 0px; text-align: right; } |
| .org-left { margin-left: 0px; margin-right: auto; text-align: left; } |
| .org-center { margin-left: auto; margin-right: auto; text-align: center; } |
| .underline { text-decoration: underline; } |
| #postamble p, #preamble p { font-size: 90%; margin: .2em; } |
| p.verse { margin-left: 3%; } |
| pre { |
| border: 1px solid #ccc; |
| box-shadow: 3px 3px 3px #eee; |
| padding: 8pt; |
| font-family: monospace; |
| overflow: auto; |
| margin: 1.2em; |
| } |
| pre.src { |
| position: relative; |
| overflow: visible; |
| padding-top: 1.2em; |
| } |
| pre.src:before { |
| display: none; |
| position: absolute; |
| background-color: white; |
| top: -10px; |
| right: 10px; |
| padding: 3px; |
| border: 1px solid black; |
| } |
| pre.src:hover:before { display: inline;} |
| |
| pre.src-asymptote:before { content: 'Asymptote'; } |
| pre.src-awk:before { content: 'Awk'; } |
| pre.src-C:before { content: 'C'; } |
| |
| pre.src-clojure:before { content: 'Clojure'; } |
| pre.src-css:before { content: 'CSS'; } |
| pre.src-D:before { content: 'D'; } |
| pre.src-ditaa:before { content: 'ditaa'; } |
| pre.src-dot:before { content: 'Graphviz'; } |
| pre.src-calc:before { content: 'Emacs Calc'; } |
| pre.src-emacs-lisp:before { content: 'Emacs Lisp'; } |
| pre.src-fortran:before { content: 'Fortran'; } |
| pre.src-gnuplot:before { content: 'gnuplot'; } |
| pre.src-haskell:before { content: 'Haskell'; } |
| pre.src-hledger:before { content: 'hledger'; } |
| pre.src-java:before { content: 'Java'; } |
| pre.src-js:before { content: 'Javascript'; } |
| pre.src-latex:before { content: 'LaTeX'; } |
| pre.src-ledger:before { content: 'Ledger'; } |
| pre.src-lisp:before { content: 'Lisp'; } |
| pre.src-lilypond:before { content: 'Lilypond'; } |
| pre.src-lua:before { content: 'Lua'; } |
| pre.src-matlab:before { content: 'MATLAB'; } |
| pre.src-mscgen:before { content: 'Mscgen'; } |
| pre.src-ocaml:before { content: 'Objective Caml'; } |
| pre.src-octave:before { content: 'Octave'; } |
| pre.src-org:before { content: 'Org mode'; } |
| pre.src-oz:before { content: 'OZ'; } |
| pre.src-plantuml:before { content: 'Plantuml'; } |
| pre.src-processing:before { content: 'Processing.js'; } |
| pre.src-python:before { content: 'Python'; } |
| pre.src-R:before { content: 'R'; } |
| pre.src-ruby:before { content: 'Ruby'; } |
| pre.src-sass:before { content: 'Sass'; } |
| pre.src-scheme:before { content: 'Scheme'; } |
| pre.src-screen:before { content: 'Gnu Screen'; } |
| pre.src-sed:before { content: 'Sed'; } |
| pre.src-sh:before { content: 'shell'; } |
| pre.src-sql:before { content: 'SQL'; } |
| pre.src-sqlite:before { content: 'SQLite'; } |
| |
| pre.src-forth:before { content: 'Forth'; } |
| pre.src-io:before { content: 'IO'; } |
| pre.src-J:before { content: 'J'; } |
| pre.src-makefile:before { content: 'Makefile'; } |
| pre.src-maxima:before { content: 'Maxima'; } |
| pre.src-perl:before { content: 'Perl'; } |
| pre.src-picolisp:before { content: 'Pico Lisp'; } |
| pre.src-scala:before { content: 'Scala'; } |
| pre.src-shell:before { content: 'Shell Script'; } |
| pre.src-ebnf2ps:before { content: 'ebfn2ps'; } |
| |
| |
| pre.src-cpp:before { content: 'C++'; } |
| pre.src-abc:before { content: 'ABC'; } |
| pre.src-coq:before { content: 'Coq'; } |
| pre.src-groovy:before { content: 'Groovy'; } |
| |
| |
| |
| pre.src-bash:before { content: 'bash'; } |
| pre.src-csh:before { content: 'csh'; } |
| pre.src-ash:before { content: 'ash'; } |
| pre.src-dash:before { content: 'dash'; } |
| pre.src-ksh:before { content: 'ksh'; } |
| pre.src-mksh:before { content: 'mksh'; } |
| pre.src-posh:before { content: 'posh'; } |
| |
| pre.src-ada:before { content: 'Ada'; } |
| pre.src-asm:before { content: 'Assembler'; } |
| pre.src-caml:before { content: 'Caml'; } |
| pre.src-delphi:before { content: 'Delphi'; } |
| pre.src-html:before { content: 'HTML'; } |
| pre.src-idl:before { content: 'IDL'; } |
| pre.src-mercury:before { content: 'Mercury'; } |
| pre.src-metapost:before { content: 'MetaPost'; } |
| pre.src-modula-2:before { content: 'Modula-2'; } |
| pre.src-pascal:before { content: 'Pascal'; } |
| pre.src-ps:before { content: 'PostScript'; } |
| pre.src-prolog:before { content: 'Prolog'; } |
| pre.src-simula:before { content: 'Simula'; } |
| pre.src-tcl:before { content: 'tcl'; } |
| pre.src-tex:before { content: 'TeX'; } |
| pre.src-plain-tex:before { content: 'Plain TeX'; } |
| pre.src-verilog:before { content: 'Verilog'; } |
| pre.src-vhdl:before { content: 'VHDL'; } |
| pre.src-xml:before { content: 'XML'; } |
| pre.src-nxml:before { content: 'XML'; } |
| |
| |
| pre.src-conf:before { content: 'Configuration File'; } |
| |
| table { border-collapse:collapse; } |
| caption.t-above { caption-side: top; } |
| caption.t-bottom { caption-side: bottom; } |
| td, th { vertical-align:top; } |
| th.org-right { text-align: center; } |
| th.org-left { text-align: center; } |
| th.org-center { text-align: center; } |
| td.org-right { text-align: right; } |
| td.org-left { text-align: left; } |
| td.org-center { text-align: center; } |
| dt { font-weight: bold; } |
| .footpara { display: inline; } |
| .footdef { margin-bottom: 1em; } |
| .figure { padding: 1em; } |
| .figure p { text-align: center; } |
| .inlinetask { |
| padding: 10px; |
| border: 2px solid gray; |
| margin: 10px; |
| background: #ffffcc; |
| } |
| #org-div-home-and-up |
| { text-align: right; font-size: 70%; white-space: nowrap; } |
| textarea { overflow-x: auto; } |
| .linenr { font-size: smaller } |
| .code-highlighted { background-color: #ffff00; } |
| .org-info-js_info-navigation { border-style: none; } |
| #org-info-js_console-label |
| { font-size: 10px; font-weight: bold; white-space: nowrap; } |
| .org-info-js_search-highlight |
| { background-color: #ffff00; color: #000000; font-weight: bold; } |
| .org-svg { width: 90%; } |
| --> |
| </style> |
| <script type="text/javascript"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <!-- |
| function CodeHighlightOn(elem, id) |
| { |
| var target = document.getElementById(id); |
| if(null != target) { |
| elem.cacheClassElem = elem.className; |
| elem.cacheClassTarget = target.className; |
| target.className = "code-highlighted"; |
| elem.className = "code-highlighted"; |
| } |
| } |
| function CodeHighlightOff(elem, id) |
| { |
| var target = document.getElementById(id); |
| if(elem.cacheClassElem) |
| elem.className = elem.cacheClassElem; |
| if(elem.cacheClassTarget) |
| target.className = elem.cacheClassTarget; |
| } |
| |
| </script> |
| <script type="text/x-mathjax-config"> |
| MathJax.Hub.Config({ |
| displayAlign: "center", |
| displayIndent: "0em", |
| |
| "HTML-CSS": { scale: 100, |
| linebreaks: { automatic: "false" }, |
| webFont: "TeX" |
| }, |
| SVG: {scale: 100, |
| linebreaks: { automatic: "false" }, |
| font: "TeX"}, |
| NativeMML: {scale: 100}, |
| TeX: { equationNumbers: {autoNumber: "AMS"}, |
| MultLineWidth: "85%", |
| TagSide: "right", |
| TagIndent: ".8em" |
| } |
| }); |
| </script> |
| <script type="text/javascript" |
| src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS_HTML"></script> |
| </head> |
| <body> |
| <div id="content"> |
| <h1 class="title">Building the Doxygen help for OpenFOAM</h1> |
| <div id="table-of-contents"> |
| <h2>Table of Contents</h2> |
| <div id="text-table-of-contents"> |
| <ul> |
| <li><a href="#org82328a7">1. Doxygen</a></li> |
| <li><a href="#orgb35a0b8">2. Configuration</a></li> |
| <li><a href="#orgadf2d2f">3. Running Doxygen</a></li> |
| </ul> |
| </div> |
| </div> |
|
|
| <div id="outline-container-org82328a7" class="outline-2"> |
| <h2 id="org82328a7"><span class="section-number-2">1</span> Doxygen</h2> |
| <div class="outline-text-2" id="text-1"> |
| <p> |
| The HTML documentation of OpenFOAM can be built using the Doxygen software. |
| Images in the documentation are generated using "dot", a program within the |
| graphviz software package. To build the documentation on the Ubuntu GNU/Linux |
| system, for example, the user should install both <code>doxygen</code> and <code>graphviz</code> |
| packages, e.g. by typing in a terminal window: |
| </p> |
|
|
| <ul class="org-ul"> |
| <li><code>sudo apt-get install doxygen graphviz</code></li> |
| </ul> |
|
|
| <p> |
| The Doxygen documentation will build automatically for a user that is |
| configured to run OpenFOAM, i.e. has environment variables such as |
| <code>$WM_PROJECT_DIR</code> set. The user must also ensure they have write |
| permission for the directory that Doxygen writes files to. |
| </p> |
| </div> |
| </div> |
|
|
| <div id="outline-container-orgb35a0b8" class="outline-2"> |
| <h2 id="orgb35a0b8"><span class="section-number-2">2</span> Configuration</h2> |
| <div class="outline-text-2" id="text-2"> |
| <p> |
| The Doxygen configuration file, Doxyfile, in the <code>$WM_PROJECT_DIR/doc/Doxygen</code> |
| directory is configured to work with Doxygen versions 1.6.3-1.8.5. |
| </p> |
|
|
| <p> |
| The Header, Footer, and Stylesheet are generated automatically: |
| </p> |
|
|
| <ul class="org-ul"> |
| <li><code>doxygen -w html header.html footer.html customdoxygen.css</code></li> |
| </ul> |
|
|
| <p> |
| See: <a href="https://www.stack.nl/~dimitri/doxygen/manual/customize.html">https://www.stack.nl/~dimitri/doxygen/manual/customize.html</a> |
| </p> |
| </div> |
| </div> |
|
|
| <div id="outline-container-orgadf2d2f" class="outline-2"> |
| <h2 id="orgadf2d2f"><span class="section-number-2">3</span> Running Doxygen</h2> |
| <div class="outline-text-2" id="text-3"> |
| <p> |
| In the <code>$WM_PROJECT_DIR/doc/Doxygen</code> directory type |
| </p> |
| <ul class="org-ul"> |
| <li><code>./Allwmake</code></li> |
| </ul> |
|
|
| <p> |
| which will generate the <code>$WM_PROJECT_DIR/doc/Doxygen/html</code> directory |
| containing the OpenFOAM source code documentation. Load the <code>index.html</code> file |
| into a browser, \e.g.\ |
| </p> |
| <ul class="org-ul"> |
| <li><code>firefox html/index.html</code></li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div id="postamble" class="status"> |
| <p class="date">Date: 11nd June 2023</p> |
| <p class="date">Created: 2023-07-11 Tue 16:44</p> |
| <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> |
| </div> |
| </body> |
| </html> |
|
|
