From 9a6b2185b380908566259406c19c735a7000c477 Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Fri, 23 Jun 2006 20:33:44 +0000 Subject: [PATCH] Additions to doxygen documentation. Fixes to doxygen docs -> eliminated all of the warnings and ommitted pages. --- tools/doc/.cvsignore | 1 + tools/doc/Cantera.cfg.in | 9 +++++++-- tools/doc/doxyinput/cxx-setup.txt | 7 +++++++ tools/doc/doxyinput/equildemo.txt | 2 +- tools/doc/doxyinput/thermodemo.txt | 2 +- tools/doc/doxyinput/winbuild.txt | 9 +++++++++ tools/doc/html/.cvsignore | 2 ++ 7 files changed, 28 insertions(+), 4 deletions(-) create mode 100644 tools/doc/doxyinput/cxx-setup.txt create mode 100644 tools/doc/doxyinput/winbuild.txt diff --git a/tools/doc/.cvsignore b/tools/doc/.cvsignore index f3c7a7c5d..ffc15abf8 100644 --- a/tools/doc/.cvsignore +++ b/tools/doc/.cvsignore @@ -1 +1,2 @@ Makefile +Cantera.cfg diff --git a/tools/doc/Cantera.cfg.in b/tools/doc/Cantera.cfg.in index 9b2df247e..bc2237b62 100755 --- a/tools/doc/Cantera.cfg.in +++ b/tools/doc/Cantera.cfg.in @@ -100,7 +100,11 @@ FILE_PATTERNS = Kinetics.h \ State.h \ Constituents.h \ Phase.h \ - utilities.h + utilities.h \ + VPStandardStateTP.h VPStandardStateTP.cpp \ + MolalityVPSSTP.h MolalityVPSSTP.cpp \ + IdealMolalSoln.h IdealMolalSoln.cpp \ + IdealSolidSolnPhase.h IdealSolidSolnPhase.cpp RECURSIVE = NO EXCLUDE = CVS examples converters zeroD EXCLUDE_SYMLINKS = NO @@ -112,7 +116,8 @@ EXCLUDE_PATTERNS = *old/* \ *test/* \ *tests/* EXAMPLE_PATH = ../../examples \ - ../../data/inputs + ../../data/inputs \ + ./doxyinput EXAMPLE_PATTERNS = *.cpp \ *.h EXAMPLE_RECURSIVE = NO diff --git a/tools/doc/doxyinput/cxx-setup.txt b/tools/doc/doxyinput/cxx-setup.txt new file mode 100644 index 000000000..ff8765e5b --- /dev/null +++ b/tools/doc/doxyinput/cxx-setup.txt @@ -0,0 +1,7 @@ +/** + +\page cxx-setup C++ setup + + Coming soon + +*/ diff --git a/tools/doc/doxyinput/equildemo.txt b/tools/doc/doxyinput/equildemo.txt index 2c1858fb5..0062bf7c2 100644 --- a/tools/doc/doxyinput/equildemo.txt +++ b/tools/doc/doxyinput/equildemo.txt @@ -1,7 +1,7 @@ /** \page cxx-equildemo A C++ Chemical Equilibrium Program -. In the program below, the \c equilibrate function is called to set the +In the program below, the \c equilibrate function is called to set the gas to a state of chemical equilibrium, holding the temperature and pressure fixed. This function is declared in the equilibrium.h header file. diff --git a/tools/doc/doxyinput/thermodemo.txt b/tools/doc/doxyinput/thermodemo.txt index aed01bcf5..a0ade425f 100644 --- a/tools/doc/doxyinput/thermodemo.txt +++ b/tools/doc/doxyinput/thermodemo.txt @@ -1,7 +1,7 @@ /** \page cxx-thermodemo A C++ Thermodynamics Properties Program -. In the program below, a gas mixture object is created, and a few thermodynamic properties are computed and printed out. +In the program below, a gas mixture object is created, and a few thermodynamic properties are computed and printed out. \include thermodemo.cpp diff --git a/tools/doc/doxyinput/winbuild.txt b/tools/doc/doxyinput/winbuild.txt new file mode 100644 index 000000000..c0a9f7edf --- /dev/null +++ b/tools/doc/doxyinput/winbuild.txt @@ -0,0 +1,9 @@ +/** + +\page cantera-winbuild Building Cantera on a Windows platform + +Coming soon + +\section ctbuild-sysreq System Requirements + +*/ diff --git a/tools/doc/html/.cvsignore b/tools/doc/html/.cvsignore index 7164c30a3..7f8de4b2d 100644 --- a/tools/doc/html/.cvsignore +++ b/tools/doc/html/.cvsignore @@ -7,3 +7,5 @@ *.hhk *.hhp *.map +*.css +formula.repository