~maria-captains/mariadb-native-client/trunk

« back to all changes in this revision

Viewing changes to docs/funcref/mysql_stmt_param_metadata.xml

  • Committer: Georg Richter
  • Date: 2012-11-26 10:23:56 UTC
  • Revision ID: georg@linux-eozo-20121126102356-llqrnqevaypb2nc6
- Added documentation (docbook based)
- To build the documentation use cmake . -DBUILD_DOCS=yes
- minor fixes in tests

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version='1.0' encoding='UTF-8'?>
 
2
    <refentry id="functions.mysql_stmt_param_metadata" display-name="0">
 
3
      <refmeta>
 
4
        <refentrytitle>mysql_stmt_param_metadata</refentrytitle>
 
5
      </refmeta>
 
6
      <refnamediv>
 
7
        <refname>mysql_stmt_param_metadata</refname>
 
8
        <refpurpose>@function_short_description@</refpurpose>
 
9
      </refnamediv>
 
10
      <refsect1 role="description">
 
11
        <methodsynopsis>
 
12
          <type>MYSQL_RES *</type>
 
13
          <methodname>mysql_stmt_param_metadata</methodname>
 
14
           <methodparam><type>MYSQL_STMT *</type><parameter>stmt</parameter></methodparam>
 
15
 
 
16
        </methodsynopsis>
 
17
        <para>@long_description@</para>
 
18
      </refsect1>
 
19
      <refsect1 role="parameters">
 
20
        <title>Parameters</title>
 
21
          <variablelist>
 
22
           <varlistentry><term><parameter>stmt</parameter></term><listitem><para>! todo !</para></listitem></varlistentry>
 
23
 
 
24
          </variablelist>
 
25
      </refsect1>
 
26
      <refsect1 role="returnvalue">
 
27
        <title>Return value</title>
 
28
        <para>@return_value@</para>
 
29
      </refsect1>
 
30
      <refsect1 role="returnvalue">
 
31
        <note>
 
32
          <title></title>  
 
33
        </note> 
 
34
      </refsect1>
 
35
      <refsect1 role="seealso">
 
36
        <title>See also</title>
 
37
      </refsect1>
 
38
    </refentry>