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

girparser: Port documentation to gi-docgen and update

Browse Source 
Review and update the documentation, making sure it’s complete,
formatted in gi-docgen format, and has all appropriate GIR annotations
and `Since:` lines.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>

Helps: #3155
This commit is contained in:
Philip Withnall 2023-12-13 13:25:02 +00:00
parent a58c731912
commit e1de1fb316
1 changed files with 17 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
girepository/girparser.c
View File

@ -3674,15 +3674,17 @@ cleanup (GMarkupParseContext *context,
* gi_ir_parser_parse_string: * gi_ir_parser_parse_string:
* @parser: a #GIIrParser * @parser: a #GIIrParser
* @namespace: the namespace of the string * @namespace: the namespace of the string
* @filename: (allow-none): Path to parsed file, or %NULL * @filename: (nullable) (type filename): Path to parsed file, or `NULL`
* @buffer: the data containing the XML * @buffer: (array length=length): the data containing the XML
* @length: length of the data * @length: length of the data, in bytes
* @error: return location for a #GError, or %NULL * @error: return location for a [type@GLib.Error], or `NULL`
* *
* Parse a string that holds a complete GIR XML file, and return a list of a * Parse a string that holds a complete GIR XML file, and return a list of a
* a #GirModule for each &lt;namespace/&gt; element within the file. * a [class@GIRepository.IrModule] for each `<namespace/>` element within the
* file.
* *
* Returns: (transfer none): a new #GirModule * Returns: (transfer none): a new [class@GIRepository.IrModule]
* Since: 2.80
*/ */
GIIrModule * GIIrModule *
gi_ir_parser_parse_string (GIIrParser *parser, gi_ir_parser_parse_string (GIIrParser *parser,
@ -3757,14 +3759,17 @@ gi_ir_parser_parse_string (GIIrParser *parser,
/** /**
* gi_ir_parser_parse_file: * gi_ir_parser_parse_file:
* @parser: a #GIIrParser * @parser: a #GIIrParser
* @filename: filename to parse * @filename: (type filename): filename to parse
* @error: return location for a #GError, or %NULL * @error: return location for a [type@GLib.Error], or `NULL`
* *
* Parse GIR XML file, and return a list of a a #GirModule for each * Parse the given GIR XML file, and return a list of a
* &lt;namespace/&gt; element within the file. * [class@GIRepository.IrModule] for each `<namespace/>` element within the
* file.
* *
* Returns: (transfer container): a newly allocated list of #GIIrModule. The modules themselves * Returns: (transfer container): a newly allocated list of
* are owned by the #GIIrParser and will be freed along with the parser. * [class@GIRepository.IrModule]s. The modules themselves
* are owned by the `GIIrParser` and will be freed along with the parser.
* Since: 2.80
*/ */
GIIrModule * GIIrModule *
gi_ir_parser_parse_file (GIIrParser *parser, gi_ir_parser_parse_file (GIIrParser *parser,