[gimp] libgimp: have both annotations for GObject Introspection and gtk-docs.



commit 5621de52fc3bb555ac5550fef2d08b17f24b3c0b
Author: Jehan <jehan girinstud io>
Date:   Tue Sep 10 18:13:26 2019 +0200

    libgimp: have both annotations for GObject Introspection and gtk-docs.
    
    GTK-docs needs the struct member documentations in the main struct
    comment. So let's get this back, while keeping the proper GI
    introspection for each method this time.
    As discussed with Mitch.

 libgimp/gimpplugin.h | 32 +++++++++++++++++++++++++++++---
 1 file changed, 29 insertions(+), 3 deletions(-)
---
diff --git a/libgimp/gimpplugin.h b/libgimp/gimpplugin.h
index b2e38b2cb7..f20accad99 100644
--- a/libgimp/gimpplugin.h
+++ b/libgimp/gimpplugin.h
@@ -51,11 +51,37 @@ struct _GimpPlugIn
 
 /**
  * GimpPlugInClass:
+ * @query_procedures: This method can be overridden by all plug-ins to
+ *   return a newly allocated #GList of allocated strings naming the
+ *   procedures registered by this plug-in. See documentation of
+ *   #GimpPlugInClass.init_procedures() for differences.
+ * @init_procedures: This method can be overridden by all plug-ins to
+ *   return a newly allocated #GList of allocated strings naming
+ *   procedures registered by this plug-in.
+ *   It is different from #GimpPlugInClass.query_procedures() in that
+ *   init happens at every startup, whereas query happens only once in
+ *   the life of a plug-in (right after installation or update). Hence
+ *   #GimpPlugInClass.init_procedures() typically returns procedures
+ *   dependent to runtime conditions (such as the presence of a
+ *   third-party tool), whereas #GimpPlugInClass.query_procedures()
+ *   would usually return procedures that are always available
+ *   unconditionally.
+ *   Most of the time, you only want to override
+ *   #GimpPlugInClass.query_procedures() and leave
+ *   #GimpPlugInClass.init_procedures() untouched.
+ * @create_procedure: This method must be overridden by all plug-ins
+ *   and return a newly allocated #GimpProcedure named @name. It will
+ *   be called for every @name as returned by
+ *   #GimpPlugInClass.query_procedures() and
+ *   #GimpPlugInClass.init_procedures() so care must be taken to handle
+ *   them all.
+ * @quit: This method can be overridden by a plug-in which needs to
+ *   perform some actions upon quitting.
  *
  * A class which every plug-in should sublass, while overriding
- * GimpPlugInClass::query_procedures() and/or
- * GimpPlugInClass::init_procedures(), as well as
- * GimpPlugInClass::create_procedure().
+ * #GimpPlugInClass.query_procedures() and/or
+ * #GimpPlugInClass.init_procedures(), as well as
+ * #GimpPlugInClass.create_procedure().
  *
  * Since: 3.0
  **/


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