FYS3150/Project-4
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Cory Balaton
2023-12-04 22:23:30 +01:00
parent d30c98aed2
commit d318491dfe
133 changed files with 7487 additions and 2047 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/utils_8cpp.html
View File

@@ -124,6 +124,9 @@ Functions</h2></td></tr>
<tr class="memitem:aed026119193a9bbe076671809ff0f430"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="utils_8hpp.html#aed026119193a9bbe076671809ff0f430">utils::dirname</a> (const std::string &amp;path)</td></tr>
<tr class="memdesc:aed026119193a9bbe076671809ff0f430"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the directory name of the path. <br /></td></tr>
<tr class="separator:aed026119193a9bbe076671809ff0f430"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae91fad89394d745d544737e43524bde6"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="utils_8hpp.html#ae91fad89394d745d544737e43524bde6">utils::concatpath</a> (const std::string &amp;left, const std::string &amp;right)</td></tr>
<tr class="memdesc:ae91fad89394d745d544737e43524bde6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Take 2 strings and concatenate them and make sure there is a directory separator (/) between them. <br /></td></tr>
<tr class="separator:ae91fad89394d745d544737e43524bde6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implementation of the utils. </p>
@@ -131,10 +134,51 @@ Functions</h2></td></tr>
<dd>
Janita Ovidie Sandtrøen Willumsen (janitaws)</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.0</dd></dl>
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000015">Bug:</a></b></dt><dd>No known bugs </dd></dl>
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000017">Bug:</a></b></dt><dd>No known bugs </dd></dl>
<p class="definition">Definition in file <a class="el" href="utils_8cpp_source.html">utils.cpp</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ae91fad89394d745d544737e43524bde6" name="ae91fad89394d745d544737e43524bde6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae91fad89394d745d544737e43524bde6">&#9670;&#160;</a></span>concatpath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string utils::concatpath </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>left</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>right</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Take 2 strings and concatenate them and make sure there is a directory separator (/) between them. </p>
<p>This function doesn't care whether or not the values given as parameters are valid path strings. It is the responsibility of the user to make sure that the values given are valid path strings. The function only guarantees that the output string is a valid path string.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">left</td><td>The left hand side of the result string </td></tr>
<tr><td class="paramname">right</td><td>The right hand side of the result string</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
<p class="definition">Definition at line <a class="el" href="utils_8cpp_source.html#l00063">63</a> of file <a class="el" href="utils_8cpp_source.html">utils.cpp</a>.</p>
</div>
</div>
<a id="aed026119193a9bbe076671809ff0f430" name="aed026119193a9bbe076671809ff0f430"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed026119193a9bbe076671809ff0f430">&#9670;&#160;</a></span>dirname()</h2>