summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2019-03-13 17:39:33 +0000
committerEmmanuele Bassi <ebassi@gnome.org>2019-03-13 17:44:32 +0000
commit7771869ab307a4f9bcfcdaca9fe3bc79f24672ae (patch)
tree4a20f1f2d1838d80fa123d7ca7cd2af96698a899 /docs
parentd9a382d689b9159daca09e33510ea229a17d37be (diff)
downloadgtk+-7771869ab307a4f9bcfcdaca9fe3bc79f24672ae.tar.gz
Move the gtkunixprint.h include in the gtk-doc stanza
Every time a new <INCLUDE> directive is used inside a gtk-doc sections.txt file it overrides the current include header until the next <INCLUDE> directive. This has the unfortunate effect of making every single section following the print-related ones to generate documentation that says to include gtkunixprint.h. In order to avoid re-arranging the gtk3-sections.txt file, we can tell gtk-doc what's the default header to include for GTK, and override it using `@Include` directives directly into the gtk-doc stanzas of the sections that require a different header. Fixes: #1746
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/gtk/Makefile.am2
-rw-r--r--docs/reference/gtk/gtk3-sections.txt6
2 files changed, 1 insertions, 7 deletions
diff --git a/docs/reference/gtk/Makefile.am b/docs/reference/gtk/Makefile.am
index 9442a5d55d..abdea7fb59 100644
--- a/docs/reference/gtk/Makefile.am
+++ b/docs/reference/gtk/Makefile.am
@@ -276,7 +276,7 @@ GTKDOC_LIBS = \
# Extra options to supply to gtkdoc-mkdb
-MKDB_OPTIONS=--output-format=xml --name-space=gtk
+MKDB_OPTIONS=--output-format=xml --name-space=gtk --default-includes=gtk/gtk.h
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
content_files = \
diff --git a/docs/reference/gtk/gtk3-sections.txt b/docs/reference/gtk/gtk3-sections.txt
index ab10ddd025..8d379018c0 100644
--- a/docs/reference/gtk/gtk3-sections.txt
+++ b/docs/reference/gtk/gtk3-sections.txt
@@ -1,6 +1,3 @@
-
-<INCLUDE>gtk/gtk.h</INCLUDE>
-
<SECTION>
<FILE>gtkaboutdialog</FILE>
<TITLE>GtkAboutDialog</TITLE>
@@ -7089,7 +7086,6 @@ GtkPrintOperationPrivate
<SECTION>
-<INCLUDE>gtk/gtkunixprint.h</INCLUDE>
<FILE>gtkprintunixdialog</FILE>
<TITLE>GtkPrintUnixDialog</TITLE>
GtkPrintUnixDialog
@@ -7436,7 +7432,6 @@ gtk_print_context_get_type
<SECTION>
-<INCLUDE>gtk/gtkunixprint.h</INCLUDE>
<FILE>gtkprintjob</FILE>
<TITLE>GtkPrintJob</TITLE>
GtkPrintJob
@@ -7488,7 +7483,6 @@ gtk_print_job_get_type
<SECTION>
-<INCLUDE>gtk/gtkunixprint.h</INCLUDE>
<FILE>gtkpagesetupunixdialog</FILE>
<TITLE>GtkPageSetupUnixDialog</TITLE>
GtkPageSetupUnixDialog