testing/054/054__parblock_8cpp.xml

   1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
   2 <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="">
   3   <compounddef id="054__parblock_8cpp" kind="file" language="C++">
   4     <compoundname>054_parblock.cpp</compoundname>
   5     <sectiondef kind="func">
   6       <memberdef kind="function" id="054__parblock_8cpp_1a2dd0ac47f42a9994b91d34403be05fe9" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
   7         <type>void</type>
   8         <definition>void function</definition>
   9         <argsstring>(int client, int *resource, int parblock, int *test, int p)</argsstring>
  10         <name>function</name>
  11         <param>
  12           <type>int</type>
  13           <declname>client</declname>
  14         </param>
  15         <param>
  16           <type>int *</type>
  17           <declname>resource</declname>
  18         </param>
  19         <param>
  20           <type>int</type>
  21           <declname>parblock</declname>
  22         </param>
  23         <param>
  24           <type>int *</type>
  25           <declname>test</declname>
  26         </param>
  27         <param>
  28           <type>int</type>
  29           <declname>p</declname>
  30         </param>
  31         <briefdescription>
  32         </briefdescription>
  33         <detaileddescription>
  34           <para>call by target-specific code to manage resources required by the client.</para>
  35           <para>
  36             <parameterlist kind="param">
  37               <parameteritem>
  38                 <parameternamelist>
  39                   <parametername direction="in">client</parametername>
  40                 </parameternamelist>
  41                 <parameterdescription>
  42                   <para>ID of client requesting resource. </para>
  43                 </parameterdescription>
  44               </parameteritem>
  45               <parameteritem>
  46                 <parameternamelist>
  47                   <parametername direction="out">resource</parametername>
  48                 </parameternamelist>
  49                 <parameterdescription>
  50                   <para>Requested resource </para>
  51                 </parameterdescription>
  52               </parameteritem>
  53               <parameteritem>
  54                 <parameternamelist>
  55                   <parametername direction="in">parblock</parametername>
  56                 </parameternamelist>
  57                 <parameterdescription>
  58                   <para>
  59                     <parblock>
  60                       <para>This is a test for the @parblock command.</para>
  61                       <para>A list if values for the parblock param:<itemizedlist><listitem><para>Item 1. This is short one-line description.</para></listitem><listitem><para>Item 2. This is a long bullet item; sometimes they wrap on multiple lines like this one.</para></listitem></itemizedlist>
  62 </para>
  63                       <para>This is the second paragraph description for the @parblock parameter. Always end the text inside the @parblock command with an @endparblock command. </para>
  64                     </parblock>
  65                   </para>
  66                 </parameterdescription>
  67               </parameteritem>
  68               <parameteritem>
  69                 <parameternamelist>
  70                   <parametername direction="out">test</parametername>
  71                 </parameternamelist>
  72                 <parameterdescription>
  73                   <para>This is a test parameter for this function to see if it is included in the parameter table </para>
  74                 </parameterdescription>
  75               </parameteritem>
  76               <parameteritem>
  77                 <parameternamelist>
  78                   <parametername direction="in">p</parametername>
  79                 </parameternamelist>
  80                 <parameterdescription>
  81                   <para>
  82                     <parblock>
  83                       <para>First paragraph of the param description.</para>
  84                       <para>Second paragraph of the param description. </para>
  85                     </parblock>
  86                   </para>
  87                 </parameterdescription>
  88               </parameteritem>
  89             </parameterlist>
  90           </para>
  91         </detaileddescription>
  92         <inbodydescription>
  93         </inbodydescription>
  94         <location file="054_parblock.cpp" line="33" column="1"/>
  95       </memberdef>
  96       <memberdef kind="function" id="054__parblock_8cpp_1a5cded03ec9e6fd626da35ab05f624f39" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
  97         <type>void</type>
  98         <definition>void function_2</definition>
  99         <argsstring>(int client, int *resource, int parblock, int *test, int p)</argsstring>
 100         <name>function_2</name>
 101         <param>
 102           <type>int</type>
 103           <declname>client</declname>
 104         </param>
 105         <param>
 106           <type>int *</type>
 107           <declname>resource</declname>
 108         </param>
 109         <param>
 110           <type>int</type>
 111           <declname>parblock</declname>
 112         </param>
 113         <param>
 114           <type>int *</type>
 115           <declname>test</declname>
 116         </param>
 117         <param>
 118           <type>int</type>
 119           <declname>p</declname>
 120         </param>
 121         <briefdescription>
 122         </briefdescription>
 123         <detaileddescription>
 124           <para>call by target-specific code to manage resources required by the client.</para>
 125           <para>
 126             <parameterlist kind="param">
 127               <parameteritem>
 128                 <parameternamelist>
 129                   <parametername direction="in">client</parametername>
 130                 </parameternamelist>
 131                 <parameterdescription>
 132                   <para>ID of client requesting resource. </para>
 133                 </parameterdescription>
 134               </parameteritem>
 135               <parameteritem>
 136                 <parameternamelist>
 137                   <parametername direction="out">resource</parametername>
 138                 </parameternamelist>
 139                 <parameterdescription>
 140                   <para>Requested resource </para>
 141                 </parameterdescription>
 142               </parameteritem>
 143               <parameteritem>
 144                 <parameternamelist>
 145                   <parametername direction="in">parblock</parametername>
 146                 </parameternamelist>
 147                 <parameterdescription>
 148                   <para>
 149                     <parblock>
 150                       <para>This is a test for the @parblock command.</para>
 151                       <para>A list if values for the parblock param:<itemizedlist><listitem><para>Item 1. This is short one-line description.</para></listitem><listitem><para>Item 2. This is a long bullet item; sometimes they wrap on multiple lines like this one.</para></listitem></itemizedlist>
 152 </para>
 153                       <para>This is the second paragraph description for the @parblock parameter. Always end the text inside the @parblock command with an @endparblock command. </para>
 154                     </parblock>
 155                   </para>
 156                 </parameterdescription>
 157               </parameteritem>
 158               <parameteritem>
 159                 <parameternamelist>
 160                   <parametername direction="out">test</parametername>
 161                 </parameternamelist>
 162                 <parameterdescription>
 163                   <para>This is a test parameter for this function to see if it is included in the parameter table </para>
 164                 </parameterdescription>
 165               </parameteritem>
 166               <parameteritem>
 167                 <parameternamelist>
 168                   <parametername direction="in">p</parametername>
 169                 </parameternamelist>
 170                 <parameterdescription>
 171                   <para>
 172                     <parblock>
 173                       <para>First paragraph of the param description. <verbatim>                  Second paragraph of the param description.
 174 </verbatim> </para>
 175                     </parblock>
 176                   </para>
 177                 </parameterdescription>
 178               </parameteritem>
 179             </parameterlist>
 180           </para>
 181         </detaileddescription>
 182         <inbodydescription>
 183         </inbodydescription>
 184         <location file="054_parblock.cpp" line="60" column="1"/>
 185       </memberdef>
 186     </sectiondef>
 187     <briefdescription>
 188     </briefdescription>
 189     <detaileddescription>
 190     </detaileddescription>
 191     <location file="054_parblock.cpp"/>
 192   </compounddef>
 193 </doxygen>