[libmediaart/ebassi/no-more-autotools: 10/11] docs: Overhaul the build




commit 5d4cc95dad9c3faa0172fb9b0cd9f65e7b542ac8
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Thu May 20 20:56:14 2021 +0100

    docs: Overhaul the build
    
     - Use the ignore_headers argument instead of passing it to gtkdoc-scan
       ourselves
     - Ignore the symbol decorator for the public API
     - Specify the default include
     - Hide the media_art_process_get_type() function
     - Build the types file, so that gtk-doc will recognise GObject types
     - Add gtkdoc-check to the test suite, so that undocumented API slips
       through

 docs/libmediaart-sections.txt |  5 +++--
 docs/meson.build              | 14 ++++++++++++--
 2 files changed, 15 insertions(+), 4 deletions(-)
---
diff --git a/docs/libmediaart-sections.txt b/docs/libmediaart-sections.txt
index eb94ed2..db9d7cc 100644
--- a/docs/libmediaart-sections.txt
+++ b/docs/libmediaart-sections.txt
@@ -16,8 +16,6 @@ MediaArtError
 MediaArtProcessFlags
 MediaArtProcess
 MediaArtProcessClass
-media_art_error_quark
-media_art_process_get_type
 media_art_process_new
 media_art_process_uri
 media_art_process_uri_async
@@ -28,6 +26,7 @@ media_art_process_file_finish
 media_art_process_buffer
 media_art_process_buffer_async
 media_art_process_buffer_finish
+media_art_error_quark
 <SUBSECTION Standard>
 MEDIA_ART_IS_PROCESS
 MEDIA_ART_IS_PROCESS_CLASS
@@ -35,6 +34,8 @@ MEDIA_ART_PROCESS
 MEDIA_ART_PROCESS_CLASS
 MEDIA_ART_PROCESS_GET_CLASS
 MEDIA_ART_TYPE_PROCESS
+<SUBSECTION Private>
+media_art_process_get_type
 </SECTION>
 
 <SECTION>
diff --git a/docs/meson.build b/docs/meson.build
index fce7248..2b6cf36 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -7,14 +7,24 @@ if get_option('gtk_doc')
         'marshal.h',
     ]
 
+    ignored_decorators = [
+        '_LIBMEDIAART_EXTERN',
+    ]
+
     gnome.gtkdoc('libmediaart',
         namespace: 'media_art',
         src_dir: include_directories('../libmediaart'),
         main_xml: 'libmediaart-docs.xml',
+        ignore_headers: ignored_headers,
         scan_args: [
-            '--ignore-headers=' + ' '.join(ignored_headers),
+            '--rebuild-types',
+            '--ignore-decorators=' + '|'.join(ignored_decorators),
+        ],
+        mkdb_args: [
+            '--default-include=libmediaart/mediaart.h',
         ],
         content_files: ['overview.xml'],
         dependencies: libmediaart_dep,
-        install: true)
+        install: true,
+        check: true)
 endif


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]