Skip to content

Commit

Permalink
Docs: run Doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
@ChristineStawitz-NOAA
ChristineStawitz-NOAA committed Nov 2, 2023
1 parent ec23a7a commit b7cd618
Show file tree
Hide file tree
Showing 109 changed files with 2,206 additions and 1,712 deletions.
4 changes: 2 additions & 2 deletions docs/classfims__info_1_1Information.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -352,8 +352,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a87a3d2d9a1575dbba625398e
</tr>
</table>
</div><div class="memdoc">
<p>Create the generalized stock assessment model that will evaluate the objective function. Does error checking to make sure the program has all necessary components for the model and that they're in the right dimensions.</p>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p>Create the generalized stock assessment model that will evaluate the objective function. Does error checking to make sure the program has all necessary components for the model and that they're in the right dimensions. This sets up pointers to all memory objects and initializes fleet and population objects.</p>
<dl class="section return"><dt>Returns</dt><dd>True if valid model, False if invalid model, check fims.log for errors. </dd></dl>

</div>
</div>
Expand Down
243 changes: 237 additions & 6 deletions docs/def_8hpp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,26 +93,257 @@
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a31231204b726b1a498a84321dc9f445f"><td class="memItemLeft" align="right" valign="top">std::ofstream&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="def_8hpp.html#a31231204b726b1a498a84321dc9f445f">FIMS_LOG</a> (&quot;fims.log&quot;)</td></tr>
<tr class="separator:a31231204b726b1a498a84321dc9f445f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaed3fc4723e7e09782659df8e1ab7f3a"><td class="memItemLeft" align="right" valign="top">std::ofstream&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="def_8hpp.html#aaed3fc4723e7e09782659df8e1ab7f3a">FIMS_LOG</a> (&quot;logs/fims.log&quot;)</td></tr>
<tr class="separator:aaed3fc4723e7e09782659df8e1ab7f3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4f929af3e95a7f70238f77a6a5cef5f"><td class="memItemLeft" align="right" valign="top">std::ofstream&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="def_8hpp.html#ae4f929af3e95a7f70238f77a6a5cef5f">INFO_LOG</a> (&quot;logs/info.log&quot;)</td></tr>
<tr class="separator:ae4f929af3e95a7f70238f77a6a5cef5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a308fcf8394afe9b124fd6b8e3186fc9c"><td class="memItemLeft" align="right" valign="top">std::ofstream&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="def_8hpp.html#a308fcf8394afe9b124fd6b8e3186fc9c">ERROR_LOG</a> (&quot;logs/error.log&quot;)</td></tr>
<tr class="separator:a308fcf8394afe9b124fd6b8e3186fc9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58d95516b89b5a2da7fd4d8a6413a7c4"><td class="memItemLeft" align="right" valign="top">std::ofstream&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="def_8hpp.html#a58d95516b89b5a2da7fd4d8a6413a7c4">DATA_LOG</a> (&quot;logs/data.log&quot;)</td></tr>
<tr class="separator:a58d95516b89b5a2da7fd4d8a6413a7c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b04d9d9cdc2a06b215c92b40ddf0627"><td class="memItemLeft" align="right" valign="top">std::ofstream&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="def_8hpp.html#a0b04d9d9cdc2a06b215c92b40ddf0627">MODEL_LOG</a> (&quot;logs/model.log&quot;)</td></tr>
<tr class="separator:a0b04d9d9cdc2a06b215c92b40ddf0627"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9da1e19e650fa7488f0d1d265e54beb9"><td class="memItemLeft" align="right" valign="top">std::ofstream&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="def_8hpp.html#a9da1e19e650fa7488f0d1d265e54beb9">FLEET_LOG</a> (&quot;logs/fleet.log&quot;)</td></tr>
<tr class="separator:a9da1e19e650fa7488f0d1d265e54beb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acad788028ec9b157659fdb0e83c973e0"><td class="memItemLeft" align="right" valign="top">std::ofstream&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="def_8hpp.html#acad788028ec9b157659fdb0e83c973e0">POPULATION_LOG</a> (&quot;logs/population.log&quot;)</td></tr>
<tr class="separator:acad788028ec9b157659fdb0e83c973e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab79e53c483ecf6594343d0b2d5108447"><td class="memItemLeft" align="right" valign="top">std::ofstream&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="def_8hpp.html#ab79e53c483ecf6594343d0b2d5108447">RECRUITMENT_LOG</a> (&quot;logs/recruitment.log&quot;)</td></tr>
<tr class="separator:ab79e53c483ecf6594343d0b2d5108447"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f8e17cb50cccb5773dc043d265f6343"><td class="memItemLeft" align="right" valign="top">std::ofstream&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="def_8hpp.html#a0f8e17cb50cccb5773dc043d265f6343">GROWTH_LOG</a> (&quot;logs/growth.log&quot;)</td></tr>
<tr class="separator:a0f8e17cb50cccb5773dc043d265f6343"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa51d87ef5189a685ef0f116757519abe"><td class="memItemLeft" align="right" valign="top">std::ofstream&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="def_8hpp.html#aa51d87ef5189a685ef0f116757519abe">MATURITY_LOG</a> (&quot;logs/maturity.log&quot;)</td></tr>
<tr class="separator:aa51d87ef5189a685ef0f116757519abe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34afbc4af6ad36508ad3d2847da6b75c"><td class="memItemLeft" align="right" valign="top">std::ofstream&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="def_8hpp.html#a34afbc4af6ad36508ad3d2847da6b75c">SELECTIVITY_LOG</a> (&quot;logs/selectivity.log&quot;)</td></tr>
<tr class="separator:a34afbc4af6ad36508ad3d2847da6b75c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9dd6f7b6a012412894bea2d72974339b"><td class="memItemLeft" align="right" valign="top">std::ofstream&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="def_8hpp.html#a9dd6f7b6a012412894bea2d72974339b">DEBUG_LOG</a> (&quot;logs/debug/debug.log&quot;)</td></tr>
<tr class="separator:a9dd6f7b6a012412894bea2d72974339b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a31231204b726b1a498a84321dc9f445f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31231204b726b1a498a84321dc9f445f">&#9670;&nbsp;</a></span>FIMS_LOG()</h2>
<a id="a58d95516b89b5a2da7fd4d8a6413a7c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58d95516b89b5a2da7fd4d8a6413a7c4">&#9670;&nbsp;</a></span>DATA_LOG()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ofstream DATA_LOG </td>
<td>(</td>
<td class="paramtype">&quot;logs/data.log&quot;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Data input tracking log file </p>

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

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ofstream DEBUG_LOG </td>
<td>(</td>
<td class="paramtype">&quot;logs/debug/debug.log&quot;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Development debugging log file </p>

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

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ofstream ERROR_LOG </td>
<td>(</td>
<td class="paramtype">&quot;logs/error.log&quot;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Error tracking log file </p>

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

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ofstream FIMS_LOG </td>
<td>(</td>
<td class="paramtype">&quot;fims.log&quot;&#160;</td>
<td class="paramtype">&quot;logs/fims.log&quot;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generic log file </p>

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

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ofstream FLEET_LOG </td>
<td>(</td>
<td class="paramtype">&quot;logs/fleet.log&quot;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fleet module log file </p>

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

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ofstream GROWTH_LOG </td>
<td>(</td>
<td class="paramtype">&quot;logs/growth.log&quot;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Growth module log file </p>

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

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ofstream INFO_LOG </td>
<td>(</td>
<td class="paramtype">&quot;logs/info.log&quot;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Information.hpp log file </p>

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

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ofstream MATURITY_LOG </td>
<td>(</td>
<td class="paramtype">&quot;logs/maturity.log&quot;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Maturity module log file </p>

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

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ofstream MODEL_LOG </td>
<td>(</td>
<td class="paramtype">&quot;logs/model.log&quot;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Model.hpp log file </p>

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

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ofstream POPULATION_LOG </td>
<td>(</td>
<td class="paramtype">&quot;logs/population.log&quot;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Populations module log file </p>

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

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ofstream RECRUITMENT_LOG </td>
<td>(</td>
<td class="paramtype">&quot;logs/recruitment.log&quot;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Recruitment module log file </p>

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

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ofstream SELECTIVITY_LOG </td>
<td>(</td>
<td class="paramtype">&quot;logs/selectivity.log&quot;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Log file </p>
<p>Selectivity module log file </p>

</div>
</div>
Expand Down
Loading

0 comments on commit b7cd618

Please sign in to comment.