Files
glib/docs/reference/gio/gio.toml.in
Philip Withnall 3d84aa264c docs: Stop hiding the Unix-like APIs which are in Gio-2.0.gir
There are four `Unix.+` classes in `Gio-2.0.gir` which need to be
exposed in the `Gio-2.0.gir` docs because they are actually now
cross-platform (which is a move which has caused a lot of pain).

Change the code which filters out the rest of the `Unix.+` classes to
ignore these ones. The rest of the classes continue to be documented via
`GioUnix-2.0.gir`.

Changing the regexs for this involved a fun use of negative lookahead.

See https://gitlab.gnome.org/GNOME/glib/-/issues/3697#note_2459405

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3697
2025-06-03 14:10:52 +01:00

120 lines
2.9 KiB
TOML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 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-types.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.
#
# There are four exceptions, which are Unix APIs which are legitimately in
# the main Gio library as they can now be used on Windows:
# - GUnixConnection
# - GUnixCredentialsMessage
# - GUnixFDList
# - GUnixSocketAddress
[[object]]
pattern = "Unix(?!Connection|CredentialsMessage|FDList|SocketAddress).+"
hidden = true
[[object]]
pattern = "unix_(?!connection|credentials_message|fd_list|socket_address).+"
hidden = true
[[struct]]
pattern = "Unix(?!Connection|CredentialsMessage|FDList|SocketAddress).+"
hidden = true
[[function]]
pattern = "unix_(?!connection|credentials_message|fd_list|socket_address).+"
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