docs/reference/gio/meson.build

   1 if get_option('with-docs') != 'no'
   2   subdir('xml')
   3
   4   ignore_headers = [
   5     'fam',
   6     'fen',
   7     'gdbus-2.0',
   8     'gvdb',
   9     'inotify',
  10     'kqueue',
  11     'libasyncns',
  12     'tests',
  13     'win32',
  14     'xdgmime',
  15     'gappinfoprivate.h',
  16     'gapplicationimpl.h',
  17     'gasynchelper.h',
  18     'gcontenttypeprivate.h',
  19     'gcontextspecificgroup.h',
  20     'gcredentialsprivate.h',
  21     'gdbus-daemon-generated.h',
  22     'gdbusactiongroup-private.h',
  23     'gdbusauth.h',
  24     'gdbusauthmechanismanon.h',
  25     'gdbusauthmechanismexternal.h',
  26     'gdbusauthmechanism.h',
  27     'gdbusauthmechanismsha1.h',
  28     'gdbusdaemon.h',
  29     'gdbusprivate.h',
  30     'gdelayedsettingsbackend.h',
  31     'gdummyfile.h',
  32     'gdummyproxyresolver.h',
  33     'gdummytlsbackend.h',
  34     'gfileattribute-priv.h',
  35     'gfileinfo-priv.h',
  36     'ghttpproxy.h',
  37     'giomodule-priv.h',
  38     'gioprivate.h',
  39     'giowin32-priv.h',
  40     'glocaldirectorymonitor.h',
  41     'glocalfileenumerator.h',
  42     'glocalfile.h',
  43     'glocalfileinfo.h',
  44     'glocalfileinputstream.h',
  45     'glocalfileiostream.h',
  46     'glocalfilemonitor.h',
  47     'glocalfileoutputstream.h',
  48     'glocalvfs.h',
  49     'gmountprivate.h',
  50     'gnativevolumemonitor.h',
  51     'gnetworkingprivate.h',
  52     'gnetworkmonitorbase.h',
  53     'gnetworkmonitornetlink.h',
  54     'gnetworkmonitornm.h',
  55     'gnotificationbackend.h',
  56     'gnotification-private.h',
  57     'gpollfilemonitor.h',
  58     'gregistrysettingsbackend.h',
  59     'gresourcefile.h',
  60     'gsettingsbackendinternal.h',
  61     'gsettings-mapping.h',
  62     'gsettingsschema-internal.h',
  63     'gsocketinputstream.h',
  64     'gsocketoutputstream.h',
  65     'gsocks4aproxy.h',
  66     'gsocks4proxy.h',
  67     'gsocks5proxy.h',
  68     'gsubprocesslauncher-private.h',
  69     'gthreadedresolver.h',
  70     'gunionvolumemonitor.h',
  71     'gunixmount.h',
  72     'gunixresolver.h',
  73     'gunixvolume.h',
  74     'gunixvolumemonitor.h',
  75     'gwin32appinfo.h',
  76     'gwin32inputstream.h',
  77     'gwin32mount.h',
  78     'gwin32outputstream.h',
  79     'gwin32registrykey.h',
  80     'gwin32resolver.h',
  81     'gwin32volumemonitor.h',
  82     'thumbnail-verify.h',
  83     'xdp-dbus.h',
  84   ]
  85
  86   ignore_decorators = [
  87     'GLIB_VAR',
  88     'G_GNUC_INTERNAL',
  89     'G_GNUC_WARN_UNUSED_RESULT',
  90     'GLIB_AVAILABLE_IN_ALL',
  91     'GLIB_AVAILABLE_IN_2_26',
  92     'GLIB_AVAILABLE_IN_2_28',
  93     'GLIB_AVAILABLE_IN_2_30',
  94     'GLIB_AVAILABLE_IN_2_32',
  95     'GLIB_AVAILABLE_IN_2_34',
  96     'GLIB_AVAILABLE_IN_2_36',
  97     'GLIB_AVAILABLE_IN_2_38',
  98     'GLIB_AVAILABLE_IN_2_40',
  99     'GLIB_AVAILABLE_IN_2_42',
 100     'GLIB_AVAILABLE_IN_2_44',
 101     'GLIB_AVAILABLE_IN_2_46',
 102     'GLIB_AVAILABLE_IN_2_48',
 103     'GLIB_AVAILABLE_IN_2_50',
 104     'GLIB_AVAILABLE_IN_2_52',
 105     'GLIB_AVAILABLE_IN_2_54',
 106     'GLIB_AVAILABLE_IN_2_56',
 107     'GLIB_DEPRECATED_IN_2_26',
 108     'GLIB_DEPRECATED_IN_2_26_FOR',
 109     'GLIB_DEPRECATED_IN_2_28',
 110     'GLIB_DEPRECATED_IN_2_28_FOR',
 111     'GLIB_DEPRECATED_IN_2_30',
 112     'GLIB_DEPRECATED_IN_2_30_FOR',
 113     'GLIB_DEPRECATED_IN_2_32',
 114     'GLIB_DEPRECATED_IN_2_32_FOR',
 115     'GLIB_DEPRECATED_IN_2_34',
 116     'GLIB_DEPRECATED_IN_2_34_FOR',
 117     'GLIB_DEPRECATED_IN_2_36',
 118     'GLIB_DEPRECATED_IN_2_36_FOR',
 119     'GLIB_DEPRECATED_IN_2_38',
 120     'GLIB_DEPRECATED_IN_2_38_FOR',
 121     'GLIB_DEPRECATED_IN_2_40',
 122     'GLIB_DEPRECATED_IN_2_40_FOR',
 123     'GLIB_DEPRECATED_IN_2_42',
 124     'GLIB_DEPRECATED_IN_2_42_FOR',
 125     'GLIB_DEPRECATED_IN_2_44',
 126     'GLIB_DEPRECATED_IN_2_44_FOR',
 127     'GLIB_DEPRECATED_IN_2_46',
 128     'GLIB_DEPRECATED_IN_2_46_FOR',
 129     'GLIB_DEPRECATED_IN_2_48',
 130     'GLIB_DEPRECATED_IN_2_48_FOR',
 131     'GLIB_DEPRECATED_IN_2_50',
 132     'GLIB_DEPRECATED_IN_2_50_FOR',
 133     'GLIB_DEPRECATED_IN_2_52',
 134     'GLIB_DEPRECATED_IN_2_52_FOR',
 135     'GLIB_DEPRECATED_IN_2_54',
 136     'GLIB_DEPRECATED_IN_2_54_FOR',
 137     'GLIB_DEPRECATED_IN_2_56',
 138     'GLIB_DEPRECATED_IN_2_56_FOR',
 139   ]
 140
 141   # FIXME: More win32 headers were added to fix building gio-scan
 142
 143   # FIXME: ExampleAnimal docs aren't built
 144
 145   docpath = join_paths(glib_datadir, 'gtk-doc', 'html')
 146   version_conf = configuration_data()
 147   version_conf.set('VERSION', meson.project_version())
 148   configure_file(
 149     input: 'version.xml.in',
 150     output: 'version.xml',
 151     configuration: version_conf
 152   )
 153
 154   gnome.gtkdoc('gio',
 155     main_xml : 'gio-docs.xml',
 156     namespace : 'g',
 157     gobject_typesfile : 'gio.types',
 158     mode : 'none',
 159     dependencies : [libgio_dep, libgobject_dep, libglib_dep],
 160     src_dir : 'gio',
 161     scan_args : [
 162       '--rebuild-types',
 163       '--deprecated-guards=G_DISABLE_DEPRECATED',
 164       '--ignore-decorators=' + '|'.join(ignore_decorators),
 165       '--ignore-headers=' + ' '.join(ignore_headers),
 166     ],
 167     content_files : [
 168       'overview.xml',
 169       'migrating-posix.xml',
 170       'migrating-gnome-vfs.xml',
 171       'migrating-gconf.xml',
 172       'migrating-gdbus.xml',
 173       'gio-querymodules.xml',
 174       'glib-compile-schemas.xml',
 175       'glib-compile-resources.xml',
 176       'gapplication.xml',
 177       'gsettings.xml',
 178       'gresource.xml',
 179       'gdbus.xml',
 180       'gdbus-codegen.xml',
 181     ],
 182     expand_content_files : [
 183       'overview.xml',
 184       'migrating-posix.xml',
 185       'migrating-gnome-vfs.xml',
 186       'migrating-gconf.xml',
 187       'migrating-gdbus.xml',
 188       'gdbus-codegen.xml',
 189     ],
 190     html_assets : [
 191       'gvfs-overview.png',
 192       'menu-example.png',
 193       'menu-model.png',
 194     ],
 195     fixxref_args: [
 196       '--html-dir=' + docpath,
 197       '--extra-dir=' + join_paths(meson.current_build_dir(), '../glib/html'),
 198       '--extra-dir=' + join_paths(meson.current_build_dir(), '../gobject/html'),
 199     ],
 200     install: true
 201   )
 202 endif
 203
 204
 205 if get_option('with-man') != 'no' and xsltproc.found()
 206   manpages = ['gapplication', 'gio-querymodules', 'glib-compile-schemas',
 207               'glib-compile-resources', 'gsettings', 'gresource', 'gdbus',
 208               'gio', 'gdbus-codegen']
 209   foreach page : manpages
 210     custom_target(page + '-man',
 211       input: page + '.xml',
 212       output: page + '.1',
 213       command: xsltproc_command,
 214       install: true,
 215       install_dir: man1_dir)
 216   endforeach
 217 endif