doc/refentry.xml


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

<refentry id="refXXXX">

  <refmeta>
    <refentrytitle>ne_foo</refentrytitle>
    <manvolnum>3</manvolnum>
  </refmeta>

  <refnamediv>
    <refname id="ne_foo">ne_foo</refname>
    <refname id="ne_bar">ne_bar</refname>
    <refpurpose>functions which do foo and bar</refpurpose>
  </refnamediv>
  
  <refsynopsisdiv>

    <funcsynopsis>

      <funcsynopsisinfo>#include &lt;ne_header.h&gt;</funcsynopsisinfo>

      <funcprototype>
        <funcdef>void <function>ne_set_useragent</function></funcdef>
        <paramdef>ne_session *<parameter>session</parameter></paramdef>
        <paramdef>const char *<parameter>product</parameter></paramdef>
      </funcprototype>

    </funcsynopsis>

  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para>XXX</para>

  </refsect1>

  <refsect1>
    <title>Return value</title>

    <para>XXX</para>
  </refsect1>

  <refsect1>
    <title>Examples</title>

    <para>XXX</para>
  </refsect1>

  <refsect1>
    <title>See also</title>

    <para>XXX</para>
  </refsect1>

</refentry>