GNOME.org
 

[glibmm] Fix some doxygen warnings

commit cbd3af07e015558802dcf5ac7917bafb69e95ac7
Author: Kjell Ahlstedt <kjell ahlstedt bredband net>
Date:   Fri Jan 31 12:37:30 2014 +0100

    Fix some doxygen warnings
    
    * gio/src/action.hg:
    * gio/src/actionmap.hg:
    * gio/src/dbusconnection.hg:
    * gio/src/dbusproxy.hg:
    * gio/src/file.hg:
    * gio/src/fileinfo.hg:
    * gio/src/menuitem.hg:
    * gio/src/mount.hg:
    * gio/src/settings.hg:
    * gio/src/simpleaction.hg:
    * gio/src/threadedsocketservice.hg:
    * glib/glibmm/base64.h:
    * glib/glibmm/refptr.h:
    * glib/src/variant.hg: Fix some warnings in doxygen.log.

 gio/src/action.hg                |    8 ++++----
 gio/src/actionmap.hg             |    1 -
 gio/src/dbusconnection.hg        |    1 +
 gio/src/dbusproxy.hg             |    1 +
 gio/src/file.hg                  |   21 +++++++++++----------
 gio/src/fileinfo.hg              |    2 +-
 gio/src/menuitem.hg              |    8 ++++----
 gio/src/mount.hg                 |    1 +
 gio/src/settings.hg              |    2 +-
 gio/src/simpleaction.hg          |    5 +++--
 gio/src/threadedsocketservice.hg |    4 ++--
 glib/glibmm/base64.h             |    2 +-
 glib/glibmm/refptr.h             |    2 +-
 glib/src/variant.hg              |    5 +++--
 14 files changed, 34 insertions(+), 29 deletions(-)
---
diff --git a/gio/src/action.hg b/gio/src/action.hg
index b6d3964..932ab8c 100644
--- a/gio/src/action.hg
+++ b/gio/src/action.hg
@@ -204,9 +204,9 @@ public:
    * @result A detailed format string.
    */
   template <typename T_Value>
-  Glib::ustring print_detailed_name(const T_Value& value);
+  Glib::ustring print_detailed_name(const T_Value& target_value);
 
-  _WRAP_METHOD(static Glib::ustring print_detailed_name_variant(const Glib::ustring& action_name, const 
Glib::VariantBase& parameter), g_action_print_detailed_name)
+  _WRAP_METHOD(static Glib::ustring print_detailed_name_variant(const Glib::ustring& action_name, const 
Glib::VariantBase& target_value), g_action_print_detailed_name)
 
   _WRAP_PROPERTY("enabled", bool)
   _WRAP_PROPERTY("name", Glib::ustring)
