# SPDX-License-Identifier: LGPL-2.1-or-later
# Copyright 2023 Matthias Clasen
# Copyright 2023 Philip Withnall

[library]
name = "GLib"
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_url = "https://docs.gtk.org/glib/"
authors = "GLib Development Team"
license = "LGPL-2.1-or-later"
description = "GLib is a general-purpose, portable utility library, which provides many useful data types, macros, type conversions, string utilities, file utilities, a mainloop abstraction, and so on."
related = [ "GModule-2.0", "GObject-2.0", "Gio-2.0" ]
devhelp = true
search_index = true

  [related."GModule-2.0"]
  name = "GModule"
  description = "Portable API for dynamically loading modules"
  docs_url = "https://docs.gtk.org/gmodule/"

  [related."GObject-2.0"]
  name = "GObject"
  description = "The base type system library"
  docs_url = "https://docs.gtk.org/gobject/"

  [related."Gio-2.0"]
  name = "GIO"
  description = "GObject Interfaces and Objects, Networking, IPC, and I/O"
  docs_url = "https://docs.gtk.org/gio/"

[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 = [
  "building.md",
  "compiling.md",
  "cross-compiling.md",
  "running.md",
  "programming.md",
  "resources.md",

  "gvariant-format-strings.md",
  "gvariant-text-format.md",

  "character-set.md",
  "i18n.md",

  "string-utils.md",

  "types.md",
  "macros.md",
  "conversion-macros.md",
  "auto-cleanup.md",

  "memory.md",
  "memory-slices.md",
  "error-reporting.md",
  "logging.md",
  "warnings.md",
  "file-utils.md",
  "host-utils.md",
  "misc-utils.md",
  "main-loop.md",
  "reference-counting.md",
  "testing.md",
  "atomic.md",
  "checked-math.md",
  "threads.md",
  "spawn.md",
  "random.md",
  "numerical.md",
  "markup.md",
  "base64.md",
  "goption.md",
  "data-structures.md",
  "datalist-and-dataset.md",
  "shell.md",
  "uuid.md",
  "unicode.md",
  "version.md",

  "threads-deprecated.md",
]
content_images = [
  "file-name-encodings.png",
  "mainloop-states.gif",
  "Sorted_binary_tree_breadth-first_traversal.svg",
  "Sorted_binary_tree_inorder.svg",
  "Sorted_binary_tree_postorder.svg",
  "Sorted_binary_tree_preorder.svg",
  "Sorted_binary_tree_breadth-first_traversal-dark.svg",
  "Sorted_binary_tree_inorder-dark.svg",
  "Sorted_binary_tree_postorder-dark.svg",
  "Sorted_binary_tree_preorder-dark.svg",
]

[[object]]
pattern = "DEPRECATED_IN_2_*"
hidden = true

[[object]]
pattern = "DEPRECATED_MACRO_IN_2_*"
hidden = true

[[object]]
pattern = "DEPRECATED_ENUMERATOR_IN_2_*"
hidden = true

[[object]]
pattern = "DEPRECATED_TYPE_IN_2_*"
hidden = true

[[object]]
name = "test_assert_expected_messages_internal"
hidden = true

[[object]]
pattern = "macro__has_*"
hidden = true

# 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 glib-{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