[glib: 2/4] gerror: Add a heading for the docs section on extended GErrors




commit 11097160c0b8199ca8e6c09fb31c146285179cb0
Author: Philip Withnall <pwithnall endlessos org>
Date:   Wed Jan 13 13:29:02 2021 +0000

    gerror: Add a heading for the docs section on extended GErrors
    
    This makes it a little easier to link to in the generated documentation,
    and separates it from the section above.
    
    Link to the heading from the documentation for
    `G_DEFINE_EXTENDED_ERROR`.
    
    Signed-off-by: Philip Withnall <pwithnall endlessos org>

 glib/gerror.c | 2 ++
 glib/gerror.h | 2 ++
 2 files changed, 4 insertions(+)
---
diff --git a/glib/gerror.c b/glib/gerror.c
index 4e0ee4c41..82bf626ed 100644
--- a/glib/gerror.c
+++ b/glib/gerror.c
@@ -375,6 +375,8 @@
  *   location is either %NULL or contains a %NULL error (e.g.
  *   `g_return_if_fail (error == NULL || *error == NULL);`).
  *
+ * ## Extended #GError Domains # {#gerror-extended-domains}
+ *
  * Since GLib 2.68 it is possible to extend the #GError type. This is
  * done with the G_DEFINE_EXTENDED_ERROR() macro. To create an
  * extended #GError type do something like this in the header file:
diff --git a/glib/gerror.h b/glib/gerror.h
index 8773a1023..2a31e909e 100644
--- a/glib/gerror.h
+++ b/glib/gerror.h
@@ -65,6 +65,8 @@ struct _GError
  * respectively, but they should receive the private data type instead
  * of #GError.
  *
+ * See [Extended #GError Domains][gerror-extended-domains] for an example.
+ *
  * Since: 2.68
  */
 #define G_DEFINE_EXTENDED_ERROR(ErrorType, error_type)                  \


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]