@@ -298,14 +298,14 @@ void Action::parse_detailed_name(const Glib::ustring& detailed_name, Glib::ustri
 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 template <typename T_Value>
-Glib::ustring Action::print_detailed_name(const T_Value& parameter)
+Glib::ustring Action::print_detailed_name(const T_Value& target_value)
 {
   typedef Glib::Variant<T_Value> type_glib_variant;
 
   g_return_val_if_fail(
     g_variant_type_equal(g_action_get_parameter_type(const_cast<GAction*>(gobj())), 
type_glib_variant::variant_type().gobj()),
     Glib::ustring());
-  return print_detailed_name_variant(get_name(), type_glib_variant::create(parameter));
+  return print_detailed_name_variant(get_name(), type_glib_variant::create(target_value));
 }
 
 template <typename T_Value>
diff --git a/gio/src/actionmap.hg b/gio/src/actionmap.hg
index 4400a68..3fb7332 100644
--- a/gio/src/actionmap.hg
+++ b/gio/src/actionmap.hg
@@ -68,7 +68,6 @@ public:
    * and adding it to the ActionMap.
    *
    * @param name The name of the Action.
-   * @param slot The callback method to be called when the action is activated.
    * @return The Action.
    */
   Glib::RefPtr<SimpleAction> add_action(const Glib::ustring& name);
diff --git a/gio/src/dbusconnection.hg b/gio/src/dbusconnection.hg
index 0f8dc83..065db96 100644
--- a/gio/src/dbusconnection.hg
+++ b/gio/src/dbusconnection.hg
@@ -785,6 +785,7 @@ public:
   /** Finishes an operation started with call() (with a UnixFDList).
    * @param res A AsyncResult obtained from the SlotAsyncReady passed to
    * call().
+   * @param out_fd_list Return location for a UnixFDList.
    * @result A Variant tuple with return values.
    * @throw Glib::Error.
    * @newin{2,34}
diff --git a/gio/src/dbusproxy.hg b/gio/src/dbusproxy.hg
index 298f9b2..0f79156 100644
--- a/gio/src/dbusproxy.hg
+++ b/gio/src/dbusproxy.hg
@@ -370,6 +370,7 @@ public:
   /** Finishes an operation started with call() (with a UnixFDList).
    * @param res A AsyncResult obtained from the SlotAsyncReady passed to
    * call().
+   * @param out_fd_list Return location for a UnixFDList.
    * @result A Variant tuple with return values.
    * @throw Glib::Error.
    * @newin{2,34}
diff --git a/gio/src/file.hg b/gio/src/file.hg
index b01d0e8..7df94c3 100644
--- a/gio/src/file.hg
+++ b/gio/src/file.hg
@@ -220,7 +220,7 @@ public:
   void read_async(const SlotAsyncReady& slot, int io_priority = Glib::PRIORITY_DEFAULT);
   _IGNORE(g_file_read_async)
 
-  _WRAP_METHOD(Glib::RefPtr<FileInputStream> read_finish(const Glib::RefPtr<AsyncResult>& result),
+  _WRAP_METHOD(Glib::RefPtr<FileInputStream> read_finish(const Glib::RefPtr<AsyncResult>& res),
                g_file_read_finish,
                errthrow)
 
@@ -410,6 +410,7 @@ public:
    * name is to longa Gio::Error with FILENAME_TOO_LONG will be thrown. Other errors are possible too, and
    * depend on what kind of filesystem the file is on.
    *
+   * @param cancellable A Cancellable object which can be used to cancel the operation.
    * @param etag An optional entity tag for the current Glib::File.
    * @param make_backup <tt>true</tt> if a backup should be created.
    * @param flags A set of FileCreateFlags.
@@ -717,7 +718,7 @@ public:
    * be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
    * means all attributes, and a wildcard like "standard::*" means all attributes in the standard
    * namespace. An example attribute query be "standard::*,owner::user".
-   * The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
+   * The standard attributes are available as defines, like G_FILE_ATTRIBUTE_STANDARD_NAME.
    *
    * The operation can be cancelled by
    * triggering the cancellable object from another thread. If the operation
@@ -750,7 +751,7 @@ public:
    * be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
    * means all attributes, and a wildcard like "standard::*" means all attributes in the standard
    * namespace. An example attribute query be "standard::*,owner::user".
-   * The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
+   * The standard attributes are available as defines, like G_FILE_ATTRIBUTE_STANDARD_NAME.
    *
    * For symlinks, normally the information about the target of the
    * symlink is returned, rather than information about the symlink itself.
@@ -782,7 +783,7 @@ public:
    * directory, or symlink.
    *
    * @param flags: a set of FileQueryInfoFlags passed to query_info().
-   * @results The FileType of the file, or FILE_TYPE_UNKNOWN if the file does not exist.
+   * @result The FileType of the file, or FILE_TYPE_UNKNOWN if the file does not exist.
    *
    * @newin{2,18}
    */
@@ -1098,7 +1099,7 @@ public:
                g_file_trash,
                errthrow)
 
-   /** Asynchronously sends @file to the Trash location, if possible.
+   /** Asynchronously sends the file to the Trash location, if possible.
     *
     * @param slot_ready A SlotAsyncReady to call when the request is satisfied
     * @param cancellable A Cancellable object which can be used to cancel the operation
@@ -1107,7 +1108,7 @@ public:
     */
   void trash_async(const SlotAsyncReady& slot_ready, const Glib::RefPtr<Cancellable>& cancellable, int 
io_priority = Glib::PRIORITY_DEFAULT);
 
