GNOME.org
 

[gtkmm] Fix some Doxygen warnings

commit 4b2a7024fb28c3fec8cb30c9858b99f7fe7bed47
Author: Kjell Ahlstedt <kjell ahlstedt bredband net>
Date:   Wed Dec 10 09:53:26 2014 +0100

    Fix some Doxygen warnings
    
    * gdk/gdkmm/general.h:
    * gdk/src/pixbuf.hg:
    * gtk/gtkmm/accelmap.h:
    * gtk/src/application.hg:
    * gtk/src/arrow.hg:
    * gtk/src/button.hg:
    * gtk/src/clipboard.hg:
    * gtk/src/iconinfo.hg:
    * gtk/src/menu.hg:
    * gtk/src/menubutton.hg:
    * gtk/src/plug.hg:
    * gtk/src/recentaction.hg:
    * gtk/src/scalebutton.hg:
    * gtk/src/treeview.hg:
    * gtk/src/uimanager.hg:
    Correct parameter names in @param directives, remove extraneous @ and #,
    change <xyz> to \<xyz\> when it shall not be interpreted by doxygen, etc.

 gdk/gdkmm/general.h     |    8 +++-----
 gdk/src/pixbuf.hg       |    8 ++++----
 gtk/gtkmm/accelmap.h    |    7 ++-----
 gtk/src/application.hg  |    2 +-
 gtk/src/arrow.hg        |    4 ++--
 gtk/src/button.hg       |    2 +-
 gtk/src/clipboard.hg    |    8 ++++----
 gtk/src/iconinfo.hg     |    2 +-
 gtk/src/menu.hg         |    2 ++
 gtk/src/menubutton.hg   |    4 ++--
 gtk/src/plug.hg         |    3 +--
 gtk/src/recentaction.hg |    4 ++--
 gtk/src/scalebutton.hg  |    1 +
 gtk/src/treeview.hg     |    8 ++++----
 gtk/src/uimanager.hg    |    2 +-
 15 files changed, 31 insertions(+), 34 deletions(-)
