Skip to content

Commit 151704b

Browse files
pcannon09pcannon09
committed
Added argx-c lib documentation
1 parent 2deab9d commit 151704b

File tree

239 files changed

+49710
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

239 files changed

+49710
-0
lines changed

‎pages/libs/argx-c/argx.tag‎

Lines changed: 745 additions & 0 deletions
Large diffs are not rendered by default.

‎pages/libs/argx-c/docbook/annotated.xml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
2+
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_annotated" xml:lang="en-US">
3+
<title>Data Structures</title>
4+
Here are the data structures with brief descriptions:<link linkend="_structArgxc">Argxc</link><link linkend="_structArgxcError">ArgxcError</link><link linkend="_structArgxcErrorPair">ArgxcErrorPair</link><link linkend="_structArgxcOptions">ArgxcOptions</link><link linkend="_structArgxcParam">ArgxcParam</link></section>

‎pages/libs/argx-c/docbook/d0/df9/Argx_8c.xml‎

Lines changed: 1657 additions & 0 deletions
Large diffs are not rendered by default.

‎pages/libs/argx-c/docbook/d0/df9/Argx_8c_source.xml‎

Lines changed: 692 additions & 0 deletions
Large diffs are not rendered by default.

‎pages/libs/argx-c/docbook/d1/d7f/ARGXAddError_8h.xml‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
2+
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_ARGXAddError_8h" xml:lang="en-US">
3+
<title>inc/ARGXAddError.h File Reference</title>
4+
<indexterm><primary>inc/ARGXAddError.h</primary></indexterm>
5+
<programlisting linenumbering="unnumbered">#include &quot;types.h&quot;<?linebreak?></programlisting><simplesect>
6+
<title>Data Structures </title>
7+
<itemizedlist>
8+
<listitem><para>struct <link linkend="_structArgxcErrorPair">ArgxcErrorPair</link></para>
9+
</listitem>
10+
</itemizedlist>
11+
</simplesect>
12+
<simplesect>
13+
<title>Functions </title>
14+
<itemizedlist>
15+
<listitem><para><link linkend="_structArgxcError">ArgxcError</link> <link linkend="_ARGXAddError_8h_1a8c4ee33ae3d4a6208322ad503dceca9e">argxcCreateErrorSimple</link> (const char *msg, const char *help)</para>
16+
</listitem>
17+
<listitem><para>int <link linkend="_ARGXAddError_8h_1a038539b9defbaf62f7a175d75388866d">argxcGetErrorCode</link> (const <link linkend="_structArgxcError">ArgxcError</link> *error)</para>
18+
</listitem>
19+
<listitem><para>const char * <link linkend="_ARGXAddError_8h_1a82d77328ff61877b8ab10d054bc5ced4">argxcGetErrorHelp</link> (const <link linkend="_structArgxcError">ArgxcError</link> *error)</para>
20+
</listitem>
21+
<listitem><para>const char * <link linkend="_ARGXAddError_8h_1a9e0ec52023e67e806606050d12a934a8">argxcGetErrorMessage</link> (const <link linkend="_structArgxcError">ArgxcError</link> *error)</para>
22+
</listitem>
23+
<listitem><para><link linkend="_structArgxcErrorPair">ArgxcErrorPair</link> <link linkend="_ARGXAddError_8h_1ae080742df3abdaba51a357b9c68775dd">argxcGetErrorPair</link> (const <link linkend="_structArgxcError">ArgxcError</link> *error)</para>
24+
</listitem>
25+
</itemizedlist>
26+
</simplesect>
27+
<section>
28+
<title>Function Documentation</title>
29+
<anchor xml:id="_ARGXAddError_8h_1a8c4ee33ae3d4a6208322ad503dceca9e"/><section>
30+
<title>argxcCreateErrorSimple()</title>
31+
<indexterm><primary>argxcCreateErrorSimple</primary><secondary>ARGXAddError.h</secondary></indexterm>
32+
<indexterm><primary>ARGXAddError.h</primary><secondary>argxcCreateErrorSimple</secondary></indexterm>
33+
<para><computeroutput><link linkend="_structArgxcError">ArgxcError</link> argxcCreateErrorSimple (const char * msg, const char * help)</computeroutput></para><para>
34+
Definition at line <link linkend="_ARGXAddError_8c_source_1l00019">19</link> of file <link linkend="_ARGXAddError_8c_source">ARGXAddError.c</link>.</para>
35+
<programlisting linenumbering="unnumbered">00020 {
36+
00021 &#32;&#32;&#32;&#32;<link linkend="_structArgxcError">ArgxcError</link>&#32;error&#32;=&#32;{0};
37+
00022
38+
00023 &#32;&#32;&#32;&#32;error.<link linkend="_structArgxcError_1ab4531054aa9750f66f0cae13f67365ad">type</link>&#32;=&#32;<link linkend="_ARGXAddError_8c_1a814b3298d81b070e52a987654d18d8a2">stringDuplicate</link>(<emphasis role="stringliteral">&quot;error&quot;</emphasis>);
39+
00024 &#32;&#32;&#32;&#32;error.<link linkend="_structArgxcError_1a88d100236636b2eb326025d527ad26f3">error</link>&#32;=&#32;<link linkend="_ARGXAddError_8c_1a814b3298d81b070e52a987654d18d8a2">stringDuplicate</link>(msg);
40+
00025 &#32;&#32;&#32;&#32;error.<link linkend="_structArgxcError_1a9e83392469b228017a3b6492392f68ad">help</link>&#32;=&#32;<link linkend="_ARGXAddError_8c_1a814b3298d81b070e52a987654d18d8a2">stringDuplicate</link>(help);
41+
00026 &#32;&#32;&#32;&#32;error.<link linkend="_structArgxcError_1a617299f808dff4b2656bf04384e64bf9">code</link>&#32;=&#32;1;&#32;<emphasis role="comment">//&#32;Default&#32;error&#32;code</emphasis>
42+
00027
43+
00028 &#32;&#32;&#32;&#32;<emphasis role="keywordflow">return</emphasis>&#32;error;
44+
00029 }
45+
</programlisting><para>
46+
References <link linkend="_types_8h_source_1l00019">ArgxcError::code</link>, <link linkend="_types_8h_source_1l00017">ArgxcError::error</link>, <link linkend="_types_8h_source_1l00018">ArgxcError::help</link>, <link linkend="_ARGXAddError_8c_source_1l00007">stringDuplicate()</link>, and <link linkend="_types_8h_source_1l00016">ArgxcError::type</link>.</para>
47+
</section>
48+
<anchor xml:id="_ARGXAddError_8h_1a038539b9defbaf62f7a175d75388866d"/><section>
49+
<title>argxcGetErrorCode()</title>
50+
<indexterm><primary>argxcGetErrorCode</primary><secondary>ARGXAddError.h</secondary></indexterm>
51+
<indexterm><primary>ARGXAddError.h</primary><secondary>argxcGetErrorCode</secondary></indexterm>
52+
<para><computeroutput>int argxcGetErrorCode (const <link linkend="_structArgxcError">ArgxcError</link> * error)</computeroutput></para><para>
53+
Definition at line <link linkend="_ARGXAddError_8c_source_1l00041">41</link> of file <link linkend="_ARGXAddError_8c_source">ARGXAddError.c</link>.</para>
54+
<programlisting linenumbering="unnumbered">00042 {
55+
00043 &#32;&#32;&#32;&#32;<emphasis role="keywordflow">return</emphasis>&#32;error&#32;?&#32;error-&gt;<link linkend="_structArgxcError_1a617299f808dff4b2656bf04384e64bf9">code</link>&#32;:&#32;0;
56+
00044 }
57+
</programlisting><para>
58+
References <link linkend="_types_8h_source_1l00019">ArgxcError::code</link>.</para>
59+
</section>
60+
<anchor xml:id="_ARGXAddError_8h_1a82d77328ff61877b8ab10d054bc5ced4"/><section>
61+
<title>argxcGetErrorHelp()</title>
62+
<indexterm><primary>argxcGetErrorHelp</primary><secondary>ARGXAddError.h</secondary></indexterm>
63+
<indexterm><primary>ARGXAddError.h</primary><secondary>argxcGetErrorHelp</secondary></indexterm>
64+
<para><computeroutput>const char * argxcGetErrorHelp (const <link linkend="_structArgxcError">ArgxcError</link> * error)</computeroutput></para><para>
65+
Definition at line <link linkend="_ARGXAddError_8c_source_1l00036">36</link> of file <link linkend="_ARGXAddError_8c_source">ARGXAddError.c</link>.</para>
66+
<programlisting linenumbering="unnumbered">00037 {
67+
00038 &#32;&#32;&#32;&#32;<emphasis role="keywordflow">return</emphasis>&#32;error&#32;?&#32;error-&gt;<link linkend="_structArgxcError_1a9e83392469b228017a3b6492392f68ad">help</link>&#32;:&#32;NULL;
68+
00039 }
69+
</programlisting><para>
70+
References <link linkend="_types_8h_source_1l00018">ArgxcError::help</link>.</para>
71+
</section>
72+
<anchor xml:id="_ARGXAddError_8h_1a9e0ec52023e67e806606050d12a934a8"/><section>
73+
<title>argxcGetErrorMessage()</title>
74+
<indexterm><primary>argxcGetErrorMessage</primary><secondary>ARGXAddError.h</secondary></indexterm>
75+
<indexterm><primary>ARGXAddError.h</primary><secondary>argxcGetErrorMessage</secondary></indexterm>
76+
<para><computeroutput>const char * argxcGetErrorMessage (const <link linkend="_structArgxcError">ArgxcError</link> * error)</computeroutput></para><para>
77+
Definition at line <link linkend="_ARGXAddError_8c_source_1l00031">31</link> of file <link linkend="_ARGXAddError_8c_source">ARGXAddError.c</link>.</para>
78+
<programlisting linenumbering="unnumbered">00032 {
79+
00033 &#32;&#32;&#32;&#32;<emphasis role="keywordflow">return</emphasis>&#32;error&#32;?&#32;error-&gt;<link linkend="_structArgxcError_1a88d100236636b2eb326025d527ad26f3">error</link>&#32;:&#32;NULL;
80+
00034 }
81+
</programlisting><para>
82+
References <link linkend="_types_8h_source_1l00017">ArgxcError::error</link>.</para>
83+
</section>
84+
<anchor xml:id="_ARGXAddError_8h_1ae080742df3abdaba51a357b9c68775dd"/><section>
85+
<title>argxcGetErrorPair()</title>
86+
<indexterm><primary>argxcGetErrorPair</primary><secondary>ARGXAddError.h</secondary></indexterm>
87+
<indexterm><primary>ARGXAddError.h</primary><secondary>argxcGetErrorPair</secondary></indexterm>
88+
<para><computeroutput><link linkend="_structArgxcErrorPair">ArgxcErrorPair</link> argxcGetErrorPair (const <link linkend="_structArgxcError">ArgxcError</link> * error)</computeroutput></para><para>
89+
Definition at line <link linkend="_ARGXAddError_8c_source_1l00046">46</link> of file <link linkend="_ARGXAddError_8c_source">ARGXAddError.c</link>.</para>
90+
<programlisting linenumbering="unnumbered">00047 {
91+
00048 &#32;&#32;&#32;&#32;<link linkend="_structArgxcErrorPair">ArgxcErrorPair</link>&#32;pair&#32;=&#32;{NULL,&#32;NULL};
92+
00049
93+
00050 &#32;&#32;&#32;&#32;<emphasis role="keywordflow">if</emphasis>&#32;(error)
94+
00051 &#32;&#32;&#32;&#32;{
95+
00052 &#32;&#32;&#32;&#32;&#32;&#32;&#32;&#32;pair.<link linkend="_structArgxcErrorPair_1a548e70442f749cb33bf853987bbb2707">error</link>&#32;=&#32;error-&gt;<link linkend="_structArgxcError_1a88d100236636b2eb326025d527ad26f3">error</link>;
96+
00053 &#32;&#32;&#32;&#32;&#32;&#32;&#32;&#32;pair.<link linkend="_structArgxcErrorPair_1ab7a2046f22e6b8a74ca323b985cee6ce">help</link>&#32;=&#32;error-&gt;<link linkend="_structArgxcError_1a9e83392469b228017a3b6492392f68ad">help</link>;
97+
00054 &#32;&#32;&#32;&#32;}
98+
00055
99+
00056 &#32;&#32;&#32;&#32;<emphasis role="keywordflow">return</emphasis>&#32;pair;
100+
00057 }
101+
</programlisting><para>
102+
References <link linkend="_types_8h_source_1l00017">ArgxcError::error</link>, <link linkend="_ARGXAddError_8h_source_1l00016">ArgxcErrorPair::error</link>, <link linkend="_types_8h_source_1l00018">ArgxcError::help</link>, and <link linkend="_ARGXAddError_8h_source_1l00017">ArgxcErrorPair::help</link>.</para>
103+
</section>
104+
</section>
105+
</section>

