Description:
Documentation tool for GObject-based libraries
|
|
Type: Formula
|
Tracked Since: Dec 28, 2025
|
|
Links:
Homepage |
formulae.brew.sh
|
|
Category: Developer tools
|
|
Tags:
gobject
documentation
introspection
gnome
gtk
generator
|
|
Install:
brew install gi-docgen
|
About:
GiDocgen is a documentation generator specifically designed for GObject-based libraries using the GObject Introspection framework. It extracts API information directly from compiled libraries and GIR XML files to produce accurate, modern documentation. The tool generates static HTML websites complete with search functionality, cross-references, and type annotations, making it ideal for C, Python, JavaScript, and other language bindings.
|
Key Features:
- Generates static HTML documentation from GObject Introspection data
- Built-in search functionality and cross-referencing
- Supports multiple programming language bindings
- Modern, responsive web interface
- Integration with Meson build system
|
Use Cases:
- Generating API documentation for GLib, GTK, and GNOME libraries
- Creating documentation for custom GObject-based libraries
- Building documentation sites for language bindings of C libraries
|
Alternatives:
-
Sphinx
– More general-purpose; requires manual setup for GObject libraries
-
gtk-doc
– Older GNOME documentation tool; GiDocgen is its modern replacement
-
Doxygen
– C++ focused; less integrated with GObject introspection
|
| Detected |
Version |
Rev |
Change |
Commit |
| Mar 30, 2026 8:57am |
|
1 |
REVISION_ONLY |
8de1e440 |
| Sep 10, 2025 10:45pm |
|
0 |
VERSION_BUMP |
f9994d69 |
| Oct 27, 2024 11:42pm |
|
0 |
VERSION_BUMP |
7503fbbf |
| Oct 12, 2024 11:07pm |
|
0 |
VERSION_BUMP |
91e345bc |
| Oct 12, 2024 5:38pm |
|
0 |
VERSION_BUMP |
c37c1996 |
| Sep 10, 2024 11:28am |
|
0 |
VERSION_BUMP |
6e39e15e |
| May 20, 2024 9:05pm |
|
0 |
VERSION_BUMP |
e12d4a53 |
| Nov 26, 2023 10:41am |
|
0 |
VERSION_BUMP |
2320f910 |
| Nov 24, 2023 9:14pm |
|
0 |
VERSION_BUMP |
1cfb4061 |
| Nov 13, 2023 2:37pm |
|
0 |
VERSION_BUMP |
83193ca2 |
| Jan 7, 2023 7:44pm |
|
0 |
VERSION_BUMP |
9a61cb3f |
| Jan 7, 2023 7:44pm |
|
0 |
VERSION_BUMP |
02479f5d |
| Nov 30, 2022 3:22pm |
|
0 |
VERSION_BUMP |
5052ffb2 |
|