102 lines
5.6 KiB
HTML
102 lines
5.6 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.16"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EPANET: Generating Documentation for OWA-EPANET 2.2</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">EPANET
|
|
 <span id="projectnumber">2.2.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.16 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="PageDoc"><div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Generating Documentation for OWA-EPANET 2.2 </div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><p>You must have <a href="http://www.doxygen.nl">Doxygen</a> installed on your machine to generate documentation for the OWA-EPANET Toolkit. Assuming this is the case, open a terminal window, navigate to the project's <code>doc</code> directory and issue the command <code>doxygen</code>. This will generate HTML documentation placed in a sub-directory named <code>html</code>. From that directory you can launch the <code>index.html</code> file to view the full documentation in a web browser.</p>
|
|
<p>To generate a Windows compiled HTML Help file you must have <a href="https://www.microsoft.com/en-us/download/details.aspx?id=21138">Microsoft's HTML Help Workshop</a> installed. You then need to edit the Doxygen configuration file <code>doxyfile</code> as follows:</p>
|
|
<ol type="1">
|
|
<li>Change the <code>GENERATE_HTMLHELP</code> setting to <code>YES</code>.</li>
|
|
<li>Enter the location where the Help Workshop system was installed next to the <code>HHC_LOCATION</code> setting.</li>
|
|
</ol>
|
|
<p>After running Doxygen again the resulting Help file named <code>owa-epanet.chm</code> will appear in the <code>html</code> sub-directory.</p>
|
|
<p>Doxygen uses the special comments placed in the project's <code>epanet2_2.h</code> and <code>epanet2_enums.h</code> header files to document EPANET's API. It also uses supplementary material contained in the following files of the project's <code>doc</code> directory to generate additional pages of documentation:</p>
|
|
<ul>
|
|
<li><code>main.dox</code>: generates the <em>Overview</em> section.</li>
|
|
<li><code>usage.dox</code>: generates the <em>Usage</em> section.</li>
|
|
<li><code>toolkit-examples.dox</code> : generates the <em>Examples</em> section.</li>
|
|
<li><code>toolkit-files.dox</code>: generates the <em>Toolkit Files</em> section.</li>
|
|
<li><code>input-file.dox</code>: generates the <em>Input File</em> sub-section.</li>
|
|
<li><code>toolkit-units.dox</code>: generates the <em>Measurement Units</em> section.</li>
|
|
<li><code>modules.dox</code>: defines the contents of the <em>API Reference</em> section.</li>
|
|
</ul>
|
|
<p>Finally, a group of special Doxygen files are used to customize the format of the generated documentation. These include the following:</p><ul>
|
|
<li><code>doxyfile</code>: the main Doxygen configuration file</li>
|
|
<li><code>DoxygenLayout.xml</code>: sets the title of the automatically generated <em>Modules</em> section to <em>API Reference</em> and hides the <em>Files</em> section in the tree view pane of the document.</li>
|
|
<li><code>extrastylesheet.css</code>: reduces the size of the the h1 heading style.</li>
|
|
<li><code>newfooter.html</code>: replaces the default Doxygen footer in HTML output with a custom one. </li>
|
|
</ul>
|
|
</div></div><!-- contents -->
|
|
</div><!-- PageDoc -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.16
|
|
</small></address>
|
|
</body>
|
|
</html>
|