doc/reference/protocols/facebook/Makefile.am

Mon, 19 Jun 2017 22:50:05 -0400

author
Elliott Sales de Andrade <qulogic@pidgin.im>
date
Mon, 19 Jun 2017 22:50:05 -0400
branch
meson
changeset 38515
2d4d3a8fd23c
parent 38514
86609e84855b
child 38629
02fde6fa7904
permissions
-rw-r--r--

Add documentation to Meson build.

37347
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
1 ## Process this file with automake to produce Makefile.in
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
2
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
3 # We require automake 1.6 at least.
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
4 AUTOMAKE_OPTIONS = 1.6
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
5
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
6 # This is a blank Makefile.am for using gtk-doc.
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
7 # Copy this to your project's API docs directory and modify the variables to
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
8 # suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
9 # of using the various options.
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
10
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
11 # The name of the module, e.g. 'glib'.
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
12 DOC_MODULE=facebook
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
13
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
14 # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
15 #DOC_MODULE_VERSION=2
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
16
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
17 # The top-level XML file (SGML in the past). You can change this if you want to.
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
18 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
19
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
20 # The directory containing the source code. Relative to $(srcdir).
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
21 # gtk-doc will search all .c & .h files beneath here for inline comments
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
22 # documenting the functions and macros.
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
23 # e.g. DOC_SOURCE_DIR=../../../gtk
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
24 DOC_SOURCE_DIR=$(top_srcdir)/libpurple/protocols/$(DOC_MODULE)
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
25
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
26 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
27 SCANGOBJ_OPTIONS=
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
28
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
29 # Extra options to supply to gtkdoc-scan.
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
30 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
31 SCAN_OPTIONS=\
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
32 --deprecated-guards="PURPLE_DISABLE_DEPRECATED" \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
33 --rebuild-types \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
34 --rebuild-sections
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
35
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
36 # Extra options to supply to gtkdoc-mkdb.
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
37 # e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
38 MKDB_OPTIONS=--xml-mode --output-format=xml
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
39
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
40 # Extra options to supply to gtkdoc-mktmpl
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
41 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
42 MKTMPL_OPTIONS=
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
43
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
44 # Extra options to supply to gtkdoc-mkhtml
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
45 MKHTML_OPTIONS=
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
46
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
47 # Extra options to supply to gtkdoc-fixref. Not normally needed.
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
48 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
49 FIXXREF_OPTIONS=
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
50
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
51 # Used for dependencies. The docs will be rebuilt if any of these change.
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
52 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
53 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
54 HFILE_GLOB=$(top_srcdir)/libpurple/protocols/$(DOC_MODULE)/*.h
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
55 CFILE_GLOB=$(top_srcdir)/libpurple/protocols/$(DOC_MODULE)/*.c
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
56
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
57 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
58 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
59 # TODO: those files are not properly scanned when building out-of-tree
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
60 EXTRA_HFILES =
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
61
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
62 # Header files or dirs to ignore when scanning. Use base file/dir names
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
63 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
38514
86609e84855b Remove marshalling files from doc build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 38171
diff changeset
64 IGNORE_HFILES=
37347
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
65
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
66 # Images to copy into HTML directory.
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
67 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
68 HTML_IMAGES=
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
69
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
70 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
71 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
72 content_files = ../version.xml
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
73
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
74 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
75 # These files must be listed here *and* in content_files
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
76 # e.g. expand_content_files=running.sgml
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
77 expand_content_files=
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
78
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
79 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
80 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
81 # signals and properties.
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
82 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
83 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
84 GTKDOC_CFLAGS = \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
85 -I$(top_srcdir) \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
86 -I$(top_srcdir)/libpurple/protocols/$(DOC_MODULE) \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
87 $(GLIB_CFLAGS) \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
88 $(GPLUGIN_CFLAGS) \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
89 $(DEBUG_CFLAGS) \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
90 $(JSON_CFLAGS) \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
91 $(ZLIB_CFLAGS) \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
92 $(INTROSPECTION_CFLAGS)
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
93
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
94 GTKDOC_LIBS = \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
95 $(top_builddir)/libpurple/protocols/$(DOC_MODULE)/lib$(DOC_MODULE).la \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
96 $(STATIC_LINK_LIBS) \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
97 $(GLIB_LIBS) \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
98 $(GPLUGIN_LIBS) \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
99 $(INTLLIBS) \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
100 $(JSON_LIBS) \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
101 $(ZLIB_LIBS) \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
102 $(INTROSPECTION_LIBS)
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
103
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
104 # This includes the standard gtk-doc make rules, copied by gtkdocize.
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
105 include $(top_srcdir)/gtk-doc.make
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
106
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
107 # Other files to distribute
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
108 # e.g. EXTRA_DIST += version.xml.in
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
109
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
110 # Files not to distribute
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
111 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
112 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
113 DISTCLEANFILES = $(DOC_MODULE).types $(DOC_MODULE)-sections.txt
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
114
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
115 dist-hook: html-build.stamp
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
116
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
117 # Comment this out if you want 'make check' to test you doc status
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
118 # and run some sanity checks
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
119 if ENABLE_GTK_DOC
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
120 TESTS_ENVIRONMENT = \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
121 DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
122 SRCDIR=$(abs_srcdir)
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
123 #TODO: fix and enable
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
124 #TESTS = $(GTKDOC_CHECK)
34d43f8c10d1 facebook: added GTK-Doc for the internal APIs
James Geboski <jgeboski@gmail.com>
parents:
diff changeset
125 endif

mercurial