-   /** Asynchronously sends @file to the Trash location, if possible.
+   /** Asynchronously sends the file to the Trash location, if possible.
     *
     * @param slot_ready A SlotAsyncReady to call when the request is satisfied
     * @param io_priority The I/O priority of the request
@@ -1815,7 +1816,7 @@ public:
   //We ignore the gboolean result, because we throw an exception if it is false.
   /** Recursively measures the disk usage of the file.
    *
-   * This is essentially an analog of the '<literal>du</literal>' command,
+   * This is essentially an analog of the '<tt>du</tt>' command,
    * but it also reports the number of directories and non-directory files
    * encountered (including things like symbolic links).
    *
@@ -1835,7 +1836,7 @@ public:
    * If the operation was cancelled, a Gio::Error with CANCELLED will be thrown.
    *
    * @param cancellable A Cancellable object which can be used to cancel the operation
-   * @param progress_callback A SlotFileMeasureProgress to call periodically while scanning.
+   * @param slot_progress A SlotFileMeasureProgress to call periodically while scanning.
    * @param disk_usage The number of bytes of disk space used.
    * @param num_dirs The number of directories encountered.
    * @param num_files The number of non-directories encountered.
@@ -1858,7 +1859,7 @@ public:
    * @param flags Set of FileMeasureFlags
    * @param io_priority The I/O priority of the request
    */
-  void measure_disk_usage_async(const SlotAsyncReady& slot_ready, const Glib::RefPtr<Cancellable>& 
cancellable, const SlotFileMeasureProgress& slot, FileMeasureFlags flags = FILE_MEASURE_NONE, int io_priority 
= Glib::PRIORITY_DEFAULT);
+  void measure_disk_usage_async(const SlotAsyncReady& slot_ready, const Glib::RefPtr<Cancellable>& 
cancellable, const SlotFileMeasureProgress& slot_progress, FileMeasureFlags flags = FILE_MEASURE_NONE, int 
io_priority = Glib::PRIORITY_DEFAULT);
   _IGNORE(g_file_measure_disk_usage_async)
 
   _WRAP_METHOD(bool measure_disk_usage_finish(const Glib::RefPtr<AsyncResult>& result, guint64& disk_usage, 
guint64& num_dirs, guint64& num_files), g_file_measure_disk_usage_finish, errthrow)
@@ -2350,7 +2351,7 @@ public:
    * @param new_etag A location of a new entity tag
    * for the document.
    */
-  void replace_contents_finish(const Glib::RefPtr<AsyncResult>& result, std::string& etag);
+  void replace_contents_finish(const Glib::RefPtr<AsyncResult>& result, std::string& new_etag);
 
   /** Finishes an asynchronous replace of the given file . See
    * replace_contents_async(). Sets @a new_etag to the new entity
diff --git a/gio/src/fileinfo.hg b/gio/src/fileinfo.hg
index d75d849..d10eb68 100644
--- a/gio/src/fileinfo.hg
+++ b/gio/src/fileinfo.hg
@@ -136,7 +136,7 @@ public:
   _WRAP_METHOD(bool set_attribute_status(const std::string& attribute, FileAttributeStatus status), 
g_file_info_set_attribute_status)
 
   //TODO: This should take a ustring value instead: https://bugzilla.gnome.org/show_bug.cgi?id=615950#c7
-  _WRAP_METHOD(void set_attribute_string(const std::string& attribute, const std::string& value),
+  _WRAP_METHOD(void set_attribute_string(const std::string& attribute, const std::string& attr_value),
                g_file_info_set_attribute_string)
 
 #m4 _CONVERSION(`const 
std::vector<Glib::ustring>&',`char**',`const_cast<char**>(Glib::ArrayHandler<Glib::ustring>::vector_to_array($3).data())')
diff --git a/gio/src/menuitem.hg b/gio/src/menuitem.hg
index 31eeae0..258aba9 100644
--- a/gio/src/menuitem.hg
+++ b/gio/src/menuitem.hg
@@ -55,7 +55,7 @@ protected:
    * set_submenu().
    *
    * @param label The section label.
-   * @param A MenuModel with the items of the submenu.
+   * @param submenu A MenuModel with the items of the submenu.
    */
   explicit MenuItem(const Glib::ustring& label, const Glib::RefPtr<MenuModel>& submenu);
 
