mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-08-27 03:18:59 +02:00
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
This commit is contained in:
@@ -42,6 +42,7 @@ G_BEGIN_DECLS
|
||||
* @cl: a #GClosure
|
||||
*
|
||||
* Get the total number of notifiers connected with the closure @cl.
|
||||
*
|
||||
* The count includes the meta marshaller, the finalize and invalidate notifiers
|
||||
* and the marshal guards. Note that each guard counts as two notifiers.
|
||||
* See g_closure_set_meta_marshal(), g_closure_add_finalize_notifier(),
|
||||
@@ -78,10 +79,13 @@ typedef struct _GClosureNotifyData GClosureNotifyData;
|
||||
* GCallback:
|
||||
*
|
||||
* The type used for callback functions in structure definitions and function
|
||||
* signatures. This doesn't mean that all callback functions must take no
|
||||
* parameters and return void. The required signature of a callback function
|
||||
* is determined by the context in which is used (e.g. the signal to which it
|
||||
* is connected). Use G_CALLBACK() to cast the callback function to a #GCallback.
|
||||
* signatures.
|
||||
*
|
||||
* This doesn't mean that all callback functions must take no parameters and
|
||||
* return void. The required signature of a callback function is determined by
|
||||
* the context in which is used (e.g. the signal to which it is connected).
|
||||
*
|
||||
* Use G_CALLBACK() to cast the callback function to a #GCallback.
|
||||
*/
|
||||
typedef void (*GCallback) (void);
|
||||
/**
|
||||
|
Reference in New Issue
Block a user