summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2021-05-20 20:31:42 +0100
committerCarlos Garnacho <carlosg@gnome.org>2021-05-22 13:29:59 +0200
commit96152f38d7cc16155e8451614624f4d46b13b3f2 (patch)
tree02dd990483dbe745cba120ddac0ccca44f5e9e34 /docs
parent5ec57f6fae22953adff0ab10325b29eeffc80a60 (diff)
downloadlibmediaart-96152f38d7cc16155e8451614624f4d46b13b3f2.tar.gz
docs: Use a more idiomatic gtk-doc set up
- look for sources in both source and build directories - depend on the built library - ignore the generated, uninstalled marshallers header - make gtk-doc track the overview.xml file - add the missing indices - add the missing symbols - use a boolean `gtk_doc` build option, like every other GNOME project
Diffstat (limited to 'docs')
-rw-r--r--docs/libmediaart-docs.xml31
-rw-r--r--docs/libmediaart-sections.txt13
-rw-r--r--docs/meson.build14
-rw-r--r--docs/overview.xml (renamed from docs/overview.sgml)0
4 files changed, 48 insertions, 10 deletions
diff --git a/docs/libmediaart-docs.xml b/docs/libmediaart-docs.xml
index 38a5021..4e3c17b 100644
--- a/docs/libmediaart-docs.xml
+++ b/docs/libmediaart-docs.xml
@@ -17,7 +17,7 @@
</bookinfo>
<!-- The Library Overview -->
- <xi:include href="overview.sgml"/>
+ <xi:include href="overview.xml"/>
<!-- The API Reference -->
<part id="libmediaart-reference">
@@ -37,5 +37,34 @@
</part>
+ <index id="api-index-full">
+ <title>Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-deprecated" role="deprecated">
+ <title>Index of deprecated symbols</title>
+ <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-0-1" role="0.1">
+ <title>Index of new symbols in 0.1</title>
+ <xi:include href="xml/api-index-0.1.0.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-0-2" role="0.2">
+ <title>Index of new symbols in 0.2</title>
+ <xi:include href="xml/api-index-0.2.0.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-0-3" role="0.3">
+ <title>Index of new symbols in 0.3</title>
+ <xi:include href="xml/api-index-0.3.0.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-0-5" role="0.5">
+ <title>Index of new symbols in 0.5</title>
+ <xi:include href="xml/api-index-0.5.0.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-0-7" role="0.7">
+ <title>Index of new symbols in 0.7</title>
+ <xi:include href="xml/api-index-0.7.0.xml"><xi:fallback /></xi:include>
+ </index>
+
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</book>
diff --git a/docs/libmediaart-sections.txt b/docs/libmediaart-sections.txt
index 1de8fe7..eb94ed2 100644
--- a/docs/libmediaart-sections.txt
+++ b/docs/libmediaart-sections.txt
@@ -20,8 +20,14 @@ media_art_error_quark
media_art_process_get_type
media_art_process_new
media_art_process_uri
+media_art_process_uri_async
+media_art_process_uri_finish
media_art_process_file
+media_art_process_file_async
+media_art_process_file_finish
media_art_process_buffer
+media_art_process_buffer_async
+media_art_process_buffer_finish
<SUBSECTION Standard>
MEDIA_ART_IS_PROCESS
MEDIA_ART_IS_PROCESS_CLASS
@@ -38,10 +44,3 @@ media_art_plugin_shutdown
media_art_file_to_jpeg
media_art_buffer_to_jpeg
</SECTION>
-
-<SECTION>
-<FILE>marshal</FILE>
-media_art_marshal_VOID__STRING_STRING
-media_art_marshal_VOID__STRING_STRING_STRING_BOOLEAN_BOOLEAN
-</SECTION>
-
diff --git a/docs/meson.build b/docs/meson.build
index 601ea43..fce7248 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -1,10 +1,20 @@
-if get_option('with-docs') != 'no'
+if get_option('gtk_doc')
version_xml = configure_file(input: 'version.xml.in',
output: 'version.xml',
configuration: conf)
+ ignored_headers = [
+ 'marshal.h',
+ ]
+
gnome.gtkdoc('libmediaart',
- src_dir: 'libmediaart',
+ namespace: 'media_art',
+ src_dir: include_directories('../libmediaart'),
main_xml: 'libmediaart-docs.xml',
+ scan_args: [
+ '--ignore-headers=' + ' '.join(ignored_headers),
+ ],
+ content_files: ['overview.xml'],
+ dependencies: libmediaart_dep,
install: true)
endif
diff --git a/docs/overview.sgml b/docs/overview.xml
index 80dad6e..80dad6e 100644
--- a/docs/overview.sgml
+++ b/docs/overview.xml