ccppi/config-parser
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add doxygen configuration

Browse Source
This commit is contained in:
jonathan santis
2025-05-20 16:15:21 +02:00
parent a834abc8e7
commit 061094c88c
129 changed files with 19750 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

239
doc/html/file_8h.html Normal file
View File

@@ -0,0 +1,239 @@
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: file.h 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</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 id="projectrow">
<td id="projectalign">
<div id="projectname">My Project
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
</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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('file_8h.html',''); initResizable(true); });
/* @license-end */
</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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">file.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a href="file_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a258bb72419ef143530a2f8f55e7d57af" id="r_a258bb72419ef143530a2f8f55e7d57af"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a258bb72419ef143530a2f8f55e7d57af">NO_ERROR</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:a258bb72419ef143530a2f8f55e7d57af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44d189cf44f6ef2cb48c2f22c7824469" id="r_a44d189cf44f6ef2cb48c2f22c7824469"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a44d189cf44f6ef2cb48c2f22c7824469">FILE_ERROR_OPEN</a>&#160;&#160;&#160;11</td></tr>
<tr class="separator:a44d189cf44f6ef2cb48c2f22c7824469"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12f43bc1d8b150bb55c18877bbe612ac" id="r_a12f43bc1d8b150bb55c18877bbe612ac"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a12f43bc1d8b150bb55c18877bbe612ac">FILE_ERROR_STRCONTENT_TO_SMALL</a>&#160;&#160;&#160;12</td></tr>
<tr class="separator:a12f43bc1d8b150bb55c18877bbe612ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa161b7390609303815b39df4a4850cfc" id="r_aa161b7390609303815b39df4a4850cfc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa161b7390609303815b39df4a4850cfc">FILE_ERROR_READ_MISMATCH</a>&#160;&#160;&#160;13</td></tr>
<tr class="separator:aa161b7390609303815b39df4a4850cfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a415337a87938760b49ba4c0d74ab6c6a" id="r_a415337a87938760b49ba4c0d74ab6c6a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a415337a87938760b49ba4c0d74ab6c6a">getFile</a> (char *fname, char **strContent, int cbSize, long *neededSize)</td></tr>
<tr class="separator:a415337a87938760b49ba4c0d74ab6c6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a44d189cf44f6ef2cb48c2f22c7824469" name="a44d189cf44f6ef2cb48c2f22c7824469"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44d189cf44f6ef2cb48c2f22c7824469">&#9670;&#160;</a></span>FILE_ERROR_OPEN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FILE_ERROR_OPEN&#160;&#160;&#160;11</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="file_8h_source.html#l00004">4</a> of file <a class="el" href="file_8h_source.html">file.h</a>.</p>
</div>
</div>
<a id="aa161b7390609303815b39df4a4850cfc" name="aa161b7390609303815b39df4a4850cfc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa161b7390609303815b39df4a4850cfc">&#9670;&#160;</a></span>FILE_ERROR_READ_MISMATCH</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FILE_ERROR_READ_MISMATCH&#160;&#160;&#160;13</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="file_8h_source.html#l00006">6</a> of file <a class="el" href="file_8h_source.html">file.h</a>.</p>
</div>
</div>
<a id="a12f43bc1d8b150bb55c18877bbe612ac" name="a12f43bc1d8b150bb55c18877bbe612ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12f43bc1d8b150bb55c18877bbe612ac">&#9670;&#160;</a></span>FILE_ERROR_STRCONTENT_TO_SMALL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FILE_ERROR_STRCONTENT_TO_SMALL&#160;&#160;&#160;12</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="file_8h_source.html#l00005">5</a> of file <a class="el" href="file_8h_source.html">file.h</a>.</p>
</div>
</div>
<a id="a258bb72419ef143530a2f8f55e7d57af" name="a258bb72419ef143530a2f8f55e7d57af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a258bb72419ef143530a2f8f55e7d57af">&#9670;&#160;</a></span>NO_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NO_ERROR&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="file_8h_source.html#l00001">1</a> of file <a class="el" href="file_8h_source.html">file.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a415337a87938760b49ba4c0d74ab6c6a" name="a415337a87938760b49ba4c0d74ab6c6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a415337a87938760b49ba4c0d74ab6c6a">&#9670;&#160;</a></span>getFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int getFile </td>
<td>(</td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>fname</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char **</td> <td class="paramname"><span class="paramname"><em>strContent</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>cbSize</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long *</td> <td class="paramname"><span class="paramname"><em>neededSize</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="file_8c_source.html#l00017">17</a> of file <a class="el" href="file_8c_source.html">file.c</a>.</p>
</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="file_8h.html">file.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>
</html>