---
diff --git a/gdk/gdkmm/general.h b/gdk/gdkmm/general.h
index 869cb8a..f8746de 100644
--- a/gdk/gdkmm/general.h
+++ b/gdk/gdkmm/general.h
@@ -1,5 +1,3 @@
-/* $Id$ */
-
 /* Copyright 2002      The gtkmm Development Team
  *
  * This library is free software; you can redistribute it and/or
@@ -44,7 +42,7 @@ namespace Cairo
 #ifndef GDKMM_DISABLE_DEPRECATED
 
 /** Sets the specified Gdk::Color as the source color of the Cairo context.
- * @param @context The cairo context.
+ * @param context The cairo context.
  * @param color The color to use as the source color.
  *
  * @newin{2,10}
@@ -55,7 +53,7 @@ void set_source_color(const ::Cairo::RefPtr< ::Cairo::Context >& context, const
 #endif //GDKMM_DISABLE_DEPRECATED
 
 /** Sets the specified Gdk::RGBA as the source color of the Cairo context.
- * @param @context The cairo context.
+ * @param context The cairo context.
  * @param color The color to use as the source color.
  *
  * @newin{3,0}
@@ -64,7 +62,7 @@ void set_source_rgba(const ::Cairo::RefPtr< ::Cairo::Context >& context, const G
 
 
 /** Sets the given pixbuf as the source pattern for the Cairo context. The pattern has an extend mode of 
CAIRO_EXTEND_NONE and is aligned so that the origin of pixbuf is pixbuf_x, pixbuf_y.
- * @param @context The cairo context.
+ * @param context The cairo context.
  * @param pixbuf A Gdk::Pixbuf
  * @param pixbuf_x X coordinate of location to place upper left corner of pixbuf.
  * @param pixbuf_y Y coordinate of location to place upper left corner of pixbuf.
diff --git a/gdk/src/pixbuf.hg b/gdk/src/pixbuf.hg
index f1155ff..b3405cc 100644
--- a/gdk/src/pixbuf.hg
+++ b/gdk/src/pixbuf.hg
@@ -113,7 +113,7 @@ protected:
    *
    * This will create an RGB pixbuf with 8 bits per channel. The pixbuf will contain an alpha channel if the 
surface contains one. 
    *
-   * @param surface Surface to copy from.
+   * @param src Surface to copy from.
    * @param src_x Source X coordinate within the surface.
    * @param src_y Source Y coordinate within the surface.
    * @param width Width in pixels of region to get.
@@ -171,7 +171,7 @@ public:
    *
    * This will create an RGB pixbuf with 8 bits per channel. The pixbuf will contain an alpha channel if the 
surface contains one. 
    *
-   * @param surface Surface to copy from.
+   * @param src Surface to copy from.
    * @param src_x Source X coordinate within the surface.
    * @param src_y Source Y coordinate within the surface.
    * @param width Width in pixels of region to get.
@@ -217,7 +217,7 @@ public:
 
 
   /** Creates a new pixbuf by loading an image from a resource. The file format is detected automatically.
-   * @resource_path The path of the resource file.
+   * @param resource_path The path of the resource file.
    *
    * @throw Glib::ResourceError
    * @throw Gdk::PixbufError
@@ -233,7 +233,7 @@ public:
    * height, and a @a height of -1 will cause the image to be scaled to the
    * exact given width. When not preserving aspect ratio, a @a width or
    * @a height of -1 means to not scale the image at all in that dimension.
-   * @resource_path The path of the resource file.
+   * @param resource_path The path of the resource file.
    * @param width The desired width
    * @param height The desired height
    * @param preserve_aspect_ratio Whether the image's aspect ratio will be preserved when scaling.
diff --git a/gtk/gtkmm/accelmap.h b/gtk/gtkmm/accelmap.h
index ab28d7a..1074c85 100644
--- a/gtk/gtkmm/accelmap.h
+++ b/gtk/gtkmm/accelmap.h
@@ -1,9 +1,6 @@
-// -*- c++ -*-
 #ifndef _GTKMM_ACCELMAP_H
 #define _GTKMM_ACCELMAP_H
 
-/* $Id$ */
-
 /* accelmap.h
  *
  * Copyright (C) 2002 The Gtkmm Development Team
@@ -42,7 +39,7 @@ namespace AccelMap
  * To change the accelerator during runtime programatically, use
  * change_entry().
  * The accelerator path must consist of "<WINDOWTYPE>/Category1/Category2/.../Action",
- * where <WINDOWTYPE> should be a unique application-specific identifier, that
+ * where \<WINDOWTYPE\> should be a unique application-specific identifier, that
  * corresponds to the kind of window the accelerator is being used in, e.g. "Gimp-Image",
  * "Abiword-Document" or "Gnumeric-Settings".
  * The Category1/.../Action portion is most appropriately chosen by the action the
@@ -102,7 +99,7 @@ void save(const std::string& filename);
  * about runtime accelerator changes.
  *
  * Note that locking of individual accelerator paths is independent from
- * locking the #GtkAccelGroup containing them. For runtime accelerator
+ * locking the AccelGroup containing them. For runtime accelerator
  * changes to be possible both the accelerator path and its AccelGroup
  * have to be unlocked.
  *
diff --git a/gtk/src/application.hg b/gtk/src/application.hg
index d99d90c..6f2849f 100644
--- a/gtk/src/application.hg
+++ b/gtk/src/application.hg
@@ -356,7 +356,7 @@ public:
    * 
    * @param detailed_action_name A detailed action name, specifying an action
    * and target to associate accelerators with.
-   * @param accels An accelerator in the format understood by gtk_accelerator_parse().
+   * @param accel An accelerator in the format understood by gtk_accelerator_parse().
    *
    * @newin{3,12}
    */
diff --git a/gtk/src/arrow.hg b/gtk/src/arrow.hg
index be0677f..0be479d 100644
--- a/gtk/src/arrow.hg
+++ b/gtk/src/arrow.hg
@@ -45,8 +45,8 @@ namespace Gtk
  * @ingroup Widgets
  * @deprecated You should instead use a Gtk::Image with a
  * suitable icon name, such as “pan-down-symbolic“. When replacing 
- * Gtk::Arrow by an image, pay attention to the fact that GtkArrow automatically
- * flips between #GTK_ARROW_LEFT and #GTK_ARROW_RIGHT,
+ * Gtk::Arrow by an image, pay attention to the fact that Gtk::Arrow automatically
+ * flips between Gtk::ARROW_LEFT and Gtk::ARROW_RIGHT,
  * depending on the text direction. To get the same effect with an image,
  * use the icon names “pan-start-symbolic“ and “pan-end-symbolic“, which
  * react to the text direction instead of “pan-left-symbolic“ and
diff --git a/gtk/src/button.hg b/gtk/src/button.hg
index 4e5b8ca..6a1e4d8 100644
--- a/gtk/src/button.hg
+++ b/gtk/src/button.hg
@@ -87,7 +87,7 @@ public:
   _WRAP_METHOD(void clicked(), gtk_button_clicked)
   _IGNORE(gtk_button_pressed, gtk_button_released, gtk_button_enter, gtk_button_leave) //deprecated
 
