diff --git a/doc/Doxygen/Doxyfile b/doc/Doxygen/Doxyfile index dfadd481f3..908fa543b9 100644 --- a/doc/Doxygen/Doxyfile +++ b/doc/Doxygen/Doxyfile @@ -14,14 +14,6 @@ # Project related configuration options #--------------------------------------------------------------------------- - -#-------------------------------- -# PATH FOR OPEN CFD LATEX MACROS -#------------------------------- - -@INLUDE_PATH = $(WM_PROJECT_DIR)/doc/Doxygen/Macros/ - - # This tag specifies the encoding used for all characters in the config file that # follow. The default is UTF-8 which is also the encoding used for all text before # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into @@ -485,11 +477,9 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = #$(WM_PROJECT_DIR)/src \ - #$(WM_PROJECT_DIR)/applications/utilities \ - #$(WM_PROJECT_DIR)/applications/solvers - - +INPUT = $(WM_PROJECT_DIR)/src \ + $(WM_PROJECT_DIR)/applications/utilities \ + $(WM_PROJECT_DIR)/applications/solvers # This tag can be used to specify the character encoding of the source files that # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default @@ -546,8 +536,8 @@ EXCLUDE_SYMBOLS = # directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = - +EXAMPLE_PATH = + # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp @@ -798,6 +788,10 @@ TREEVIEW_WIDTH = 250 # configuration options related to the LaTeX output #--------------------------------------------------------------------------- +# Path for OpenCFD LaTeX macros + +@INCLUDE_PATH = $(WM_PROJECT_DIR)/doc/Doxygen/Macros/ + # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. @@ -837,7 +831,6 @@ PAPER_TYPE = a4wide EXTRA_PACKAGES = $(WM_PROJECT_DIR)/doc/Doxygen/Macros/tensorOperator - # The LATEX_HEADER tag can be used to specify a personal LaTeX header for # the generated latex document. The header should contain everything until # the first chapter. If it is left blank doxygen will generate a diff --git a/doc/Doxygen/Macros/tensorOperator.sty b/doc/Doxygen/Macros/tensorOperator.sty index 6a2c5674d0..2b027493a8 100644 --- a/doc/Doxygen/Macros/tensorOperator.sty +++ b/doc/Doxygen/Macros/tensorOperator.sty @@ -1,3 +1,35 @@ +%----------------------------------------------------------------------------- +% ========= | +% \\ / F ield | OpenFOAM: The Open Source CFD Toolbox +% \\ / O peration | +% \\ / A nd | Copyright (C) 1991-2008 OpenCFD Ltd. +% \\/ M anipulation | +%------------------------------------------------------------------------------ +% License +% This file is part of OpenFOAM. +% +% OpenFOAM is free software; you can redistribute it and/or modify it +% under the terms of the GNU General Public License as published by the +% Free Software Foundation; either version 2 of the License, or (at your +% option) any later version. +% +% OpenFOAM is distributed in the hope that it will be useful, but WITHOUT +% ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +% FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +% for more details. +% +% You should have received a copy of the GNU General Public License +% along with OpenFOAM; if not, write to the Free Software Foundation, +% Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +% +% LaTeX Style file +% tensorOperator.sty +% +% Description +% Standard OpenCFD LaTeX macros for typesetting tensor algebra. +% +%------------------------------------------------------------------------------ + % tensor style % ~~~~~~~~~~~~ \renewcommand{\vec}[1] {\ensuremath{\mathbf #1}} @@ -9,8 +41,7 @@ \newcommand{\cprod} {\times} \newcommand{\dprod} {\,{\scriptscriptstyle \stackrel{\bullet}{{}}}\,} \newcommand{\ddprod} {\,{\scriptscriptstyle \stackrel{\bullet}{\bullet}}\,} -\newcommand{\tdprod}% - {\,{\scriptscriptstyle \stackrel{3}{\bullet}}\,} +\newcommand{\tdprod} {\,{\scriptscriptstyle \stackrel{3}{\bullet}}\,} \newcommand{\tprod} {\,{\scriptscriptstyle \stackrel{\otimes}{{}}}\,} % operations @@ -30,7 +61,7 @@ \newcommand{\tr} {\ensuremath{\operatorname{tr}}} \newcommand{\trans}[1] {\ensuremath{#1^{\operatorname{T}}}} -% alternative tensor operators for hypersonics etc. +% alternative tensor operators for hypersonics etc. % ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ \newcommand{\devs}[1] {\overset{\scriptscriptstyle\circ}{#1}} %\newcommand{\trans}[1] {\ensuremath{#1^{\operatorname{T}}}} @@ -90,7 +121,9 @@ % unknown use % ~~~~~~~~~~~ -%\newcommand{\goesto} {\!\rightarrow\!} %\font\bigtenrm=cmr12 scaled 1200 %\newcommand{\eexp}[1]{{\hbox{$\textfont1=\bigtenrm e$}}^{\raise3pt %\hbox{$#1$}}} + + +% ------------------------------------------------------------------------------