[gi-docgen/docs-fixes: 1/3] docs: Replace the giant table ASCII art
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gi-docgen/docs-fixes: 1/3] docs: Replace the giant table ASCII art
- Date: Thu, 1 Apr 2021 10:28:39 +0000 (UTC)
commit 745061fbce0a7531cd2d3d583b9fd4b8fa9137a2
Author: Emmanuele Bassi <ebassi gnome org>
Date: Thu Apr 1 11:06:01 2021 +0100
docs: Replace the giant table ASCII art
Use the list-table directive to make the link fragments table easier to
change.
docs/linking.rst | 82 +++++++++++++++++++++++++++++++++-----------------------
1 file changed, 49 insertions(+), 33 deletions(-)
---
diff --git a/docs/linking.rst b/docs/linking.rst
index e0256ce..45566cf 100644
--- a/docs/linking.rst
+++ b/docs/linking.rst
@@ -45,39 +45,55 @@ namespace:
The available qualifier fragments are:
-+------------+-----------------------------+---------------------------------------------+
-| Fragment | Description | Example |
-+============+=============================+=============================================+
-| `alias` | An alias to another type | ``[alias@Allocation]`` |
-+------------+-----------------------------+---------------------------------------------+
-| `class` | A ``GObject`` class | ``[class@Widget]``, ``[class@Gdk.Surface]`` |
-+------------+-----------------------------+---------------------------------------------+
-| `const` | A constant symbol | ``[const@Gdk.KEY_q]`` |
-+------------+-----------------------------+---------------------------------------------+
-| `ctor` | A constructor function | ``[ctor Gtk Box new]`` |
-+------------+-----------------------------+---------------------------------------------+
-| `enum` | An enumeration | ``[enum@Orientation]`` |
-+------------+-----------------------------+---------------------------------------------+
-| `error` | A ``GError`` domain | ``[error@Gtk.BuilderParseError]`` |
-+------------+-----------------------------+---------------------------------------------+
-| `flags` | A bitfield | ``[flags@Gdk.ModifierType]`` |
-+------------+-----------------------------+---------------------------------------------+
-| `func` | A global or type function | ``[func Gtk init]``, ``[func@show_uri]``, |
-| | | ``[func@Gtk.Window.list_toplevels]`` |
-+------------+-----------------------------+---------------------------------------------+
-| `iface` | A ``GTypeInterface`` | ``[iface@Gtk.Buildable]`` |
-+------------+-----------------------------+---------------------------------------------+
-| `method` | An instance or class method | ``[method Gtk Widget show]``, |
-| | | ``[method@WidgetClass.add_binding]`` |
-+------------+-----------------------------+---------------------------------------------+
-| `property` | A ``GObject`` property | ``[property@Gtk.Orientable:orientation]`` |
-+------------+-----------------------------+---------------------------------------------+
-| `signal` | A ``GObject`` signal | ``[signal@Gtk.RecentManager::changed]`` |
-+------------+-----------------------------+---------------------------------------------+
-| `struct` | A C structure or union | ``[struct@Gtk.TextIter]`` |
-+------------+-----------------------------+---------------------------------------------+
-| `vfunc` | A virtual function | ``[vfunc@Gtk.Widget.measure]`` |
-+------------+-----------------------------+---------------------------------------------+
+.. list-table::
+ :widths: 15 35 50
+ :header-rows: 1
+
+ * - Fragment
+ - Description
+ - Example
+ * - ``alias``
+ - An alias to another type
+ - ``[alias@Allocation]``
+ * - ``class``
+ - An object class
+ - ``[class@Widget]``, ``[class@Gdk.Surface]``, ``[class@Gsk.RenderNode]``
+ * - ``const``
+ - A constant or pre-processor symbol
+ - ``[const@Gdk.KEY_q]``
+ * - ``ctor``
+ - A constructor function
+ - ``[ctor Gtk Box new]``, ``[ctor@Button.new_with_label]``
+ * - ``enum``
+ - A plain enumeration
+ - ``[enum@Orientation]``
+ * - ``error``
+ - A ``GError`` domain enumeration
+ - ``[error@Gtk.BuilderParseError]``
+ * - ``flags``
+ - A bitfield
+ - ``[flags@Gdk.ModifierType]``
+ * - ``func``
+ - A global or a type function
+ - ``[func Gtk init]``, ``[func@show_uri]``, ``[func@Gtk.Window.list_toplevels]``
+ * - ``iface``
+ - A ``GTypeInterface``
+ - ``[iface@Gtk.Buildable]``
+ * - ``method``
+ - An instance or class method
+ - ``[method Gtk Widget show]``, ``[method@WidgetClass.add_binding]``
+ * - ``property``
+ - A ``GObject`` property
+ - ``[property@Gtk.Orientable:orientation]``
+ * - ``signal``
+ - A ``GObject`` signal
+ - ``[signal@Gtk.RecentManager::changed]``
+ * - ``struct``
+ - A plain C structure or union
+ - ``[struct@Gtk.TextIter]``
+ * - ``vfunc``
+ - A virtual function in a class or interface
+ - ``[vfunc@Gtk.Widget.measure]``
Additionally, the ``id`` fragment, followed by a C symbol identifier, will try to link to the function; for
instance:
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]