Additions to doxygen documentation.
Fixes to doxygen docs -> eliminated all of the warnings and ommitted pages.
This commit is contained in:
parent
cfdd7d7293
commit
9a6b2185b3
7 changed files with 28 additions and 4 deletions
|
|
@ -1 +1,2 @@
|
|||
Makefile
|
||||
Cantera.cfg
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
7
tools/doc/doxyinput/cxx-setup.txt
Normal file
7
tools/doc/doxyinput/cxx-setup.txt
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
|
||||
\page cxx-setup C++ setup
|
||||
|
||||
Coming soon
|
||||
|
||||
*/
|
||||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
9
tools/doc/doxyinput/winbuild.txt
Normal file
9
tools/doc/doxyinput/winbuild.txt
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
/**
|
||||
|
||||
\page cantera-winbuild Building Cantera on a Windows platform
|
||||
|
||||
Coming soon
|
||||
|
||||
\section ctbuild-sysreq System Requirements
|
||||
|
||||
*/
|
||||
|
|
@ -7,3 +7,5 @@
|
|||
*.hhk
|
||||
*.hhp
|
||||
*.map
|
||||
*.css
|
||||
formula.repository
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue