luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-12 10:43:08 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Avoid unintended titles in g_object_new()

Browse Source 
Lines should not start with `#` unless they are titles, as docblocks are
parsed as Markdown.

Fixes: #2821
This commit is contained in:
Emmanuele Bassi 2022-11-28 11:49:51 +00:00
parent 74afeca98b
commit f1b7a52fe2
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
gobject/gobject.c
View File

@ -2002,22 +2002,22 @@ g_object_get_type (void)
* per g_type_create_instance(). * per g_type_create_instance().
* *
* Note that in C, small integer types in variable argument lists are promoted * Note that in C, small integer types in variable argument lists are promoted
* up to #gint or #guint as appropriate, and read back accordingly. #gint is 32 * up to `gint` or `guint` as appropriate, and read back accordingly. `gint` is
* bits on every platform on which GLib is currently supported. This means that * 32 bits on every platform on which GLib is currently supported. This means that
* you can use C expressions of type #gint with g_object_new() and properties of * you can use C expressions of type `gint` with g_object_new() and properties of
* type #gint or #guint or smaller. Specifically, you can use integer literals * type `gint` or `guint` or smaller. Specifically, you can use integer literals
* with these property types. * with these property types.
* *
* When using property types of #gint64 or #guint64, you must ensure that the * When using property types of `gint64` or `guint64`, you must ensure that the
* value that you provide is 64 bit. This means that you should use a cast or * value that you provide is 64 bit. This means that you should use a cast or
* make use of the %G_GINT64_CONSTANT or %G_GUINT64_CONSTANT macros. * make use of the %G_GINT64_CONSTANT or %G_GUINT64_CONSTANT macros.
* *
* Similarly, #gfloat is promoted to #gdouble, so you must ensure that the value * Similarly, `gfloat` is promoted to `gdouble`, so you must ensure that the value
* you provide is a #gdouble, even for a property of type #gfloat. * you provide is a `gdouble`, even for a property of type `gfloat`.
* *
* Since GLib 2.72, all #GObjects are guaranteed to be aligned to at least the * Since GLib 2.72, all #GObjects are guaranteed to be aligned to at least the
* alignment of the largest basic GLib type (typically this is #guint64 or * alignment of the largest basic GLib type (typically this is `guint64` or
* #gdouble). If you need larger alignment for an element in a #GObject, you * `gdouble`). If you need larger alignment for an element in a #GObject, you
* should allocate it on the heap (aligned), or arrange for your #GObject to be * should allocate it on the heap (aligned), or arrange for your #GObject to be
* appropriately padded. * appropriately padded.
* *