doc/reference/pidgin/Makefile.am

Sat, 12 Oct 2013 16:15:12 +0530

author
Ankit Vani <a@nevitus.org>
date
Sat, 12 Oct 2013 16:15:12 +0530
branch
soc.2013.gobjectification.plugins
changeset 36886
95ef0eeef3d7
parent 36885
e2756fd92168
child 36895
2940eba98d2d
permissions
-rw-r--r--

Added master doc XMLs

36874
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
1 ## Process this file with automake to produce Makefile.in
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
2
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
3 # We require automake 1.6 at least.
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
4 AUTOMAKE_OPTIONS = 1.6
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
5
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
6 # This is a blank Makefile.am for using gtk-doc.
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
7 # Copy this to your project's API docs directory and modify the variables to
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
8 # suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
9 # of using the various options.
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
10
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
11 # The name of the module, e.g. 'glib'.
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
12 DOC_MODULE=pidgin
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
13
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
14 # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
15 #DOC_MODULE_VERSION=2
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
16
36884
1a2d21cc5f74 Increased gtk-doc version requirement from 1.14 to 1.16
Ankit Vani <a@nevitus.org>
parents: 36883
diff changeset
17 # The top-level XML file (SGML in the past). You can change this if you want to.
1a2d21cc5f74 Increased gtk-doc version requirement from 1.14 to 1.16
Ankit Vani <a@nevitus.org>
parents: 36883
diff changeset
18 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
36874
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
19
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
20 # The directory containing the source code. Relative to $(srcdir).
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
21 # gtk-doc will search all .c & .h files beneath here for inline comments
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
22 # documenting the functions and macros.
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
23 # e.g. DOC_SOURCE_DIR=../../../gtk
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
24 DOC_SOURCE_DIR=$(top_srcdir)/$(DOC_MODULE)
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
25
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
26 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
27 SCANGOBJ_OPTIONS=
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
28
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
29 # Extra options to supply to gtkdoc-scan.
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
30 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
36883
61993ff59dd8 Rebuild sections file
Ankit Vani <a@nevitus.org>
parents: 36881
diff changeset
31 SCAN_OPTIONS=\
61993ff59dd8 Rebuild sections file
Ankit Vani <a@nevitus.org>
parents: 36881
diff changeset
32 --deprecated-guards="PURPLE_DISABLE_DEPRECATED|PIDGIN_DISABLE_DEPRECATED" \
61993ff59dd8 Rebuild sections file
Ankit Vani <a@nevitus.org>
parents: 36881
diff changeset
33 --rebuild-sections
36874
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
34
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
35 # Extra options to supply to gtkdoc-mkdb.
36884
1a2d21cc5f74 Increased gtk-doc version requirement from 1.14 to 1.16
Ankit Vani <a@nevitus.org>
parents: 36883
diff changeset
36 # e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
1a2d21cc5f74 Increased gtk-doc version requirement from 1.14 to 1.16
Ankit Vani <a@nevitus.org>
parents: 36883
diff changeset
37 MKDB_OPTIONS=--xml-mode --output-format=xml
36874
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
38
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
39 # Extra options to supply to gtkdoc-mktmpl
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
40 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
41 MKTMPL_OPTIONS=
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
42
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
43 # Extra options to supply to gtkdoc-mkhtml
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
44 MKHTML_OPTIONS=
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
45
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
46 # Extra options to supply to gtkdoc-fixref. Not normally needed.
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
47 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
48 FIXXREF_OPTIONS=
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
49
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
50 # Used for dependencies. The docs will be rebuilt if any of these change.
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
51 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
52 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
53 HFILE_GLOB=$(top_srcdir)/$(DOC_MODULE)/*.h
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
54 CFILE_GLOB=$(top_srcdir)/$(DOC_MODULE)/*.c
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
55
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
56 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
57 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
58 EXTRA_HFILES=
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
59
36884
1a2d21cc5f74 Increased gtk-doc version requirement from 1.14 to 1.16
Ankit Vani <a@nevitus.org>
parents: 36883
diff changeset
60 # Header files or dirs to ignore when scanning. Use base file/dir names
1a2d21cc5f74 Increased gtk-doc version requirement from 1.14 to 1.16
Ankit Vani <a@nevitus.org>
parents: 36883
diff changeset
61 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
36885
e2756fd92168 Added directories to ignore from gtk-doc
Ankit Vani <a@nevitus.org>
parents: 36884
diff changeset
62 IGNORE_HFILES=\
e2756fd92168 Added directories to ignore from gtk-doc
Ankit Vani <a@nevitus.org>
parents: 36884
diff changeset
63 pixmaps \
e2756fd92168 Added directories to ignore from gtk-doc
Ankit Vani <a@nevitus.org>
parents: 36884
diff changeset
64 plugins \
e2756fd92168 Added directories to ignore from gtk-doc
Ankit Vani <a@nevitus.org>
parents: 36884
diff changeset
65 themes \
e2756fd92168 Added directories to ignore from gtk-doc
Ankit Vani <a@nevitus.org>
parents: 36884
diff changeset
66 win32
36874
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
67
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
68 # Images to copy into HTML directory.
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
69 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
70 HTML_IMAGES=
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
71
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
72 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
73 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
74 content_files=version.xml
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
75
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
76 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
77 # These files must be listed here *and* in content_files
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
78 # e.g. expand_content_files=running.sgml
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
79 expand_content_files=
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
80
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
81 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
82 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
83 # signals and properties.
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
84 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
85 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
86 GTKDOC_CFLAGS = \
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
87 -I$(top_srcdir) \
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
88 -I$(top_srcdir)/libpurple \
36881
95ff209fd806 Added cflags and empty .sgml files
Ankit Vani <a@nevitus.org>
parents: 36874
diff changeset
89 -I$(top_srcdir)/pidgin \
95ff209fd806 Added cflags and empty .sgml files
Ankit Vani <a@nevitus.org>
parents: 36874
diff changeset
90 $(GLIB_CFLAGS) \
95ff209fd806 Added cflags and empty .sgml files
Ankit Vani <a@nevitus.org>
parents: 36874
diff changeset
91 $(GPLUGIN_CFLAGS) \
95ff209fd806 Added cflags and empty .sgml files
Ankit Vani <a@nevitus.org>
parents: 36874
diff changeset
92 $(GCR_CFLAGS) \
95ff209fd806 Added cflags and empty .sgml files
Ankit Vani <a@nevitus.org>
parents: 36874
diff changeset
93 $(GSTREAMER_CFLAGS) \
95ff209fd806 Added cflags and empty .sgml files
Ankit Vani <a@nevitus.org>
parents: 36874
diff changeset
94 $(GSTVIDEO_CFLAGS) \
95ff209fd806 Added cflags and empty .sgml files
Ankit Vani <a@nevitus.org>
parents: 36874
diff changeset
95 $(GSTINTERFACES_CFLAGS) \
95ff209fd806 Added cflags and empty .sgml files
Ankit Vani <a@nevitus.org>
parents: 36874
diff changeset
96 $(DEBUG_CFLAGS) \
95ff209fd806 Added cflags and empty .sgml files
Ankit Vani <a@nevitus.org>
parents: 36874
diff changeset
97 $(GTK_CFLAGS) \
95ff209fd806 Added cflags and empty .sgml files
Ankit Vani <a@nevitus.org>
parents: 36874
diff changeset
98 $(X11_CFLAGS) \
95ff209fd806 Added cflags and empty .sgml files
Ankit Vani <a@nevitus.org>
parents: 36874
diff changeset
99 $(DBUS_CFLAGS) \
95ff209fd806 Added cflags and empty .sgml files
Ankit Vani <a@nevitus.org>
parents: 36874
diff changeset
100 $(GTKSPELL_CFLAGS) \
95ff209fd806 Added cflags and empty .sgml files
Ankit Vani <a@nevitus.org>
parents: 36874
diff changeset
101 $(LIBXML_CFLAGS) \
95ff209fd806 Added cflags and empty .sgml files
Ankit Vani <a@nevitus.org>
parents: 36874
diff changeset
102 $(WEBKIT_CFLAGS) \
95ff209fd806 Added cflags and empty .sgml files
Ankit Vani <a@nevitus.org>
parents: 36874
diff changeset
103 $(INTGG_CFLAGS)
36874
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
104
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
105 GTKDOC_LIBS = \
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
106 $(top_builddir)/pidgin/libpidgin.la
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
107
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
108 # This includes the standard gtk-doc make rules, copied by gtkdocize.
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
109 include $(top_srcdir)/gtk-doc.make
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
110
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
111 # Other files to distribute
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
112 # e.g. EXTRA_DIST += version.xml.in
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
113 EXTRA_DIST += version.xml.in
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
114
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
115 # Files not to distribute
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
116 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
117 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
36883
61993ff59dd8 Rebuild sections file
Ankit Vani <a@nevitus.org>
parents: 36881
diff changeset
118 DISTCLEANFILES = $(DOC_MODULE)-sections.txt
36874
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
119
36884
1a2d21cc5f74 Increased gtk-doc version requirement from 1.14 to 1.16
Ankit Vani <a@nevitus.org>
parents: 36883
diff changeset
120 # Comment this out if you want 'make check' to test you doc status
1a2d21cc5f74 Increased gtk-doc version requirement from 1.14 to 1.16
Ankit Vani <a@nevitus.org>
parents: 36883
diff changeset
121 # and run some sanity checks
36874
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
122 if ENABLE_GTK_DOC
36884
1a2d21cc5f74 Increased gtk-doc version requirement from 1.14 to 1.16
Ankit Vani <a@nevitus.org>
parents: 36883
diff changeset
123 TESTS_ENVIRONMENT = \
1a2d21cc5f74 Increased gtk-doc version requirement from 1.14 to 1.16
Ankit Vani <a@nevitus.org>
parents: 36883
diff changeset
124 DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
1a2d21cc5f74 Increased gtk-doc version requirement from 1.14 to 1.16
Ankit Vani <a@nevitus.org>
parents: 36883
diff changeset
125 SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
36886
95ef0eeef3d7 Added master doc XMLs
Ankit Vani <a@nevitus.org>
parents: 36885
diff changeset
126 TESTS = $(GTKDOC_CHECK)
36874
3560f0bc6eaf Intrgeated gtk-doc with the project
Ankit Vani <a@nevitus.org>
parents:
diff changeset
127 endif

mercurial