Select Git revision
compile_documentation.html
Forked from
Nektar / Nektar
Source project has a limited visibility.
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
compile_documentation.html 5.61 KiB
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<!-- InstanceBegin template="/Templates/Main.dwt" codeOutsideHTMLIsLocked="false" -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="shortcut icon" href="images/favicon.ico" >
<!-- InstanceBeginEditable name="doctitle" -->
<title>Nektar++ - Generate doxygen documentation</title>
<!-- InstanceEndEditable -->
<link rel="stylesheet" href="style.css"> <!-- InstanceBeginEditable name="CSS_Style" -->
<style type="text/css">
<!--
#menu_CompileDocumentation {
font-weight: bold;
}
-->
</style>
<!-- InstanceEndEditable -->
<!--[if IE]>
<style type="text/css">
.twoColHybLt #sidebar1 { padding-top: 30px; margin-top: 20px; }
.twoColHybLt #mainContent { zoom: 1; padding-top: 15px; }
</style>
<![endif]-->
<!-- InstanceParam name="LibraryMenu" type="boolean" value="false" -->
<!-- InstanceParam name="CompileMenu" type="boolean" value="true" -->
</head>
<body class="twoColHybLt">
<div id="container">
<div id="sidebar1">
<h3 style="text-align: center;">
<a href="index.html" id="menu_Nektar">
<img src="images/nektar.png" alt="Nektar++" width="155" height="38" />
</a>
</h3>
<p><a href="downloads.html" id="menu_Downloads">Downloads</a></p>
<p><a href="compile.html" id="menu_Compile">Compilation Instructions</a>
<br/>
<a href="compile_linux.html" id="menu_CompileLinux">Linux</a><br/>
<a href="compile_windows.html" id="menu_CompileWindows">Windows</a><br/>
<a href="compile_osx.html" id="menu_CompileOSX">Mac OS X</a><br/>
<a href="compile_unit_tests.html" id="menu_CompileUnitTests">Unit Tests</a><br/>
<a href="compile_regression_tests.html" id="menu_CompileRegressionTests">Regression Tests</a><br/>
<a href="compile_documentation.html" id="menu_CompileDocumentation">Documentation</a><br/>
</p>
<p><a href="usage.html" id="menu_Usage">Example Usage</a></p>
<p><a href="educational_material.html" id="menu_EducationalMaterial">Educational
Material</a></p>
<p><a href="code/index.html" id="menu_Library">Documentation</a></p>
<p><a href="team.html" id="menu_Team">Team Members</a></p>
<p><a href="publications.html" id="menu_Publications">Publications</a></p>
<p><a href="license.html" id="menu_License">License</a></p>
<p><a href="acknowledgments.html" id="menu_Acknowledgments">Acknowledgments</a></p>
<p><a href="mailto:nektar-inquiry@sci.utah.edu" id="menu_Contact">Contact</a></p>
</div>
<div id="mainContent">
<!-- InstanceBeginEditable name="Title" -->
<h1>Generate Doxygen Documentation</h1>
<!-- InstanceEndEditable -->
<hr/>
<p>
Nektar++ uses the documentation system <em> Doxygen </em> for generating documentation. The Doxygen HTML files are not included in the tarball because the size prohibits it. To generate the full documentation, follow the steps below:
<ol>
<li>Required packages</li>
<ul>
<li><strong>Doxygen</strong><br />