‎pages/libs/argx-c/docbook/d1/d7f/ARGXAddError_8h_source.xml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
2+
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_ARGXAddError_8h_source" xml:lang="en-US">
3+
<title>ARGXAddError.h</title>
4+
<indexterm><primary>inc/ARGXAddError.h</primary></indexterm>
5+
Go to the documentation of this file.<programlisting linenumbering="unnumbered"><anchor xml:id="_ARGXAddError_8h_source_1l00001"/>00001 <emphasis role="preprocessor">#pragma&#32;once</emphasis>
6+
<anchor xml:id="_ARGXAddError_8h_source_1l00002"/>00002
7+
<anchor xml:id="_ARGXAddError_8h_source_1l00003"/>00003 <emphasis role="preprocessor">#include&#32;&quot;<link linkend="_types_8h">types.h</link>&quot;</emphasis>
8+
<anchor xml:id="_ARGXAddError_8h_source_1l00004"/>00004
9+
<anchor xml:id="_ARGXAddError_8h_source_1l00005"/>00005 <emphasis role="preprocessor">#ifdef&#32;__cplusplus</emphasis>
10+
<anchor xml:id="_ARGXAddError_8h_source_1l00006"/>00006 <emphasis role="keyword">extern</emphasis>&#32;<emphasis role="stringliteral">&quot;C&quot;</emphasis>&#32;{
11+
<anchor xml:id="_ARGXAddError_8h_source_1l00007"/>00007 <emphasis role="preprocessor">#endif</emphasis>
12+
<anchor xml:id="_ARGXAddError_8h_source_1l00008"/>00008
13+
<anchor xml:id="_ARGXAddError_8h_source_1l00009"/>00009 &#32;&#32;&#32;&#32;<emphasis role="comment">//&#32;Error&#32;creation&#32;and&#32;management</emphasis>
14+
<anchor xml:id="_ARGXAddError_8h_source_1l00010"/>00010 &#32;&#32;&#32;&#32;<link linkend="_structArgxcError">ArgxcError</link>&#32;<link linkend="_ARGXAddError_8h_1a8c4ee33ae3d4a6208322ad503dceca9e">argxcCreateErrorSimple</link>(<emphasis role="keyword">const</emphasis>&#32;<emphasis role="keywordtype">char</emphasis>&#32;*msg,&#32;<emphasis role="keyword">const</emphasis>&#32;<emphasis role="keywordtype">char</emphasis>&#32;*help);
15+
<anchor xml:id="_ARGXAddError_8h_source_1l00011"/>00011 &#32;&#32;&#32;&#32;<emphasis role="keyword">const</emphasis>&#32;<emphasis role="keywordtype">char</emphasis>*&#32;<link linkend="_ARGXAddError_8h_1a9e0ec52023e67e806606050d12a934a8">argxcGetErrorMessage</link>(<emphasis role="keyword">const</emphasis>&#32;<link linkend="_structArgxcError">ArgxcError</link>&#32;*error);
16+
<anchor xml:id="_ARGXAddError_8h_source_1l00012"/>00012 &#32;&#32;&#32;&#32;<emphasis role="keyword">const</emphasis>&#32;<emphasis role="keywordtype">char</emphasis>*&#32;<link linkend="_ARGXAddError_8h_1a82d77328ff61877b8ab10d054bc5ced4">argxcGetErrorHelp</link>(<emphasis role="keyword">const</emphasis>&#32;<link linkend="_structArgxcError">ArgxcError</link>&#32;*error);
17+
<anchor xml:id="_ARGXAddError_8h_source_1l00013"/>00013 &#32;&#32;&#32;&#32;<emphasis role="keywordtype">int</emphasis>&#32;<link linkend="_ARGXAddError_8h_1a038539b9defbaf62f7a175d75388866d">argxcGetErrorCode</link>(<emphasis role="keyword">const</emphasis>&#32;<link linkend="_structArgxcError">ArgxcError</link>&#32;*error);
18+
<anchor xml:id="_ARGXAddError_8h_source_1l00014"/>00014
19+
<anchor xml:id="_ARGXAddError_8h_source_1l00015"/><link linkend="_structArgxcErrorPair">00015</link> &#32;&#32;&#32;&#32;<emphasis role="keyword">typedef</emphasis>&#32;<emphasis role="keyword">struct&#32;</emphasis>{
20+
<anchor xml:id="_ARGXAddError_8h_source_1l00016"/><link linkend="_structArgxcErrorPair_1a548e70442f749cb33bf853987bbb2707">00016</link> &#32;&#32;&#32;&#32;&#32;&#32;&#32;&#32;<emphasis role="keyword">const</emphasis>&#32;<emphasis role="keywordtype">char</emphasis>&#32;*<link linkend="_structArgxcErrorPair_1a548e70442f749cb33bf853987bbb2707">error</link>;
21+
<anchor xml:id="_ARGXAddError_8h_source_1l00017"/><link linkend="_structArgxcErrorPair_1ab7a2046f22e6b8a74ca323b985cee6ce">00017</link> &#32;&#32;&#32;&#32;&#32;&#32;&#32;&#32;<emphasis role="keyword">const</emphasis>&#32;<emphasis role="keywordtype">char</emphasis>&#32;*<link linkend="_structArgxcErrorPair_1ab7a2046f22e6b8a74ca323b985cee6ce">help</link>;
22+
<anchor xml:id="_ARGXAddError_8h_source_1l00018"/>00018 &#32;&#32;&#32;&#32;}&#32;<link linkend="_structArgxcErrorPair">ArgxcErrorPair</link>;
23+
<anchor xml:id="_ARGXAddError_8h_source_1l00019"/>00019
24+
<anchor xml:id="_ARGXAddError_8h_source_1l00020"/>00020 &#32;&#32;&#32;&#32;<link linkend="_structArgxcErrorPair">ArgxcErrorPair</link>&#32;<link linkend="_ARGXAddError_8h_1ae080742df3abdaba51a357b9c68775dd">argxcGetErrorPair</link>(<emphasis role="keyword">const</emphasis>&#32;<link linkend="_structArgxcError">ArgxcError</link>&#32;*error);
25+
<anchor xml:id="_ARGXAddError_8h_source_1l00021"/>00021
26+
<anchor xml:id="_ARGXAddError_8h_source_1l00022"/>00022 <emphasis role="preprocessor">#ifdef&#32;__cplusplus</emphasis>
27+
<anchor xml:id="_ARGXAddError_8h_source_1l00023"/>00023 }
28+
<anchor xml:id="_ARGXAddError_8h_source_1l00024"/>00024 <emphasis role="preprocessor">#endif</emphasis>
29+
</programlisting></section>

0 commit comments

Comments
 (0)