@@ -64,7 +64,7 @@ protected:
    * This is a convenience API around the MenuItem(label, detailed_action) constructor and
    * set_submenu().
    *
-   * @param A MenuModel with the items of the submenu.
+   * @param submenu A MenuModel with the items of the submenu.
    */
   explicit MenuItem(const Glib::RefPtr<MenuModel>& submenu);
   _IGNORE(g_menu_item_new_submenu)
@@ -126,7 +126,7 @@ GMenuItem * g_menu_item_new_section                 (const Glib::ustring& label,
 
 _DEPRECATE_IFDEF_START
   /** Unsets the target for the specified @a action.
-   * @deprecate Use set_action() or unset_target() instead.
+   * @deprecated Use set_action() or unset_target() instead.
    */
   void set_action_and_target(const Glib::ustring& action);
 _DEPRECATE_IFDEF_END
@@ -148,7 +148,7 @@ _DEPRECATE_IFDEF_END
   /** Unsets the action and target for the menu item.
    * See set_action_and_target().
    *
-   * @newin{2,38}.
+   * @newin{2,38}
    */
   void unset_action_and_target();
 
diff --git a/gio/src/mount.hg b/gio/src/mount.hg
index 8f29973..18c03b0 100644
--- a/gio/src/mount.hg
+++ b/gio/src/mount.hg
@@ -106,6 +106,7 @@ public:
    * @param operation A mount operation.
    * @param slot A callback which will be called when the operation is completed or canceled.
    * @param cancellable A cancellable object which can be used to cancel the operation.
+   * @param flags Flags affecting the operation.
    */
   void remount(const Glib::RefPtr<MountOperation>& operation, const SlotAsyncReady& slot, const 
Glib::RefPtr<Cancellable>& cancellable, MountMountFlags flags = MOUNT_MOUNT_NONE);
 
diff --git a/gio/src/settings.hg b/gio/src/settings.hg
index ff060f4..74554fa 100644
--- a/gio/src/settings.hg
+++ b/gio/src/settings.hg
@@ -92,7 +92,7 @@ public:
 
   _WRAP_METHOD(Glib::RefPtr<Settings> get_child(const Glib::ustring& name), g_settings_get_child)
   _WRAP_METHOD(Glib::RefPtr<const Settings> get_child(const Glib::ustring& name) const, 
g_settings_get_child, constversion)
-  _WRAP_METHOD(bool is_writable(const Glib::ustring& key) const, g_settings_is_writable)
+  _WRAP_METHOD(bool is_writable(const Glib::ustring& name) const, g_settings_is_writable)
 
   _WRAP_METHOD(void delay(), g_settings_delay)
   _WRAP_METHOD(void apply(), g_settings_apply)
diff --git a/gio/src/simpleaction.hg b/gio/src/simpleaction.hg
index 0a5059a..4765674 100644
--- a/gio/src/simpleaction.hg
+++ b/gio/src/simpleaction.hg
@@ -50,7 +50,6 @@ protected:
    * The created action is stateless.
    *
    * @param name The name of the action.
-   * @param state The initial state of the action.
    */
   explicit SimpleAction(const Glib::ustring& name);
 
@@ -120,6 +119,7 @@ public:
    * 
    * @newin{2,38}
    * @param name The name of the action.
+   * @param initial_state The initial state of the action.
    * @return A new SimpleAction.
    */
   static Glib::RefPtr<SimpleAction> create_radio_string(const Glib::ustring& name, const Glib::ustring& 
initial_state);
@@ -135,9 +135,10 @@ public:
    * 
    * @newin{2,38}
    * @param name The name of the action.
+   * @param initial_state The initial state of the action.
    * @return A new SimpleAction.
    */
-  static Glib::RefPtr<SimpleAction> create_radio_integer(const Glib::ustring& name, gint32 inital_state);
+  static Glib::RefPtr<SimpleAction> create_radio_integer(const Glib::ustring& name, gint32 initial_state);
 
   _WRAP_METHOD(void set_enabled(bool enabled = true), g_simple_action_set_enabled)
 
diff --git a/gio/src/threadedsocketservice.hg b/gio/src/threadedsocketservice.hg
index 82b3565..d14a545 100644
--- a/gio/src/threadedsocketservice.hg
+++ b/gio/src/threadedsocketservice.hg
@@ -30,7 +30,7 @@ namespace Gio
  *
  * A ThreadedSocketService is a simple subclass of SocketService
  * that handles incoming connections by creating a worker thread and
- * dispatching the connection to it by emitting the ::run signal in
+ * dispatching the connection to it by emitting the run signal in
  * the new thread.
  *
  * The signal handler may perform blocking IO and need not return
@@ -41,7 +41,7 @@ namespace Gio
  * The service automatically stops the SocketService from accepting
  * new connections when all threads are busy.
  *
- * As with SocketService, you may connect to ThreadedSocketService:run,
+ * As with SocketService, you may connect to ThreadedSocketService::signal_run(),
  * or subclass and override the default handler.
  *
  * @newin{2,24}
diff --git a/glib/glibmm/base64.h b/glib/glibmm/base64.h
index 96ad384..d5ec413 100644
--- a/glib/glibmm/base64.h
+++ b/glib/glibmm/base64.h
@@ -38,7 +38,7 @@ namespace Base64
  *  line breaking, that is usually used in mail systems. The new line
  *  character will appear for every 72 bytes.
  * @param source A string to encode.
- * @param line_break Enables/disables line breaking.
+ * @param break_lines Enables/disables line breaking.
  * @return The string encoded in Base-64.
  */
 std::string encode(const std::string& source, bool break_lines = false);
diff --git a/glib/glibmm/refptr.h b/glib/glibmm/refptr.h
index 541a1bc..7b11a75 100644
--- a/glib/glibmm/refptr.h
+++ b/glib/glibmm/refptr.h
@@ -59,7 +59,7 @@ public:
   /// Destructor - decrements reference count.
   inline ~RefPtr();
 
-  /// For use only by the ::create() methods.
+  /// For use only by the \::create() methods.
   explicit inline RefPtr(T_CppObject* pCppObject);
 
   /** Copy constructor
diff --git a/glib/src/variant.hg b/glib/src/variant.hg
index c7424ab..1ab266e 100644
--- a/glib/src/variant.hg
+++ b/glib/src/variant.hg
@@ -53,7 +53,7 @@ namespace Glib
  * Serialised Variant data can also be sent over the network.
  *
  * Variant is largely compatible with D-Bus.  Almost all types of
- * #GVariant instances can be sent over D-Bus.  See VariantType for
+ * Variant instances can be sent over D-Bus.  See VariantType for
  * exceptions.
  *
  * There is a Python-inspired text language for describing Variant
@@ -61,9 +61,10 @@ namespace Glib
  * with type inferencing.</a>.
  */
 
-//Note: So far we only wrap this because it is thrown by GtkBuilder's functions.
+//Note: We wrap this because it is thrown by GtkBuilder's functions.
 // See https://bugzilla.gnome.org/show_bug.cgi?id=708206
 // It would also be thrown by parse() if we wrap g_variant_parse().
+// Now (2014-01-30) it's also thrown by Gio::Action::parse_detailed_name().
 /** Exception class for Variant parse errors.
  */
 _WRAP_GERROR(VariantParseError, GVariantParseError, G_VARIANT_PARSE_ERROR, NO_GTYPE)
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]