-  _WRAP_METHOD(void set_relief(ReliefStyle newstyle), gtk_button_set_relief)
+  _WRAP_METHOD(void set_relief(ReliefStyle relief), gtk_button_set_relief)
   _WRAP_METHOD(ReliefStyle get_relief() const, gtk_button_get_relief)
 
   _WRAP_METHOD(void set_label(const Glib::ustring& label), gtk_button_set_label)
diff --git a/gtk/src/clipboard.hg b/gtk/src/clipboard.hg
index ca813f6..9b083d4 100644
--- a/gtk/src/clipboard.hg
+++ b/gtk/src/clipboard.hg
@@ -159,14 +159,14 @@ public:
   typedef sigc::slot<void, const Glib::ustring&, const std::string&> SlotRichTextReceived;
 
   /** Requests the contents of the clipboard as rich text. When the rich text is later received,
-   * callback will be called.
+   * @a slot will be called.
    *
-   * The text parameter to the callback will contain the resulting rich text if the request succeeded, or
+   * The text parameter to the slot will contain the resulting rich text if the request succeeded, or
    * an empty string if it failed. This function can fail for various reasons, in particular if the
    * clipboard was empty or if the contents of the clipboard could not be converted into rich text form.
    *
-   *
-   * @param slot:  a function to call when the text is received,
+   * @param buffer A Gtk::TextBuffer.
+   * @param slot A function to call when the text is received,
    *             or the retrieval fails. (It will always be called
    *             one way or the other.)
    */
diff --git a/gtk/src/iconinfo.hg b/gtk/src/iconinfo.hg
index 449f1f4..afa22d4 100644
--- a/gtk/src/iconinfo.hg
+++ b/gtk/src/iconinfo.hg
@@ -108,7 +108,7 @@ public:
    *
    * This allows loading symbolic icons that will match the system theme.
    *
-   * @param A StyleContext.
+   * @param style A StyleContext.
    * @param was_symbolic Whether the loaded icon was a symbolic one and whether the fg color was applied to 
it. 
    */
   Glib::RefPtr<Gdk::Pixbuf> load_symbolic(const Glib::RefPtr<StyleContext>& style, bool& was_symbolic);
diff --git a/gtk/src/menu.hg b/gtk/src/menu.hg
index e8453be..f054c6a 100644
--- a/gtk/src/menu.hg
+++ b/gtk/src/menu.hg
@@ -92,6 +92,7 @@ public:
    * @param position_calc_slot A user supplied function used to position the menu, or <tt>0</tt>.
    * @param button The mouse button which was pressed to initiate the event.
    * @param activate_time The time at which the activation event occurred.
+   * @param device A Gdk::Device.
    */
   void popup(const SlotPositionCalc& position_calc_slot, guint button, guint32 activate_time, const 
Glib::RefPtr<Gdk::Device>& device = Glib::RefPtr<Gdk::Device>());
 
@@ -99,6 +100,7 @@ public:
    * Applications can use this function to display context-sensitive menus, at the current pointer position.
    * @param button The button which was pressed to initiate the event.
    * @param activate_time The time at which the activation event occurred.
+   * @param device A Gdk::Device.
    */
   void popup(guint button, guint32 activate_time, const Glib::RefPtr<Gdk::Device>& device = 
Glib::RefPtr<Gdk::Device>());
 
diff --git a/gtk/src/menubutton.hg b/gtk/src/menubutton.hg
index 0c87bc7..03caa05 100644
--- a/gtk/src/menubutton.hg
+++ b/gtk/src/menubutton.hg
@@ -44,7 +44,7 @@ public:
   _CTOR_DEFAULT
 
  
-  _WRAP_METHOD(void set_menu(Menu& popup), gtk_menu_button_set_popup, deprecated "Use set_popup() instead.")
+  _WRAP_METHOD(void set_menu(Menu& menu), gtk_menu_button_set_popup, deprecated "Use set_popup() instead.")
   _IGNORE(gtk_menu_button_set_menu)
 
 _DEPRECATE_IFDEF_START
