|
Than Ngo |
b7bcaa |
|
|
Than Ngo |
b7bcaa |
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="">
|
|
Than Ngo |
b7bcaa |
<compounddef id="054__parblock_8cpp" kind="file" language="C++">
|
|
Than Ngo |
b7bcaa |
<compoundname>054_parblock.cpp</compoundname>
|
|
Than Ngo |
b7bcaa |
<sectiondef kind="func">
|
|
Than Ngo |
b7bcaa |
<memberdef kind="function" id="054__parblock_8cpp_1a2dd0ac47f42a9994b91d34403be05fe9" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
Than Ngo |
b7bcaa |
<type>void</type>
|
|
Than Ngo |
b7bcaa |
<definition>void function</definition>
|
|
Than Ngo |
b7bcaa |
<argsstring>(int client, int *resource, int parblock, int *test, int p)</argsstring>
|
|
Than Ngo |
b7bcaa |
<name>function</name>
|
|
Than Ngo |
b7bcaa |
<param>
|
|
Than Ngo |
b7bcaa |
<type>int</type>
|
|
Than Ngo |
b7bcaa |
<declname>client</declname>
|
|
Than Ngo |
b7bcaa |
</param>
|
|
Than Ngo |
b7bcaa |
<param>
|
|
Than Ngo |
b7bcaa |
<type>int *</type>
|
|
Than Ngo |
b7bcaa |
<declname>resource</declname>
|
|
Than Ngo |
b7bcaa |
</param>
|
|
Than Ngo |
b7bcaa |
<param>
|
|
Than Ngo |
b7bcaa |
<type>int</type>
|
|
Than Ngo |
b7bcaa |
<declname>parblock</declname>
|
|
Than Ngo |
b7bcaa |
</param>
|
|
Than Ngo |
b7bcaa |
<param>
|
|
Than Ngo |
b7bcaa |
<type>int *</type>
|
|
Than Ngo |
b7bcaa |
<declname>test</declname>
|
|
Than Ngo |
b7bcaa |
</param>
|
|
Than Ngo |
b7bcaa |
<param>
|
|
Than Ngo |
b7bcaa |
<type>int</type>
|
|
Than Ngo |
b7bcaa |
<declname>p</declname>
|
|
Than Ngo |
b7bcaa |
</param>
|
|
Than Ngo |
b7bcaa |
<briefdescription>
|
|
Than Ngo |
b7bcaa |
</briefdescription>
|
|
Than Ngo |
b7bcaa |
<detaileddescription>
|
|
Than Ngo |
b7bcaa |
<para>call by target-specific code to manage resources required by the client.</para>
|
|
Than Ngo |
b7bcaa |
<para>
|
|
Than Ngo |
b7bcaa |
<parameterlist kind="param">
|
|
Than Ngo |
b7bcaa |
<parameteritem>
|
|
Than Ngo |
b7bcaa |
<parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parametername direction="in">client</parametername>
|
|
Than Ngo |
b7bcaa |
</parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parameterdescription>
|
|
Than Ngo |
b7bcaa |
<para>ID of client requesting resource. </para>
|
|
Than Ngo |
b7bcaa |
</parameterdescription>
|
|
Than Ngo |
b7bcaa |
</parameteritem>
|
|
Than Ngo |
b7bcaa |
<parameteritem>
|
|
Than Ngo |
b7bcaa |
<parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parametername direction="out">resource</parametername>
|
|
Than Ngo |
b7bcaa |
</parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parameterdescription>
|
|
Than Ngo |
b7bcaa |
<para>Requested resource </para>
|
|
Than Ngo |
b7bcaa |
</parameterdescription>
|
|
Than Ngo |
b7bcaa |
</parameteritem>
|
|
Than Ngo |
b7bcaa |
<parameteritem>
|
|
Than Ngo |
b7bcaa |
<parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parametername direction="in">parblock</parametername>
|
|
Than Ngo |
b7bcaa |
</parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parameterdescription>
|
|
Than Ngo |
b7bcaa |
<para>
|
|
Than Ngo |
b7bcaa |
<parblock>
|
|
Than Ngo |
b7bcaa |
<para>This is a test for the @parblock command.</para>
|
|
Than Ngo |
b7bcaa |
<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>
|
|
Than Ngo |
b7bcaa |
</para>
|
|
Than Ngo |
b7bcaa |
<para>This is the second paragraph description for the @parblock parameter. Always end the text inside the @parblock command with an @endparblock command. </para>
|
|
Than Ngo |
b7bcaa |
</parblock>
|
|
Than Ngo |
b7bcaa |
</para>
|
|
Than Ngo |
b7bcaa |
</parameterdescription>
|
|
Than Ngo |
b7bcaa |
</parameteritem>
|
|
Than Ngo |
b7bcaa |
<parameteritem>
|
|
Than Ngo |
b7bcaa |
<parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parametername direction="out">test</parametername>
|
|
Than Ngo |
b7bcaa |
</parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parameterdescription>
|
|
Than Ngo |
b7bcaa |
<para>This is a test parameter for this function to see if it is included in the parameter table </para>
|
|
Than Ngo |
b7bcaa |
</parameterdescription>
|
|
Than Ngo |
b7bcaa |
</parameteritem>
|
|
Than Ngo |
b7bcaa |
<parameteritem>
|
|
Than Ngo |
b7bcaa |
<parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parametername direction="in">p</parametername>
|
|
Than Ngo |
b7bcaa |
</parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parameterdescription>
|
|
Than Ngo |
b7bcaa |
<para>
|
|
Than Ngo |
b7bcaa |
<parblock>
|
|
Than Ngo |
b7bcaa |
<para>First paragraph of the param description.</para>
|
|
Than Ngo |
b7bcaa |
<para>Second paragraph of the param description. </para>
|
|
Than Ngo |
b7bcaa |
</parblock>
|
|
Than Ngo |
b7bcaa |
</para>
|
|
Than Ngo |
b7bcaa |
</parameterdescription>
|
|
Than Ngo |
b7bcaa |
</parameteritem>
|
|
Than Ngo |
b7bcaa |
</parameterlist>
|
|
Than Ngo |
b7bcaa |
</para>
|
|
Than Ngo |
b7bcaa |
</detaileddescription>
|
|
Than Ngo |
b7bcaa |
<inbodydescription>
|
|
Than Ngo |
b7bcaa |
</inbodydescription>
|
|
Than Ngo |
b7bcaa |
<location file="054_parblock.cpp" line="33" column="1"/>
|
|
Than Ngo |
b7bcaa |
</memberdef>
|
|
Than Ngo |
b7bcaa |
<memberdef kind="function" id="054__parblock_8cpp_1a5cded03ec9e6fd626da35ab05f624f39" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
Than Ngo |
b7bcaa |
<type>void</type>
|
|
Than Ngo |
b7bcaa |
<definition>void function_2</definition>
|
|
Than Ngo |
b7bcaa |
<argsstring>(int client, int *resource, int parblock, int *test, int p)</argsstring>
|
|
Than Ngo |
b7bcaa |
<name>function_2</name>
|
|
Than Ngo |
b7bcaa |
<param>
|
|
Than Ngo |
b7bcaa |
<type>int</type>
|
|
Than Ngo |
b7bcaa |
<declname>client</declname>
|
|
Than Ngo |
b7bcaa |
</param>
|
|
Than Ngo |
b7bcaa |
<param>
|
|
Than Ngo |
b7bcaa |
<type>int *</type>
|
|
Than Ngo |
b7bcaa |
<declname>resource</declname>
|
|
Than Ngo |
b7bcaa |
</param>
|
|
Than Ngo |
b7bcaa |
<param>
|
|
Than Ngo |
b7bcaa |
<type>int</type>
|
|
Than Ngo |
b7bcaa |
<declname>parblock</declname>
|
|
Than Ngo |
b7bcaa |
</param>
|
|
Than Ngo |
b7bcaa |
<param>
|
|
Than Ngo |
b7bcaa |
<type>int *</type>
|
|
Than Ngo |
b7bcaa |
<declname>test</declname>
|
|
Than Ngo |
b7bcaa |
</param>
|
|
Than Ngo |
b7bcaa |
<param>
|
|
Than Ngo |
b7bcaa |
<type>int</type>
|
|
Than Ngo |
b7bcaa |
<declname>p</declname>
|
|
Than Ngo |
b7bcaa |
</param>
|
|
Than Ngo |
b7bcaa |
<briefdescription>
|
|
Than Ngo |
b7bcaa |
</briefdescription>
|
|
Than Ngo |
b7bcaa |
<detaileddescription>
|
|
Than Ngo |
b7bcaa |
<para>call by target-specific code to manage resources required by the client.</para>
|
|
Than Ngo |
b7bcaa |
<para>
|
|
Than Ngo |
b7bcaa |
<parameterlist kind="param">
|
|
Than Ngo |
b7bcaa |
<parameteritem>
|
|
Than Ngo |
b7bcaa |
<parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parametername direction="in">client</parametername>
|
|
Than Ngo |
b7bcaa |
</parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parameterdescription>
|
|
Than Ngo |
b7bcaa |
<para>ID of client requesting resource. </para>
|
|
Than Ngo |
b7bcaa |
</parameterdescription>
|
|
Than Ngo |
b7bcaa |
</parameteritem>
|
|
Than Ngo |
b7bcaa |
<parameteritem>
|
|
Than Ngo |
b7bcaa |
<parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parametername direction="out">resource</parametername>
|
|
Than Ngo |
b7bcaa |
</parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parameterdescription>
|
|
Than Ngo |
b7bcaa |
<para>Requested resource </para>
|
|
Than Ngo |
b7bcaa |
</parameterdescription>
|
|
Than Ngo |
b7bcaa |
</parameteritem>
|
|
Than Ngo |
b7bcaa |
<parameteritem>
|
|
Than Ngo |
b7bcaa |
<parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parametername direction="in">parblock</parametername>
|
|
Than Ngo |
b7bcaa |
</parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parameterdescription>
|
|
Than Ngo |
b7bcaa |
<para>
|
|
Than Ngo |
b7bcaa |
<parblock>
|
|
Than Ngo |
b7bcaa |
<para>This is a test for the @parblock command.</para>
|
|
Than Ngo |
b7bcaa |
<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>
|
|
Than Ngo |
b7bcaa |
</para>
|
|
Than Ngo |
b7bcaa |
<para>This is the second paragraph description for the @parblock parameter. Always end the text inside the @parblock command with an @endparblock command. </para>
|
|
Than Ngo |
b7bcaa |
</parblock>
|
|
Than Ngo |
b7bcaa |
</para>
|
|
Than Ngo |
b7bcaa |
</parameterdescription>
|
|
Than Ngo |
b7bcaa |
</parameteritem>
|
|
Than Ngo |
b7bcaa |
<parameteritem>
|
|
Than Ngo |
b7bcaa |
<parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parametername direction="out">test</parametername>
|
|
Than Ngo |
b7bcaa |
</parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parameterdescription>
|
|
Than Ngo |
b7bcaa |
<para>This is a test parameter for this function to see if it is included in the parameter table </para>
|
|
Than Ngo |
b7bcaa |
</parameterdescription>
|
|
Than Ngo |
b7bcaa |
</parameteritem>
|
|
Than Ngo |
b7bcaa |
<parameteritem>
|
|
Than Ngo |
b7bcaa |
<parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parametername direction="in">p</parametername>
|
|
Than Ngo |
b7bcaa |
</parameternamelist>
|
|
Than Ngo |
b7bcaa |
<parameterdescription>
|
|
Than Ngo |
b7bcaa |
<para>
|
|
Than Ngo |
b7bcaa |
<parblock>
|
|
Than Ngo |
b7bcaa |
<para>First paragraph of the param description. <verbatim> Second paragraph of the param description.
|
|
Than Ngo |
b7bcaa |
</verbatim> </para>
|
|
Than Ngo |
b7bcaa |
</parblock>
|
|
Than Ngo |
b7bcaa |
</para>
|
|
Than Ngo |
b7bcaa |
</parameterdescription>
|
|
Than Ngo |
b7bcaa |
</parameteritem>
|
|
Than Ngo |
b7bcaa |
</parameterlist>
|
|
Than Ngo |
b7bcaa |
</para>
|
|
Than Ngo |
b7bcaa |
</detaileddescription>
|
|
Than Ngo |
b7bcaa |
<inbodydescription>
|
|
Than Ngo |
b7bcaa |
</inbodydescription>
|
|
Than Ngo |
b7bcaa |
<location file="054_parblock.cpp" line="60" column="1"/>
|
|
Than Ngo |
b7bcaa |
</memberdef>
|
|
Than Ngo |
b7bcaa |
</sectiondef>
|
|
Than Ngo |
b7bcaa |
<briefdescription>
|
|
Than Ngo |
b7bcaa |
</briefdescription>
|
|
Than Ngo |
b7bcaa |
<detaileddescription>
|
|
Than Ngo |
b7bcaa |
</detaileddescription>
|
|
Than Ngo |
b7bcaa |
<location file="054_parblock.cpp"/>
|
|
Than Ngo |
b7bcaa |
</compounddef>
|
|
Than Ngo |
b7bcaa |
</doxygen>
|