docs/reference/gio/meson.build

   1 if get_option('gtk_doc')
   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     'gnetworkmonitorportal.h',
  56     'gnotificationbackend.h',
  57     'gnotification-private.h',
  58     'gpollfilemonitor.h',
  59     'gproxyresolverportal.h',
  60     'gregistrysettingsbackend.h',
  61     'gresourcefile.h',
  62     'gsettingsbackendinternal.h',
  63     'gsettings-mapping.h',
  64     'gsettingsschema-internal.h',
  65     'gsocketinputstream.h',
  66     'gsocketoutputstream.h',
  67     'gsocks4aproxy.h',
  68     'gsocks4proxy.h',
  69     'gsocks5proxy.h',
  70     'gsubprocesslauncher-private.h',
  71     'gthreadedresolver.h',
  72     'gunionvolumemonitor.h',
  73     'gunixmount.h',
  74     'gunixresolver.h',
  75     'gunixvolume.h',
  76     'gunixvolumemonitor.h',
  77     'gwin32appinfo.h',
  78     'gwin32mount.h',
  79     'gwin32registrykey.h',
  80     'gwin32resolver.h',
  81     'gwin32volumemonitor.h',
  82     'thumbnail-verify.h',
  83     'xdp-dbus.h',
  84   ]
  85
  86   if host_system == 'windows'
  87     ignore_headers += [
  88       'gfiledescriptorbased.h',
  89       'gunixconnection.h',
  90       'gunixcredentialsmessage.h',
  91       'gunixmounts.h',
  92       'gunixfdlist.h',
  93       'gunixfdmessage.h',
  94       'gunixinputstream.h',
  95       'gunixoutputstream.h',
  96       'gunixsocketaddress.h',
  97       'gdesktopappinfo.h',
  98       'gosxappinfo.h',
  99     ]
 100   else
 101     if glib_have_cocoa
 102       ignore_headers += ['gdesktopappinfo.h']
 103     else
 104       ignore_headers += ['gosxappinfo.h']
 105     endif
 106
 107     ignore_headers += [
 108       'gwin32networkmonitor.h',
 109       'gwin32inputstream.h',
 110       'gwin32outputstream.h',
 111     ]
 112   endif
 113
 114   ignore_decorators = [
 115     'GLIB_VAR',
 116     'G_GNUC_INTERNAL',
 117     'G_GNUC_WARN_UNUSED_RESULT',
 118     'GLIB_AVAILABLE_IN_ALL',
 119     'GLIB_AVAILABLE_IN_2_26',
 120     'GLIB_AVAILABLE_IN_2_28',
 121     'GLIB_AVAILABLE_IN_2_30',
 122     'GLIB_AVAILABLE_IN_2_32',
 123     'GLIB_AVAILABLE_IN_2_34',
 124     'GLIB_AVAILABLE_IN_2_36',
 125     'GLIB_AVAILABLE_IN_2_38',
 126     'GLIB_AVAILABLE_IN_2_40',
 127     'GLIB_AVAILABLE_IN_2_42',
 128     'GLIB_AVAILABLE_IN_2_44',
 129     'GLIB_AVAILABLE_IN_2_46',
 130     'GLIB_AVAILABLE_IN_2_48',
 131     'GLIB_AVAILABLE_IN_2_50',
 132     'GLIB_AVAILABLE_IN_2_52',
 133     'GLIB_AVAILABLE_IN_2_54',
 134     'GLIB_AVAILABLE_IN_2_56',
 135     'GLIB_DEPRECATED_IN_2_26',
 136     'GLIB_DEPRECATED_IN_2_26_FOR',
 137     'GLIB_DEPRECATED_IN_2_28',
 138     'GLIB_DEPRECATED_IN_2_28_FOR',
 139     'GLIB_DEPRECATED_IN_2_30',
 140     'GLIB_DEPRECATED_IN_2_30_FOR',
 141     'GLIB_DEPRECATED_IN_2_32',
 142     'GLIB_DEPRECATED_IN_2_32_FOR',
 143     'GLIB_DEPRECATED_IN_2_34',
 144     'GLIB_DEPRECATED_IN_2_34_FOR',
 145     'GLIB_DEPRECATED_IN_2_36',
 146     'GLIB_DEPRECATED_IN_2_36_FOR',
 147     'GLIB_DEPRECATED_IN_2_38',
 148     'GLIB_DEPRECATED_IN_2_38_FOR',
 149     'GLIB_DEPRECATED_IN_2_40',
 150     'GLIB_DEPRECATED_IN_2_40_FOR',
 151     'GLIB_DEPRECATED_IN_2_42',
 152     'GLIB_DEPRECATED_IN_2_42_FOR',
 153     'GLIB_DEPRECATED_IN_2_44',
 154     'GLIB_DEPRECATED_IN_2_44_FOR',
 155     'GLIB_DEPRECATED_IN_2_46',
 156     'GLIB_DEPRECATED_IN_2_46_FOR',
 157     'GLIB_DEPRECATED_IN_2_48',
 158     'GLIB_DEPRECATED_IN_2_48_FOR',
 159     'GLIB_DEPRECATED_IN_2_50',
 160     'GLIB_DEPRECATED_IN_2_50_FOR',
 161     'GLIB_DEPRECATED_IN_2_52',
 162     'GLIB_DEPRECATED_IN_2_52_FOR',
 163     'GLIB_DEPRECATED_IN_2_54',
 164     'GLIB_DEPRECATED_IN_2_54_FOR',
 165     'GLIB_DEPRECATED_IN_2_56',
 166     'GLIB_DEPRECATED_IN_2_56_FOR',
 167   ]
 168
 169   # FIXME: More win32 headers were added to fix building gio-scan
 170
 171   # FIXME: ExampleAnimal docs aren't built
 172
 173   docpath = join_paths(glib_datadir, 'gtk-doc', 'html')
 174   version_conf = configuration_data()
 175   version_conf.set('VERSION', meson.project_version())
 176   configure_file(
 177     input: 'version.xml.in',
 178     output: 'version.xml',
 179     configuration: version_conf
 180   )
 181
 182   gnome.gtkdoc('gio',
 183     main_xml : 'gio-docs.xml',
 184     namespace : 'g',
 185     mode : 'none',
 186     dependencies : [libgio_dep, libgobject_dep, libglib_dep],
 187     src_dir : 'gio',
 188     scan_args : [
 189       '--rebuild-types',
 190       '--deprecated-guards=G_DISABLE_DEPRECATED',
 191       '--ignore-decorators=' + '|'.join(ignore_decorators),
 192       '--ignore-headers=' + ' '.join(ignore_headers),
 193     ],
 194     content_files : [
 195       'overview.xml',
 196       'migrating-posix.xml',
 197       'migrating-gnome-vfs.xml',
 198       'migrating-gconf.xml',
 199       'migrating-gdbus.xml',
 200       'gio-querymodules.xml',
 201       'glib-compile-schemas.xml',
 202       'glib-compile-resources.xml',
 203       'gapplication.xml',
 204       'gsettings.xml',
 205       'gresource.xml',
 206       'gdbus.xml',
 207       'gdbus-codegen.xml',
 208     ],
 209     expand_content_files : [
 210       'overview.xml',
 211       'migrating-posix.xml',
 212       'migrating-gnome-vfs.xml',
 213       'migrating-gconf.xml',
 214       'migrating-gdbus.xml',
 215       'gdbus-codegen.xml',
 216     ],
 217     html_assets : [
 218       'gvfs-overview.png',
 219       'menu-example.png',
 220       'menu-model.png',
 221     ],
 222     fixxref_args: [
 223       '--html-dir=' + docpath,
 224       '--extra-dir=' + join_paths(meson.current_build_dir(), '../glib/html'),
 225       '--extra-dir=' + join_paths(meson.current_build_dir(), '../gobject/html'),
 226     ],
 227     install: true
 228   )
 229 endif
 230
 231
 232 if get_option('man')
 233   manpages = ['gapplication', 'gio-querymodules', 'glib-compile-schemas',
 234               'glib-compile-resources', 'gsettings', 'gresource', 'gdbus',
 235               'gio', 'gdbus-codegen']
 236   foreach page : manpages
 237     custom_target(page + '-man',
 238       input: page + '.xml',
 239       output: page + '.1',
 240       command: xsltproc_command,
 241       install: true,
 242       install_dir: man1_dir)
 243   endforeach
 244 endif