mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-02-11 13:19:22 +01:00
2ebd1c8f15
These symbols are documented in the {glib,gio}-{unix,win32}
documentation builds, and shouldn’t be duplicated in the main
documentation. It’s a historical (and unavoidable) accident that those
symbols are in the main GIR files.
If we don’t hide the symbols from the main docs build, we now run into
the problem of the `GioUnix` namespace not being known to gi-docgen
while building the `Gio` docs. This is because of the previous two
commits, which ported more of the `gunixmounts` documentation to
gi-docgen syntax. I don’t know of another way to fix this, other than to
hide the `GioUnix` symbols from the `Gio` docs build.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3250
110 lines
2.4 KiB
TOML
110 lines
2.4 KiB
TOML
# SPDX-License-Identifier: LGPL-2.1-or-later
|
|
# Copyright 2023 Matthias Clasen
|
|
# Copyright 2023 Philip Withnall
|
|
|
|
[library]
|
|
name = "Gio"
|
|
version = "@VERSION@"
|
|
browse_url = "https://gitlab.gnome.org/GNOME/glib/"
|
|
repository_url = "https://gitlab.gnome.org/GNOME/glib.git"
|
|
website_url = "https://www.gtk.org"
|
|
docs_urls = "https://docs.gtk.org/gio/"
|
|
authors = "GLib Development Team"
|
|
license = "LGPL-2.1-or-later"
|
|
description = "Gio is a library providing useful classes for general purpose I/O, networking, IPC, settings, and other high level application functionality"
|
|
dependencies = [ "GLib-2.0", "GModule-2.0", "GObject-2.0" ]
|
|
devhelp = true
|
|
search_index = true
|
|
|
|
[dependencies."GLib-2.0"]
|
|
name = "GLib"
|
|
description = "The base utility library"
|
|
docs_url = "https://docs.gtk.org/glib/"
|
|
|
|
[dependencies."GModule-2.0"]
|
|
name = "GModule"
|
|
description = "Portable API for dynamically loading modules"
|
|
docs_url = "https://docs.gtk.org/gmodule/"
|
|
|
|
[dependencies."GObject-2.0"]
|
|
name = "GObject"
|
|
description = "The base type system library"
|
|
docs_url = "https://docs.gtk.org/gobject/"
|
|
|
|
[theme]
|
|
name = "basic"
|
|
show_index_summary = true
|
|
show_class_hierarchy = true
|
|
|
|
[source-location]
|
|
base_url = "https://gitlab.gnome.org/GNOME/glib/-/blob/main/"
|
|
|
|
[extra]
|
|
urlmap_file = "../urlmap.js"
|
|
# The same order will be used when generating the index
|
|
content_files = [
|
|
"overview.md",
|
|
"file-attributes.md",
|
|
"tls-overview.md",
|
|
|
|
"error.md",
|
|
|
|
"pollable-utils.md",
|
|
|
|
"dbus-error.md",
|
|
"dbus-introspection.md",
|
|
"dbus-name-owning.md",
|
|
"dbus-name-watching.md",
|
|
"dbus-utils.md",
|
|
"menu-exporter.md",
|
|
|
|
"networking.md",
|
|
|
|
"migrating-gdbus.md",
|
|
"migrating-gconf.md",
|
|
"migrating-gnome-vfs.md",
|
|
"migrating-posix.md",
|
|
|
|
"io-scheduler.md",
|
|
]
|
|
content_images = [
|
|
"gvfs-overview.png",
|
|
"menu-example.png",
|
|
"menu-model-dark.svg",
|
|
"menu-model-light.svg",
|
|
]
|
|
|
|
# We have to hide the GioUnix and GioWin32 symbols from the documentation — they
|
|
# have to be present in the GIR files (until we next break API), but their
|
|
# documentation is split out to gio-{unix,win32}.toml.
|
|
[[object]]
|
|
pattern = "Unix[A-Z].+"
|
|
hidden = true
|
|
|
|
[[object]]
|
|
pattern = "unix_.+"
|
|
hidden = true
|
|
|
|
[[struct]]
|
|
pattern = "Unix[A-Z].+"
|
|
hidden = true
|
|
|
|
[[function]]
|
|
pattern = "unix_.+"
|
|
hidden = true
|
|
|
|
[[object]]
|
|
pattern = "Win32[A-Z].+"
|
|
hidden = true
|
|
|
|
[[object]]
|
|
pattern = "win32_.+"
|
|
hidden = true
|
|
|
|
[[struct]]
|
|
pattern = "Win32[A-Z].+"
|
|
hidden = true
|
|
|
|
[[function]]
|
|
pattern = "win32_.+"
|
|
hidden = true |