diff options
author | Emmanuele Bassi <ebassi@gnome.org> | 2021-07-31 22:47:26 +0100 |
---|---|---|
committer | Emmanuele Bassi <ebassi@gnome.org> | 2021-08-02 13:22:23 +0100 |
commit | f62622fc7b0254859d10b59c5d9a9cb65b59ce2e (patch) | |
tree | 69ac666a547916cec67f3879a66ad1cdd7d6a034 /gobject/gbinding.h | |
parent | 069308ab540a66e48f25a560b8a19bda0feb9c5a (diff) | |
download | glib-f62622fc7b0254859d10b59c5d9a9cb65b59ce2e.tar.gz |
docs: Start stanzas with a single paragraph
When rendering the contents of the GLib documentation stored inside the
introspection data, a common behaviour is to take the first paragraph as
a summary of the symbol being documented.
The documentation is assumed to be in Markdown format, which means:
- paragraphs must be separated by newlines
- lines that have an indentation of four or more spaces are considered
code blocks
- lines that start with a `#` are considered titles
This means we need to slightly tweak the documentation in our sources to
ensure that it can be rendered appropriately by tools that are not
gtk-doc.
See issue: #2365
Diffstat (limited to 'gobject/gbinding.h')
-rw-r--r-- | gobject/gbinding.h | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/gobject/gbinding.h b/gobject/gbinding.h index 84dad7f86..2b2521423 100644 --- a/gobject/gbinding.h +++ b/gobject/gbinding.h @@ -53,8 +53,9 @@ typedef struct _GBinding GBinding; * @to_value: the #GValue in which to store the transformed value * @user_data: data passed to the transform function * - * A function to be called to transform @from_value to @to_value. If - * this is the @transform_to function of a binding, then @from_value + * A function to be called to transform @from_value to @to_value. + * + * If this is the @transform_to function of a binding, then @from_value * is the @source_property on the @source object, and @to_value is the * @target_property on the @target object. If this is the * @transform_from function of a %G_BINDING_BIDIRECTIONAL binding, |