Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature doxygen #68

Merged
merged 3 commits into from
Sep 28, 2017
Merged

Feature doxygen #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c918a1e
Added doxygen configuration file 'Doxyfile'
dschlaep Sep 23, 2017
bab744c
Bare-bones html documentation
dschlaep Sep 23, 2017
ac6824a
Merge branch 'master' into feature_doxygen
dschlaep Sep 28, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2,473 changes: 2,473 additions & 0 deletions Doxyfile
View file
Open in desktop

Large diffs are not rendered by default.

99 changes: 99 additions & 0 deletions doc/html/_r_e_a_d_m_e_8md.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SOILWAT2: README.md File Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</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">SOILWAT2
&#160;<span id="projectnumber">3.2.7</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('_r_e_a_d_m_e_8md.html','');});
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle">
<div class="title">README.md File Reference</div> </div>
</div><!--header-->
<div class="contents">
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="_r_e_a_d_m_e_8md.html">README.md</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>
243 changes: 243 additions & 0 deletions doc/html/_s_w___control_8c.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,243 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SOILWAT2: SW_Control.c File Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</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">SOILWAT2
&#160;<span id="projectnumber">3.2.7</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('_s_w___control_8c.html','');});
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">SW_Control.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &quot;<a class="el" href="generic_8h_source.html">generic.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="filefuncs_8h_source.html">filefuncs.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="rands_8h_source.html">rands.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_s_w___defines_8h_source.html">SW_Defines.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_s_w___files_8h_source.html">SW_Files.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_s_w___control_8h_source.html">SW_Control.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_s_w___model_8h_source.html">SW_Model.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_s_w___output_8h_source.html">SW_Output.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_s_w___site_8h_source.html">SW_Site.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_s_w___soil_water_8h_source.html">SW_SoilWater.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_s_w___veg_estab_8h_source.html">SW_VegEstab.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_s_w___veg_prod_8h_source.html">SW_VegProd.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_s_w___weather_8h_source.html">SW_Weather.h</a>&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aff0bb7870fbf9020899035540e606250"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_w___control_8c.html#aff0bb7870fbf9020899035540e606250">SW_FLW_construct</a> (void)</td></tr>
<tr class="separator:aff0bb7870fbf9020899035540e606250"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a943a69d15500659311cb5037d1afae53"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_w___control_8c.html#a943a69d15500659311cb5037d1afae53">SW_CTL_main</a> (void)</td></tr>
<tr class="separator:a943a69d15500659311cb5037d1afae53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2909281ecba352303cc710e1c045c54"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_w___control_8c.html#ae2909281ecba352303cc710e1c045c54">SW_CTL_init_model</a> (const char *firstfile)</td></tr>
<tr class="separator:ae2909281ecba352303cc710e1c045c54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43102daf9adb8884f1536ddd5267b5d3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_w___control_8c.html#a43102daf9adb8884f1536ddd5267b5d3">SW_CTL_run_current_year</a> (void)</td></tr>
<tr class="separator:a43102daf9adb8884f1536ddd5267b5d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a7fe95d8828eeecd4a64b5a230bedea66"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_s_w___m_o_d_e_l.html">SW_MODEL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_w___control_8c.html#a7fe95d8828eeecd4a64b5a230bedea66">SW_Model</a></td></tr>
<tr class="separator:a7fe95d8828eeecd4a64b5a230bedea66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b2149c2e1b77da676359b0bc64b1710"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_s_w___v_e_g_e_s_t_a_b.html">SW_VEGESTAB</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_w___control_8c.html#a4b2149c2e1b77da676359b0bc64b1710">SW_VegEstab</a></td></tr>
<tr class="separator:a4b2149c2e1b77da676359b0bc64b1710"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ae2909281ecba352303cc710e1c045c54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2909281ecba352303cc710e1c045c54">&#9670;&nbsp;</a></span>SW_CTL_init_model()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SW_CTL_init_model </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>firstfile</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a943a69d15500659311cb5037d1afae53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a943a69d15500659311cb5037d1afae53">&#9670;&nbsp;</a></span>SW_CTL_main()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SW_CTL_main </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a43102daf9adb8884f1536ddd5267b5d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43102daf9adb8884f1536ddd5267b5d3">&#9670;&nbsp;</a></span>SW_CTL_run_current_year()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SW_CTL_run_current_year </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p class="reference">Referenced by <a class="el" href="_s_w___control_8h.html#a943a69d15500659311cb5037d1afae53">SW_CTL_main()</a>.</p>

</div>
</div>
<a id="aff0bb7870fbf9020899035540e606250"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff0bb7870fbf9020899035540e606250">&#9670;&nbsp;</a></span>SW_FLW_construct()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SW_FLW_construct </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p class="reference">Referenced by <a class="el" href="_s_w___control_8h.html#ae2909281ecba352303cc710e1c045c54">SW_CTL_init_model()</a>.</p>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a7fe95d8828eeecd4a64b5a230bedea66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7fe95d8828eeecd4a64b5a230bedea66">&#9670;&nbsp;</a></span>SW_Model</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_s_w___m_o_d_e_l.html">SW_MODEL</a> SW_Model</td>
</tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a4b2149c2e1b77da676359b0bc64b1710"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b2149c2e1b77da676359b0bc64b1710">&#9670;&nbsp;</a></span>SW_VegEstab</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_s_w___v_e_g_e_s_t_a_b.html">SW_VEGESTAB</a> SW_VegEstab</td>
</tr>
</table>
</div><div class="memdoc">

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="_s_w___control_8c.html">SW_Control.c</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>
9 changes: 9 additions & 0 deletions doc/html/_s_w___control_8c.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
var _s_w___control_8c =
[
[ "SW_CTL_init_model", "_s_w___control_8c.html#ae2909281ecba352303cc710e1c045c54", null ],
[ "SW_CTL_main", "_s_w___control_8c.html#a943a69d15500659311cb5037d1afae53", null ],
[ "SW_CTL_run_current_year", "_s_w___control_8c.html#a43102daf9adb8884f1536ddd5267b5d3", null ],
[ "SW_FLW_construct", "_s_w___control_8c.html#aff0bb7870fbf9020899035540e606250", null ],
[ "SW_Model", "_s_w___control_8c.html#a7fe95d8828eeecd4a64b5a230bedea66", null ],
[ "SW_VegEstab", "_s_w___control_8c.html#a4b2149c2e1b77da676359b0bc64b1710", null ]
];
Loading