[glib: 2/5] gmountoperation: Add missing documentation



commit 778132d54c7216a3c743427e55e19646df8f67ea
Author: Philip Withnall <withnall endlessm com>
Date:   Wed Nov 28 13:10:03 2018 +0000

    gmountoperation: Add missing documentation
    
    gtk-doc is unhappy that skeleton documentation comments had been written
    for these functions (for the introspection annotations) but that the
    documentation content was actually missing.
    
    Add that content. I like a happy gtk-doc.
    
    Signed-off-by: Philip Withnall <withnall endlessm com>

 gio/gmountoperation.h | 21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)
---
diff --git a/gio/gmountoperation.h b/gio/gmountoperation.h
index 1361fb86f..56db2a577 100644
--- a/gio/gmountoperation.h
+++ b/gio/gmountoperation.h
@@ -66,9 +66,12 @@ struct _GMountOperationClass
 
   /**
    * GMountOperationClass::ask_question:
-   * @op:
-   * @message:
-   * @choices: (array zero-terminated=1) (element-type utf8):
+   * @op: a #GMountOperation
+   * @message: string containing a message to display to the user
+   * @choices: (array zero-terminated=1) (element-type utf8): an array of
+   *    strings for each possible choice
+   *
+   * Virtual implementation of #GMountOperation::ask-question.
    */
   void (* ask_question) (GMountOperation       *op,
                         const char            *message,
@@ -81,10 +84,14 @@ struct _GMountOperationClass
 
   /**
    * GMountOperationClass::show_processes:
-   * @op:
-   * @message:
-   * @processes: (element-type GPid):
-   * @choices: (array zero-terminated=1) (element-type utf8):
+   * @op: a #GMountOperation
+   * @message: string containing a message to display to the user
+   * @processes: (element-type GPid): an array of #GPid for processes blocking
+   *    the operation
+   * @choices: (array zero-terminated=1) (element-type utf8): an array of
+   *    strings for each possible choice
+   *
+   * Virtual implementation of #GMountOperation::show-processes.
    *
    * Since: 2.22
    */


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