qulogic/libgnt

Fix docs for variadic functions.

2019-05-11, Elliott Sales de Andrade
1560f38da91e
Parents 9f83881789ea
Children defbeb30636f
Fix docs for variadic functions.
2 files changed, 21 insertions(+), 11 deletions(-)
  • +17 -9
    gntbindable.h
  • +4 -2
    gntutils.h
    • --- a/gntbindable.h Tue May 21 01:33:29 2019 +0000
    +++ b/gntbindable.h Sat May 11 01:41:03 2019 -0400
    @@ -73,22 +73,29 @@
    * @klass: The class the binding is for.
    * @name: The name of the binding.
    * @callback: (scope call): The callback for the binding.
    - * @trigger: The default trigger for the binding, or %NULL, followed by a
    - * %NULL-terminated list of default parameters.
    + * @trigger: The default trigger for the binding, or %NULL.
    + * @...: A %NULL-terminated list of default parameters.
    *
    * Register a bindable action for a class.
    */
    -void gnt_bindable_class_register_action(GntBindableClass *klass, const char *name, GntBindableActionCallback callback, const char *trigger, ...);
    +void gnt_bindable_class_register_action(GntBindableClass *klass,
    + const char *name,
    + GntBindableActionCallback callback,
    + const char *trigger,
    + ...) G_GNUC_NULL_TERMINATED;
    /**
    * gnt_bindable_register_binding:
    - * @klass: The class the binding is for.
    - * @name: The name of the binding.
    - * @trigger: A new trigger for the binding, followed by a %NULL-terminated list of parameters for the callback.
    + * @klass: The class the binding is for.
    + * @name: The name of the binding.
    + * @trigger: A new trigger for the binding.
    + * @...: A %NULL-terminated list of parameters for the callback.
    *
    * Register a key-binding to an existing action.
    */
    -void gnt_bindable_register_binding(GntBindableClass *klass, const char *name, const char *trigger, ...);
    +void gnt_bindable_register_binding(GntBindableClass *klass, const char *name,
    + const char *trigger,
    + ...) G_GNUC_NULL_TERMINATED;
    /**
    * gnt_bindable_perform_action_key:
    @@ -116,8 +123,9 @@
    /**
    * gnt_bindable_perform_action_named:
    - * @bindable: The bindable object.
    - * @name: The action to perform, followed by a %NULL-terminated list of parameters.
    + * @bindable: The bindable object.
    + * @name: The action to perform.
    + * @...: A %NULL-terminated list of parameters.
    *
    * Perform an action on a bindable object.
    *
    --- a/gntutils.h Tue May 21 01:33:29 2019 +0000
    +++ b/gntutils.h Sat May 11 01:41:03 2019 -0400
    @@ -104,8 +104,10 @@
    /**
    * gnt_util_parse_widgets:
    - * @string: The XML string.
    - * @num: The number of widgets to return, followed by 'num' GntWidget **
    + * @string: The XML string.
    + * @num: The number of widgets to return.
    + * @...: (array length=num): A list of #GntWidget** pointers to place the
    + * result.
    *
    * Parse widgets from an XML description. For example,
    *