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