[glib: 2/3] gdbus-codegen: Drop DocBook warning tags from generated code



commit a6c1ee22c12e2548260ba655b436bc6331125ecb
Author: Philip Withnall <withnall endlessm com>
Date:   Mon Dec 2 16:48:32 2019 +0000

    gdbus-codegen: Drop DocBook warning tags from generated code
    
    gtk-doc switched from DocBook to Markdown ages ago. There is no Markdown
    equivalent for `<warning>`, so just drop it. It wasn’t adding anything
    particularly valuable to the documentation.
    
    Signed-off-by: Philip Withnall <withnall endlessm com>
    
    Fixes: #1130

 gio/gdbus-2.0/codegen/codegen.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
---
diff --git a/gio/gdbus-2.0/codegen/codegen.py b/gio/gdbus-2.0/codegen/codegen.py
index b60cf18dd..3ed12d7ea 100644
--- a/gio/gdbus-2.0/codegen/codegen.py
+++ b/gio/gdbus-2.0/codegen/codegen.py
@@ -1558,7 +1558,7 @@ class CodeGenerator:
                     ' *\n'
                     %(i.name_lower, p.name_lower, i.camel_name, i.name, p.name, hint), False))
             if p.arg.free_func != None:
-                self.outfile.write(' * <warning>The returned value is only valid until the property changes 
so on the client-side it is only safe to use this function on the thread where @object was constructed. Use 
%s_dup_%s() if on another thread.</warning>\n'
+                self.outfile.write(' * The returned value is only valid until the property changes so on the 
client-side it is only safe to use this function on the thread where @object was constructed. Use %s_dup_%s() 
if on another thread.\n'
                                    ' *\n'
                                    ' * Returns: (transfer none) (nullable): The property value or %%NULL if 
the property is not set. Do not free the returned value, it belongs to @object.\n'
                                    %(i.name_lower, p.name_lower))
@@ -3100,7 +3100,7 @@ class CodeGenerator:
                     ' *\n'
                     ' * Like %sobject_get_%s() but doesn\'t increase the reference count on the returned 
object.\n'
                     ' *\n'
-                    ' * <warning>It is not safe to use the returned object if you are on another thread than 
the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning>\n'
+                    ' * It is not safe to use the returned object if you are on another thread than the one 
where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.\n'
                     ' *\n'
                     ' * Returns: (transfer none) (nullable): A #%s or %%NULL if @object does not implement 
the interface. Do not free the returned object, it is owned by @object.\n'
                     %(self.ns_lower, i.name_upper.lower(), self.namespace, self.ns_lower, 
i.name_upper.lower(), i.camel_name), False))


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]