@@ -59,7 +59,7 @@ _DEPRECATE_IFDEF_END
   _WRAP_METHOD(const Menu* get_menu() const, gtk_menu_button_get_popup, constversion, deprecated "Use 
get_popup() instead.")
   _IGNORE(gtk_menu_button_get_menu)
 
-  _WRAP_METHOD(void set_popup(Menu& popup), gtk_menu_button_set_popup)
+  _WRAP_METHOD(void set_popup(Menu& menu), gtk_menu_button_set_popup)
 
   /** Disables the button.
    */
diff --git a/gtk/src/plug.hg b/gtk/src/plug.hg
index bbf93d3..fc5017a 100644
--- a/gtk/src/plug.hg
+++ b/gtk/src/plug.hg
@@ -47,11 +47,10 @@ namespace Gtk
  * integration when embedding a Qt widget
  * in GTK+ or vice versa.
  *
- * <note>
+ * @note
  * The Gtk::Plug and Gtk::Socket widgets are only available when GTK+ and gtkmm
  * are compiled for the X11 platform and %GDK_WINDOWING_X11 is defined.
  * They can only be used on a GdkX11Display.
- * </note>
  */
 class Plug : public Window
 {
diff --git a/gtk/src/recentaction.hg b/gtk/src/recentaction.hg
index 091e329..a0a3652 100644
--- a/gtk/src/recentaction.hg
+++ b/gtk/src/recentaction.hg
@@ -42,9 +42,9 @@ class StockID; //Deprecated.
  * which can be shown by widgets such as Gtk::RecentChooserDialog or
  * Gtk::RecentChooserMenu.
  * To construct a submenu showing recently used files, use a
- * Gtk::RecentAction as the action for a <menuitem>. To construct a menu
+ * Gtk::RecentAction as the action for a \<menuitem\>. To construct a menu
  * toolbutton showing the recently used files in the popup menu, use a
- * Gtk::RecentAction as the action for a <toolitem> element.
+ * Gtk::RecentAction as the action for a \<toolitem\> element.
  *
  * See also the methods in the RecentChooser base class.
  *
diff --git a/gtk/src/scalebutton.hg b/gtk/src/scalebutton.hg
index 695fb10..ac72945 100644
--- a/gtk/src/scalebutton.hg
+++ b/gtk/src/scalebutton.hg
@@ -54,6 +54,7 @@ public:
    * @param min The minimum value of the scale (usually 0).
    * @param max The maximum value of the scale (usually 100).
    * @param step The stepping of value when a scroll-wheel event, or up/down arrow event occurs (usually 2).
+   * @param icons A vector of icon names.
    */
   explicit ScaleButton(IconSize size, double min, double max, double step, const std::vector<Glib::ustring>& 
icons);
   _IGNORE(gtk_scale_button_new)
diff --git a/gtk/src/treeview.hg b/gtk/src/treeview.hg
index 363fa96..78e00b3 100644
--- a/gtk/src/treeview.hg
+++ b/gtk/src/treeview.hg
@@ -498,10 +498,10 @@ public:
   _WRAP_METHOD(Glib::RefPtr<const Gdk::Window> get_bin_window() const, gtk_tree_view_get_bin_window, 
refreturn, constversion)
 
   /** Finds the path at the point (@a x, @a y), relative to bin_window coordinates
-   * (please get_bin_window()).
+   * (please see get_bin_window()).
    * That is, @a x and @a y are relative to an events coordinates. @a x and @a y must
-   * come from an event on the TreeView only where <literal>event->window ==
-   * gtk_tree_view_get_bin_window (<!-- -->)</literal>. It is primarily for
+   * come from an event on the TreeView only where event->window ==
+   * get_bin_window(). It is primarily for
    * things like popup menus. @a path will be filled
    * with the TreeModel::Path at that point. @a column will be filled
    * with the column at that point.  @a cell_x and @a cell_y return the coordinates
@@ -528,7 +528,7 @@ public:
   bool get_path_at_pos(int x, int y, TreeModel::Path& path, TreeViewColumn*& column, int& cell_x, int& 
cell_y) const;
 
   /** Finds the path at the point (@a x, @a y), relative to bin_window coordinates
-   * (please get_bin_window()).
+   * (please see get_bin_window()).
    * That is, @a x and @a y are relative to an events coordinates. @a x and @a y must
    * come from an event on the TreeView only where event->window ==
    * get_bin_window(). It is primarily for
diff --git a/gtk/src/uimanager.hg b/gtk/src/uimanager.hg
index 15af409..7bb9efe 100644
--- a/gtk/src/uimanager.hg
+++ b/gtk/src/uimanager.hg
@@ -150,7 +150,7 @@ _WRAP_ENUM(UIManagerItemType, GtkUIManagerItemType)
  * \par Accelerators
  *
  * Every action has an accelerator path. Accelerators are installed together with menuitem
- * proxies, but they can also be explicitly added with <accelerator> elements in the
+ * proxies, but they can also be explicitly added with \<accelerator\> elements in the
  * UI definition. This makes it possible to have accelerators for actions even
  * if they have no visible proxies.
  *
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]