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
|
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!ENTITY dhfirstname "<firstname>Christian</firstname>">
<!ENTITY dhsurname "<surname>Marillat</surname>">
<!ENTITY dhdate "<date>august 6, 2001</date>">
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>marillat@debian.org</email>">
<!ENTITY dhusername "Christian Marillat">
<!ENTITY dhucpackage "<refentrytitle>gtkdoc-scan</refentrytitle>">
<!ENTITY dhpackage "gtkdoc-scan">
<!ENTITY debian "<productname>Debian GNU/Linux</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
]>
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2001</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose> Extracts declarations of functions, macros, enums, structs
and unions from header files.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg><option> MODULE name </option></arg>
<arg><option> source directory <replaceable>(optional)</replaceable> </option></arg>
<arg><option> output directory <replaceable>(optional)</replaceable> </option></arg>
<arg><option> header file </option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>&dhpackage;</command> Extracts declarations of functions,
macros, enums, structs and unions from header files.</para>
<para>It is called with a module name, an optional source directory, an
optional output directory, and the header files to scan.</para>
<para>It outputs all declarations found to a file named
<replaceable>MODULE</replaceable>-decl.txt, and the list of declarations to another file
<replaceable>MODULE</replaceable>-decl-list.txt</para>
<para>This second list file is typically copied to
'$MODULE-sections.txt' and organized into sections ready to output the
SGML pages.</para>
<para>This binary must be used inside a Makefile and not directly in a
command line. See section EXAMPLE.</para>
</refsect1>
<refsect1>
<title>EXAMPLE</title>
<para>See /usr/share/doc/gtk-doc-tools/examples, for a makefile.am and a
configure.in example file.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>This manual page was written by &dhusername; &dhemail; for
the &debian; system (but may be used by others).</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
|
