gdbusmessage: Reformat a doc comment to gi-docgen format

In an attempt to make gobject-introspection stop warning about using
deprecated gtk-doc `Type:` tags.

It doesn’t work — the gobject-introspection parser is not clever enough
to notice the tag is inside a code block.

Still, a useful port.

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

Helps: #3037
This commit is contained in:
Philip Withnall 2023-11-29 11:54:13 +00:00
parent e8edaeeb87
commit 7d0140eea0

View File

@ -3620,7 +3620,7 @@ _sort_keys_func (gconstpointer a,
* The contents of the description has no ABI guarantees, the contents
* and formatting is subject to change at any time. Typical output
* looks something like this:
* |[
* ```
* Type: method-call
* Flags: none
* Version: 0
@ -3633,9 +3633,9 @@ _sort_keys_func (gconstpointer a,
* Body: ()
* UNIX File Descriptors:
* (none)
* ]|
* ```
* or
* |[
* ```
* Type: method-return
* Flags: no-reply-expected
* Version: 0
@ -3648,9 +3648,9 @@ _sort_keys_func (gconstpointer a,
* Body: ()
* UNIX File Descriptors:
* fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635
* ]|
* ```
*
* Returns: (not nullable): A string that should be freed with g_free().
* Returns: (not nullable): A string that should be freed with [func@GLib.free].
*
* Since: 2.26
*/