luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-12 15:36:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

gstrfuncs: Improve and port doc comments to gi-docgen

Browse Source 
This fixes many things from the port to gi-docgen, but also improves
documentation more generally.

Main improvements/fixes:
- Fix links to functions, constants, etc.
- Rewrite code syntax to work with Markdown
- Reduce indentation (do not indent by 4 to prevent code blocks)
- Remove redundant text such as "can be NULL" or "should be freed"
- Move text from large return info texts to main function text
- Remove periods at the end of parameter and return descriptions
- Do not capitalize the first word of a parameter or return description
- Try to improve consistency between docs for similar functions
- Convert %TRUE and %FALSE into true and false
- Convert other uses of `%` and `#` into inline code

Helps: #3037
This commit is contained in:
velsinki 2024-01-07 01:17:26 +01:00 committed by Philip Withnall
parent a834b8b038
commit 66cd331172
2 changed files with 429 additions and 426 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

851
glib/gstrfuncs.c
View File

File diff suppressed because it is too large Load Diff

4
glib/gstrfuncs.h
View File

@ -412,8 +412,8 @@ gboolean g_strv_equal (const gchar * const *strv1,
/**
* GNumberParserError:
* @G_NUMBER_PARSER_ERROR_INVALID: String was not a valid number.
* @G_NUMBER_PARSER_ERROR_OUT_OF_BOUNDS: String was a number, but out of bounds.
* @G_NUMBER_PARSER_ERROR_INVALID: string was not a valid number
* @G_NUMBER_PARSER_ERROR_OUT_OF_BOUNDS: string was a number, but out of bounds
*
* Error codes returned by functions converting a string to a number.
*