research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

updating doxygen files to try to get this guy working

Browse source
This commit is contained in:
Nicholas Malaya 2012-07-18 23:34:10 +00:00
parent e25c671ee8
commit ab4e791ba8
9 changed files with 137 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/doxygen/aminclude.am
View file

@ -3,10 +3,10 @@
# dependencies here.
#-----------------------------------
PECOS_extra_dependencies = doxygen/cantera.page \
doxygen/txt_common/about.page \
doxygen/txt_common/gpl.page \
doxygen/txt_common/acknowledgment.page
PECOS_extra_dependencies = doc/doxygen/cantera.page \
doc/doxygen/txt_common/about.page \
doc/doxygen/txt_common/gpl.page \
doc/doxygen/txt_common/acknowledgment.page
## --------------------------------- ##
## Format-independent Doxygen rules. ##

6
doc/doxygen/cantera.page
View file

@ -1,4 +1,4 @@
/*! \mainpage The CORE Library
/*! \mainpage The cantera Library
<b>Version \version</b>, Build Date: \builddate
@ -7,13 +7,13 @@ Built by: \builduser on \buildhost
\section overview Overview
Thank you for your interest in CORE. To aid in usage, this manual is
Thank you for your interest in cantera. To aid in usage, this manual is
further divided into the following subsections:
<ul>
<li> \subpage model "Library Overview" </li>
<li> \subpage install "Installation/Linkage" </li>
<li> \link core.h C/C++ Interface \endlink </li>
<li> \link cantera.h C/C++ Interface \endlink </li>
<li> \subpage apif "Fortran Interface" </li>
<li> \link tut "Tutorial" </li>
</ul>

39
doc/doxygen/txt_common/about.page Normal file
View file

@ -0,0 +1,39 @@
/*! \page About
\htmlonly
<table border="0" width="660" >
<tr><td width=95> <img src="circle-logo-small.png" /> </td>
<td>
The <a href="http://pecos.ices.utexas.edu">Center for
Predictive Engineering and Computational Sciences</a> (PECOS)
is one of five US centers sponsored under the Predictive
Science Academic Alliance Program (PSAAP) of the National
Nuclear Security Administration's Advanced Simulation and
Computing Program. The PECOS center is housed within
the <a href="http://www.ices.utexas.edu">Institute for
Computational Engineering and Sciences (ICES) </a> at the
<a href="http://www.utexas.edu">University of Texas at
Austin</a>. For additional information or questions regarding
the PECOS center, please contact <a href="mailto:info@pecos.ices.utexas.edu">info@pecos.ices.utexas.edu</a>.
</td>
</tr>
</table>
\endhtmlonly
\latexonly
\begin{tabular}{m{2.2cm} m{0.80\textwidth} }
\includegraphics[width=2cm]{../../doxygen/fig_common/circle-logo.pdf} &
The \href{http://pecos.ices.utexas.edu}{Center for Predictive
Engineering and Computational Sciences} (PECOS) is one of five US
centers sponsored under the Predictive Science Academic Alliance
Program (PSAAP) of the National Nuclear Security Administration's
Advanced Simulation and Computing Program. The PECOS center is housed
within the \href{http://www.ices.utexas.edu}{Institute for
Computational Engineering and Sciences} (ICES) at the
\href{http://www.utexas.edu"}{University of Texas at Austin}. For
additional information or questions regarding the PECOS center, please
contact info@pecos.ices.utexas.edu.
\end{tabular}
\endlatexonly
*/

39
doc/doxygen/txt_common/about_vpath.page.in Normal file
View file

@ -0,0 +1,39 @@
/*! \page About2
\htmlonly
<table border="0" width="660" >
<tr><td width=95> <img src="circle-logo-small.png" /> </td>
<td>
The <a href="http://pecos.ices.utexas.edu">Center for
Predictive Engineering and Computational Sciences</a> (PECOS)
is one of five US centers sponsored under the Predictive
Science Academic Alliance Program (PSAAP) of the National
Nuclear Security Administration's Advanced Simulation and
Computing Program. The PECOS center is housed within
the <a href="http://www.ices.utexas.edu">Institute for
Computational Engineering and Sciences (ICES) </a> at the
<a href="http://www.utexas.edu">University of Texas at
Austin</a>. For additional information or questions regarding
the PECOS center, please contact <a href="mailto:info@pecos.ices.utexas.edu">info@pecos.ices.utexas.edu</a>.
</td>
</tr>
</table>
\endhtmlonly
\latexonly
\begin{tabular}{m{2.2cm} m{0.80\textwidth} }
\includegraphics[width=2cm]{@abs_top_srcdir@/doxygen/fig_common/circle-logo.pdf} &
The \href{http://pecos.ices.utexas.edu}{Center for Predictive
Engineering and Computational Sciences} (PECOS) is one of five US
centers sponsored under the Predictive Science Academic Alliance
Program (PSAAP) of the National Nuclear Security Administration's
Advanced Simulation and Computing Program. The PECOS center is housed
within the \href{http://www.ices.utexas.edu}{Institute for
Computational Engineering and Sciences} (ICES) at the
\href{http://www.utexas.edu"}{University of Texas at Austin}. For
additional information or questions regarding the PECOS center, please
contact info@pecos.ices.utexas.edu.
\end{tabular}
\endlatexonly
*/

7
doc/doxygen/txt_common/acknowledgment.page Normal file
View file

@ -0,0 +1,7 @@
/*! \page Acknowledgments
This material is based in part upon work supported by the Department
of Energy National Nuclear Security Administration under Award
Number \e DE-FC52-08NA28615.
*/

8
doc/doxygen/txt_common/footer.html Normal file
View file

@ -0,0 +1,8 @@
<hr size="1"/><address style="text-align: right;"><small>
Generated on $datetime for $projectname
by&nbsp;<a href="http://www.doxygen.org/index.html">
<em>doxygen</em></a>
$doxygenversion</small></address>
</body>
</html>

13
doc/doxygen/txt_common/gpl.page Normal file
View file

@ -0,0 +1,13 @@
/*! \page License
<br>
This program is free software; you can redistribute it and/or modify
it under the terms of the Version 2 GNU General Public License as published by
the Free Software Foundation.<br>
<br>
This program 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
<a href="http://www.gnu.org/licenses/gpl-2.0.html">GNU General Public License</a>
for more details.
*/

13
doc/doxygen/txt_common/lgpl.page Normal file
View file

@ -0,0 +1,13 @@
/*! \page LicenseLGPL
This library is free software; you can redistribute it and/or
modify it under the terms of the Version 2.1 GNU Lesser General
Public License as published by the Free Software Foundation.
This library 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
<a href="http://www.gnu.org/licenses/lgpl-2.1.txt">GNU Lesser General
Public License </a> for more details.
*/

11
doc/doxygen/txt_common/noop.page Normal file
View file

@ -0,0 +1,11 @@
/*! \page NOOP
Note: This page does not contain any useful documentation (sorry). It
is used to include graphics to trick doxygen into copying them for us.
We apologize for the hackery in advance.
\image html circle-logo-small.png
\b 42.
*/