mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-08-23 01:18:53 +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:
@@ -145,7 +145,9 @@ G_BEGIN_DECLS
|
||||
* Since 2.26
|
||||
*
|
||||
* Through the #GParamFlags flag values, certain aspects of parameters
|
||||
* can be configured. See also #G_PARAM_STATIC_STRINGS.
|
||||
* can be configured.
|
||||
*
|
||||
* See also: %G_PARAM_STATIC_STRINGS
|
||||
*/
|
||||
typedef enum
|
||||
{
|
||||
@@ -368,6 +370,7 @@ typedef struct _GParamSpecTypeInfo GParamSpecTypeInfo;
|
||||
* This structure is used to provide the type system with the information
|
||||
* required to initialize and destruct (finalize) a parameter's class and
|
||||
* instances thereof.
|
||||
*
|
||||
* The initialized structure is passed to the g_param_type_register_static()
|
||||
* The type system will perform a deep copy of this structure, so its memory
|
||||
* does not need to be persistent across invocation of
|
||||
|
Reference in New Issue
Block a user