summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKay Sievers <kay@vrfy.org>2012-04-20 03:25:36 +0200
committerKay Sievers <kay@vrfy.org>2012-04-20 03:25:36 +0200
commit21dbe43aece5b6fc87860de175f067b56649e7d1 (patch)
treee57256a49cb54eb61ba03b01ce5c199e2b8d4a08 /docs
parent80037e4d17d0c8f28d0ff610902babc9e2b4e2f9 (diff)
docs: hook-up gtk-doc to 'make check'
Diffstat (limited to 'docs')
-rw-r--r--docs/gudev/Makefile.am10
-rw-r--r--docs/gudev/gudev-docs.xml10
-rw-r--r--docs/gudev/gudev-sections.txt13
-rw-r--r--docs/libudev/Makefile.am4
-rw-r--r--docs/libudev/libudev-docs.xml3
5 files changed, 17 insertions, 23 deletions
diff --git a/docs/gudev/Makefile.am b/docs/gudev/Makefile.am
index f984eb5cb..11312b679 100644
--- a/docs/gudev/Makefile.am
+++ b/docs/gudev/Makefile.am
@@ -57,7 +57,7 @@ EXTRA_HFILES=
# Header files to ignore when scanning. Use base file name, no paths
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES=
+IGNORE_HFILES=gudevenumtypes.h gudevmarshal.h
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
@@ -83,8 +83,8 @@ GTKDOC_CFLAGS = \
-I$(top_builddir)/src/gudev
GTKDOC_LIBS = \
- $(GLIB_LIBS) \
- $(top_builddir)/libgudev-1.0.la
+ $(GLIB_LIBS) \
+ $(top_builddir)/libgudev-1.0.la
# This includes the standard gtk-doc make rules, copied by gtkdocize.
include $(top_srcdir)/gtk-doc.make
@@ -100,8 +100,8 @@ EXTRA_DIST += version.xml.in
# Comment this out if you want your docs-status tested during 'make check'
if ENABLE_GTK_DOC
-#TESTS_ENVIRONMENT = cd $(srcsrc)
-#TESTS = $(GTKDOC_CHECK)
+TESTS_ENVIRONMENT = cd $(top_srcdir)
+TESTS = $(GTKDOC_CHECK)
endif
install-data-hook:
diff --git a/docs/gudev/gudev-docs.xml b/docs/gudev/gudev-docs.xml
index 30be83669..847d24252 100644
--- a/docs/gudev/gudev-docs.xml
+++ b/docs/gudev/gudev-docs.xml
@@ -33,8 +33,9 @@
<xi:include href="xml/tree_index.sgml"/>
</chapter>
- <index>
- <title>Index</title>
+ <index id="api-index-full">
+ <title>API Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
<index role="165">
@@ -42,5 +43,10 @@
<xi:include href="xml/api-index-165.xml"><xi:fallback /></xi:include>
</index>
+ <index id="api-index-deprecated" role="deprecated">
+ <title>Index of deprecated API</title>
+ <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+ </index>
+
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</book>
diff --git a/docs/gudev/gudev-sections.txt b/docs/gudev/gudev-sections.txt
index 213e1a746..b25c13bcb 100644
--- a/docs/gudev/gudev-sections.txt
+++ b/docs/gudev/gudev-sections.txt
@@ -98,16 +98,3 @@ G_UDEV_ENUMERATOR_GET_CLASS
<SUBSECTION Private>
GUdevEnumeratorPrivate
</SECTION>
-
-<SECTION>
-<FILE>gudevmarshal</FILE>
-<SUBSECTION Private>
-g_udev_marshal_VOID__STRING_OBJECT
-</SECTION>
-
-<SECTION>
-<FILE>gudevenumtypes</FILE>
-<SUBSECTION Private>
-G_TYPE_UDEV_DEVICE_TYPE
-g_udev_device_type_get_type
-</SECTION>
diff --git a/docs/libudev/Makefile.am b/docs/libudev/Makefile.am
index 0aff6008f..0b01274aa 100644
--- a/docs/libudev/Makefile.am
+++ b/docs/libudev/Makefile.am
@@ -94,8 +94,8 @@ EXTRA_DIST += version.xml.in
# Comment this out if you want your docs-status tested during 'make check'
if ENABLE_GTK_DOC
-#TESTS_ENVIRONMENT = cd $(srcsrc)
-#TESTS = $(GTKDOC_CHECK)
+TESTS_ENVIRONMENT = cd $(top_srcdir)
+TESTS = $(GTKDOC_CHECK)
endif
install-data-hook:
diff --git a/docs/libudev/libudev-docs.xml b/docs/libudev/libudev-docs.xml
index 2d856ced0..d8248aaaf 100644
--- a/docs/libudev/libudev-docs.xml
+++ b/docs/libudev/libudev-docs.xml
@@ -29,10 +29,11 @@
<xi:include href="xml/libudev-enumerate.xml"/>
<xi:include href="xml/libudev-queue.xml"/>
<xi:include href="xml/libudev-util.xml"/>
+ <xi:include href="xml/api-index-deprecated.xml"/>
</chapter>
<index id="api-index-full">
<title>Index</title>
- <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ <xi:include href="xml/api-index-full.xml"/>
</index>
</book>