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