[gdk-pixbuf/doc-fixes: 2/2] Add `gtk_doc` build option



commit 7abf49189832d3b6891579fb1a6af6ad5e2d1304
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Fri Jun 26 11:15:10 2020 +0100

    Add `gtk_doc` build option
    
    And deprecate the `docs` one.
    
    The `gtk_doc` option is shared across GNOME modules, so we should
    conform to the established practice.

 docs/meson.build  | 4 ++++
 meson_options.txt | 6 +++++-
 2 files changed, 9 insertions(+), 1 deletion(-)
---
diff --git a/docs/meson.build b/docs/meson.build
index 4615bfaad..c7c8fe721 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -33,6 +33,10 @@ private_headers = [
 ]
 
 if get_option('docs')
+  warning('The "docs" build option is deprecated; please use "gtk_doc=true"')
+endif
+
+if get_option('gtk_doc') or get_option('docs')
   gnome.gtkdoc('gdk-pixbuf',
                main_xml: 'gdk-pixbuf.xml',
                src_dir: [ gdk_pixbuf_inc ],
diff --git a/meson_options.txt b/meson_options.txt
index 1add5a86b..c22d29425 100644
--- a/meson_options.txt
+++ b/meson_options.txt
@@ -18,10 +18,14 @@ option('builtin_loaders',
        description: 'Comma-separated list of loaders to build into gdk-pixbuf, or "none", or "all" to build 
all buildable loaders into gdk-pixbuf',
        type: 'string',
        value: 'none')
-option('docs',
+option('gtk_doc',
        description: 'Whether to generate the API reference (requires GTK-Doc)',
        type: 'boolean',
        value: false)
+option('docs',
+       description: 'Whether to generate the whole documentation (see: gtk_doc and man options) 
[Deprecated]',
+       type: 'boolean',
+       value: false)
 option('gir',
        description: 'Whether to generate the API introspection data (requires GObject-Introspection)',
        type: 'boolean',


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