[gtkmm] Documentation: Fix many warnings from Doxygen.
- From: Kjell Ahlstedt <kjellahl src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtkmm] Documentation: Fix many warnings from Doxygen.
- Date: Wed, 23 Jan 2013 14:37:10 +0000 (UTC)
commit a77d438ebc13f3621a6ef1c116511f4992e9824c
Author: Kjell Ahlstedt <kjell ahlstedt bredband net>
Date: Wed Jan 23 15:32:01 2013 +0100
Documentation: Fix many warnings from Doxygen.
* gdk/src/gdk_docs_override.xml:
* gtk/src/gtk_docs_override.xml: Move "Since: n.m" from the <return> to the
<description> entries. gmmproc adds a period at the end of the @return
Doxygen command, and Doxygen warns for "@newin{n,m}.".
Add a missing parameter description for gtk_tree_view_set_tooltip_row.
* gtk/gtkmm.h: Correct a @ref Widgets.
* gdk/src/*.hg:
* gtk/src/*.hg: (Here "*" means "many", not "all") Examples of changes:
Add missing @param. Change names of parameters, so they are equal in function
declaration and @param command. Change "@name" to "@a name". Change
"<ulink url=" to "<a href=".
ChangeLog | 16 +++++++++
gdk/src/color.hg | 2 +-
gdk/src/device.hg | 2 +-
gdk/src/devicemanager.hg | 2 +-
gdk/src/dragcontext.hg | 6 ++--
gdk/src/gdk_docs_override.xml | 4 +-
gdk/src/pixbuf.hg | 12 ++++---
gdk/src/rectangle.hg | 2 +-
gdk/src/rgba.hg | 11 +++---
gdk/src/window.hg | 3 +-
gtk/gtkmm.h | 2 +-
gtk/src/aboutdialog.hg | 2 +-
gtk/src/actiongroup.hg | 2 +-
gtk/src/application.hg | 10 +++++
gtk/src/bin.hg | 2 +-
gtk/src/box.hg | 2 +-
gtk/src/builder.hg | 18 +++++-----
gtk/src/calendar.hg | 2 +-
gtk/src/cellrenderer.hg | 2 +-
gtk/src/cellrendereraccel.hg | 4 +-
gtk/src/cellview.hg | 3 +-
gtk/src/checkmenuitem.hg | 2 +-
gtk/src/colorbutton.hg | 4 +-
gtk/src/colorchooser.hg | 4 +-
gtk/src/colorselection.hg | 4 +-
gtk/src/combobox.hg | 7 ++--
gtk/src/cssprovider.hg | 4 +-
gtk/src/dialog.hg | 10 +++---
gtk/src/editable.hg | 2 +-
gtk/src/filechooser.hg | 2 +-
gtk/src/filechooserbutton.hg | 1 -
gtk/src/fontchooser.hg | 4 +-
gtk/src/fontselection.hg | 4 +-
gtk/src/gtk_docs_override.xml | 74 +++++++++++++---------------------------
gtk/src/hvbox.hg | 2 +
gtk/src/icontheme.hg | 2 +-
gtk/src/iconview.hg | 6 ++--
gtk/src/main.hg | 4 +--
gtk/src/menu.hg | 6 ++--
gtk/src/menubutton.hg | 6 ++--
gtk/src/menushell.hg | 6 ++--
gtk/src/messagedialog.hg | 4 +-
gtk/src/pagesetup.hg | 6 ++--
gtk/src/printer.hg | 4 +-
gtk/src/printoperation.hg | 9 ++---
gtk/src/printsettings.hg | 4 +-
gtk/src/printunixdialog.hg | 2 +-
gtk/src/recentinfo.hg | 6 ++--
gtk/src/scrollable.hg | 2 +-
gtk/src/textmark.hg | 10 ++---
gtk/src/tooltip.hg | 4 +-
gtk/src/treeiter.hg | 8 ++--
gtk/src/widget.hg | 2 +-
gtk/src/window.hg | 2 +-
54 files changed, 161 insertions(+), 165 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 397ba28..5389f54 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,19 @@
+2013-01-23 Kjell Ahlstedt <kjell ahlstedt bredband net>
+
+ Documentation: Fix many warnings from Doxygen.
+
+ * gdk/src/gdk_docs_override.xml:
+ * gtk/src/gtk_docs_override.xml: Move "Since: n.m" from the <return> to the
+ <description> entries. gmmproc adds a period at the end of the @return
+ Doxygen command, and Doxygen warns for "@newin{n,m}.".
+ Add a missing parameter description for gtk_tree_view_set_tooltip_row.
+ * gtk/gtkmm.h: Correct a @ref Widgets.
+ * gdk/src/*.hg:
+ * gtk/src/*.hg: (Here "*" means "many", not "all") Examples of changes:
+ Add missing @param. Change names of parameters, so they are equal in function
+ declaration and @param command. Change "@name" to "@a name". Change
+ "<ulink url=" to "<a href=".
+
2012-12-06 Kjell Ahlstedt <kjell ahlstedt bredband net>
gen_scripts: Get information from gdk-pixbuf.
diff --git a/gdk/src/color.hg b/gdk/src/color.hg
index d668781..bd21a1d 100644
--- a/gdk/src/color.hg
+++ b/gdk/src/color.hg
@@ -137,7 +137,7 @@ public:
*/
double get_blue_p() const;
- /** Get a textual specification of color in the hexadecimal form #rrrrggggbbbb,
+ /** Get a textual specification of color in the hexadecimal form \#rrrrggggbbbb,
* where r, g and b are hex digits representing the red, green and blue components respectively.
*
* @result The string representation.
diff --git a/gdk/src/device.hg b/gdk/src/device.hg
index 8a75e5a..2a329c2 100644
--- a/gdk/src/device.hg
+++ b/gdk/src/device.hg
@@ -100,7 +100,7 @@ public:
GrabStatus grab(const Glib::RefPtr<Window>& window, GrabOwnership grab_ownership, bool owner_events, EventMask event_mask, guint32 time_);
_WRAP_METHOD(void ungrab(guint32 time_), gdk_device_ungrab)
- _WRAP_METHOD(void warp(const Glib::RefPtr<Screen>&, int x, int y), gdk_device_warp)
+ _WRAP_METHOD(void warp(const Glib::RefPtr<Screen>& screen, int x, int y), gdk_device_warp)
// TODO: docs.
void get_position(int& x, int& y) const;
diff --git a/gdk/src/devicemanager.hg b/gdk/src/devicemanager.hg
index 8a2f2f3..e27ab90 100644
--- a/gdk/src/devicemanager.hg
+++ b/gdk/src/devicemanager.hg
@@ -74,7 +74,7 @@ namespace Gdk
* and GDK_GRAB_BROKEN.
*
* Although gdk_window_set_support_multidevice() must be called on
- * #GdkWindows in order to support additional features of multiple pointer
+ * \#GdkWindows in order to support additional features of multiple pointer
* interaction, such as multiple per-device enter/leave events, the default
* setting will emit just one enter/leave event pair for all devices on the
* window. See Gdk::Window::set_support_multidevice() documentation for more
diff --git a/gdk/src/dragcontext.hg b/gdk/src/dragcontext.hg
index e0fddd7..65ae646 100644
--- a/gdk/src/dragcontext.hg
+++ b/gdk/src/dragcontext.hg
@@ -55,15 +55,15 @@ public:
_IGNORE(gdk_drag_motion) //gdk_drag_motion is only used in GDK internally.
- _WRAP_METHOD(void drop_reply(bool ok, guint32 time), gdk_drop_reply)
+ _WRAP_METHOD(void drop_reply(bool accepted, guint32 time), gdk_drop_reply)
_WRAP_METHOD(void drop_finish(bool success, guint32 time), gdk_drop_finish)
_WRAP_METHOD(Glib::ustring get_selection() const, gdk_drag_get_selection)
//For some reason this is not in our *_docs.xml file.
/** Informs the drag source that the drop is finished, and that the data of the drag will no longer be required.
* @param success A flag indicating whether the drop was successful.
- * @param del Aa flag indicating whether the source should delete the original data. (This should be true for a move.)
- * time The timestamp from the "drag_data_drop" signal.
+ * @param del A flag indicating whether the source should delete the original data. (This should be true for a move.)
+ * @param time The timestamp from the "drag_data_drop" signal.
*/
_WRAP_METHOD(void drag_finish(bool success, bool del, guint32 time), gtk_drag_finish)
//Gtk::Widget* get_source_widget() - see Gtk::Widget::drag_get_source_widget()
diff --git a/gdk/src/gdk_docs_override.xml b/gdk/src/gdk_docs_override.xml
index f85fd13..bec8513 100644
--- a/gdk/src/gdk_docs_override.xml
+++ b/gdk/src/gdk_docs_override.xml
@@ -712,12 +712,12 @@ a cursor with no pixels in it.
<function name="gdk_cairo_create">
<description>
Creates a Cairo context for drawing to @drawable.
+
+Since: 2.10
</description>
<parameters>
</parameters>
<return> A newly created Cairo context.
-
-Since: 2.10
</return>
</function>
diff --git a/gdk/src/pixbuf.hg b/gdk/src/pixbuf.hg
index 9bf4d36..9680bbb 100644
--- a/gdk/src/pixbuf.hg
+++ b/gdk/src/pixbuf.hg
@@ -248,10 +248,10 @@ public:
_WRAP_METHOD(static Glib::RefPtr<Pixbuf> create_from_inline(int data_length, const guint8* data,
bool copy_pixels = false), gdk_pixbuf_new_from_inline, errthrow)
- _WRAP_METHOD(static Glib::RefPtr<Pixbuf> create_from_stream(const Glib::RefPtr<Gio::InputStream>& stream, const Glib::RefPtr<Gio::Cancellable>& cancelable), gdk_pixbuf_new_from_stream, errthrow)
+ _WRAP_METHOD(static Glib::RefPtr<Pixbuf> create_from_stream(const Glib::RefPtr<Gio::InputStream>& stream, const Glib::RefPtr<Gio::Cancellable>& cancellable), gdk_pixbuf_new_from_stream, errthrow)
static Glib::RefPtr<Pixbuf> create_from_stream(const Glib::RefPtr<Gio::InputStream>& stream);
- _WRAP_METHOD(static Glib::RefPtr<Pixbuf> create_from_stream_at_scale(const Glib::RefPtr<Gio::InputStream>& stream, int width, int height, bool preserve_aspect_ratio, const Glib::RefPtr<Gio::Cancellable>& cancelable), gdk_pixbuf_new_from_stream_at_scale, errthrow)
+ _WRAP_METHOD(static Glib::RefPtr<Pixbuf> create_from_stream_at_scale(const Glib::RefPtr<Gio::InputStream>& stream, int width, int height, bool preserve_aspect_ratio, const Glib::RefPtr<Gio::Cancellable>& cancellable), gdk_pixbuf_new_from_stream_at_scale, errthrow)
static Glib::RefPtr<Pixbuf> create_from_stream_at_scale(const Glib::RefPtr<Gio::InputStream>& stream, int width, int height, bool preserve_aspect_ratio);
@@ -297,7 +297,7 @@ public:
* TThe list of all writable formats can be determined by using get_formats() with
* Gdk::PixbufFormat::is_writable().
*
- * The @a option_keys and @option_values, if not empty, should contain pairs of strings that modify the save parameters.
+ * The @a option_keys and @a option_values, if not empty, should contain pairs of strings that modify the save parameters.
* For example, "quality", "100".
*
* Currently only a few parameters exist. JPEG images can be saved with a "quality" parameter;
@@ -377,7 +377,7 @@ gboolean gdk_pixbuf_save_to_callbackv (GdkPixbuf *pixbuf,
* @newin{3,6}
*
* @param buffer This will be set to the address of a new buffer.
- * @param size This will be set to the size of the @a buffer.
+ * @param buffer_size This will be set to the size of the @a buffer.
* @param type Currently "jpeg", "png", "ico" or "bmp".
*
* @throw Glib::FileError
@@ -402,8 +402,10 @@ gboolean gdk_pixbuf_save_to_callbackv (GdkPixbuf *pixbuf,
* @newin{3,6}
*
* @param buffer This will be set to the address of a new buffer.
- * @param size This will be set to the size of the @a buffer.
+ * @param buffer_size This will be set to the size of the @a buffer.
* @param type Currently "jpeg", "png", "ico" or "bmp".
+ * @param option_keys Names of options to set.
+ * @param option_values Values for named options.
*
* @throw Glib::FileError
* @throw Gdk::PixbufError
diff --git a/gdk/src/rectangle.hg b/gdk/src/rectangle.hg
index 22c418e..cf909c4 100644
--- a/gdk/src/rectangle.hg
+++ b/gdk/src/rectangle.hg
@@ -67,7 +67,7 @@ public:
* For instance: rect.intersect(src2).join(src3);
*
* @param src2 The rectangle with which to calculate the intersection with this rectangle.
- * @param rectangles_interesect This will be set to true if the rectangles intersect.
+ * @param rectangles_intersect This will be set to true if the rectangles intersect.
* @returns A reference to this rectangle.
*/
Rectangle& intersect(const Rectangle& src2, bool& rectangles_intersect);
diff --git a/gdk/src/rgba.hg b/gdk/src/rgba.hg
index f61c9ed..e309076 100644
--- a/gdk/src/rgba.hg
+++ b/gdk/src/rgba.hg
@@ -53,6 +53,7 @@ public:
/** Set a grey color, by using the same value for all color components.
* @param value The value to be used for the red, green, and blue components.
+ * @param alpha The alpha component of the color.
*/
void set_grey_u(gushort value, gushort alpha = 65535);
void set_grey(double g, double alpha = 1.0);
@@ -61,6 +62,7 @@ public:
* @param red_ The red component of the color.
* @param green_ The green component of the color.
* @param blue_ The blue component of the color.
+ * @param alpha_ The alpha component of the color.
*/
void set_rgba_u(gushort red_, gushort green_, gushort blue_, gushort alpha_ = 65535);
@@ -68,6 +70,7 @@ public:
* @param red_ The red component of the color, as a percentage.
* @param green_ The green component of the color, as a percentage.
* @param blue_ The blue component of the color, as a percentage.
+ * @param alpha_ The alpha component of the color, as a percentage.
*/
void set_rgba(double red_, double green_, double blue_, double alpha_ = 1.0);
@@ -75,7 +78,7 @@ public:
void set_hsv(double h, double s, double v);
void set_hsl(double h, double s, double l);
- _WRAP_METHOD(bool set(const Glib::ustring& value), gdk_rgba_parse)
+ _WRAP_METHOD(bool set(const Glib::ustring& spec), gdk_rgba_parse)
/** Get the red component of the color.
* @result The red component of the color.
@@ -154,13 +157,9 @@ public:
void set_blue(double value);
/** Set the alpha component of the color, as a percentage.
- * @param value The blue component of the color.
- */
- void set_alpha(double value);
-
- /** Set the alpha component of the color.
* @param value The alpha component of the color.
*/
+ void set_alpha(double value);
_WRAP_METHOD(Glib::ustring to_string() const, gdk_rgba_to_string)
diff --git a/gdk/src/window.hg b/gdk/src/window.hg
index d1d9e0b..30e8613 100644
--- a/gdk/src/window.hg
+++ b/gdk/src/window.hg
@@ -150,7 +150,7 @@ public:
_WRAP_METHOD(void set_startup_id(const Glib::ustring& startup_id), gdk_window_set_startup_id)
_WRAP_METHOD(void set_transient_for(const Glib::RefPtr<Window>& parent), gdk_window_set_transient_for)
_WRAP_METHOD(void set_background(const Color& color), gdk_window_set_background, deprecated "Use the set_background() method that takes a Gdk::RGBA instead.")
- _WRAP_METHOD(void set_background(const RGBA& color), gdk_window_set_background_rgba)
+ _WRAP_METHOD(void set_background(const RGBA& rgba), gdk_window_set_background_rgba)
#m4 _CONVERSION(`const ::Cairo::RefPtr< ::Cairo::Pattern>&',`cairo_pattern_t*',`($3)->cobj()')
_WRAP_METHOD(void set_background(const ::Cairo::RefPtr< ::Cairo::Pattern>& pattern), gdk_window_set_background_pattern)
@@ -272,7 +272,6 @@ public:
/** Starts a drag and creates a new drag context for it.
*
* This method is called by the drag source.
- * @param window The source window for this drag.
* @param targets A list of the offered targets names.
* @return A newly created Gdk::DragContext.
*
diff --git a/gtk/gtkmm.h b/gtk/gtkmm.h
index 9e183c8..a64a4a8 100644
--- a/gtk/gtkmm.h
+++ b/gtk/gtkmm.h
@@ -38,7 +38,7 @@
*
* @section features Features
*
- * - GTK+âs mature, capable set of @ref widgets Widgets. See
+ * - GTK+âs mature, capable set of @ref Widgets widgets. See
* <a href="http://www.gtk.org/";>the GTK+ website</a> for more information.
* - Use inheritance to derive custom widgets.
* - Type-safe signal handlers (slots), in standard C++, using
diff --git a/gtk/src/aboutdialog.hg b/gtk/src/aboutdialog.hg
index b4dc372..dc2d7fa 100644
--- a/gtk/src/aboutdialog.hg
+++ b/gtk/src/aboutdialog.hg
@@ -38,7 +38,7 @@ _WRAP_ENUM(License, GtkLicense)
* About dialogs often contain links and email addresses. Gtk::AboutDialog displays these as clickable links.
* By default, it calls gtk_show_uri() when a user clicks one. The behaviour can be overridden with the activate_link signal.
* Email addresses in the authors, documenters and artists properties are recognized by looking
- * for <user host>, URLs are recognized by looking for http://url, with the URL extending to the next space,
+ * for \<user\ host\>, URLs are recognized by looking for http://url, with the URL extending to the next space,
* tab or line break.
*
* An AboutDialog looks like this:
diff --git a/gtk/src/actiongroup.hg b/gtk/src/actiongroup.hg
index 04b9ba6..9babae4 100644
--- a/gtk/src/actiongroup.hg
+++ b/gtk/src/actiongroup.hg
@@ -73,7 +73,7 @@ public:
_WRAP_METHOD(void remove(const Glib::RefPtr<Action>& action), gtk_action_group_remove_action)
//TODO: We probably need to use this in our add_actions() implementation:
- _WRAP_METHOD(Glib::ustring translate_string(const Glib::ustring& str) const, gtk_action_group_translate_string)
+ _WRAP_METHOD(Glib::ustring translate_string(const Glib::ustring& string) const, gtk_action_group_translate_string)
//These are just C convenience methods:
diff --git a/gtk/src/application.hg b/gtk/src/application.hg
index bfdec28..f15d2de 100644
--- a/gtk/src/application.hg
+++ b/gtk/src/application.hg
@@ -181,6 +181,10 @@ public:
* It is an error to call this function if @a application is a proxy for
* a remote application.
*
+ * @param argc The argc from main() (or 0 if @a argv is <tt>0</tt>).
+ * @param argv The argv from main(), or <tt>0</tt>.
+ * @return The exit status.
+ *
* @newin{3,4}
*/
int run(int argc, char** argv);
@@ -194,6 +198,9 @@ public:
* a remote application.
*
* @param window The window to show. This method will return when the window is hidden.
+ * @param argc The argc from main() (or 0 if @a argv is <tt>0</tt>).
+ * @param argv The argv from main(), or <tt>0</tt>.
+ * @return The exit status.
*
* @newin{3,4}
*/
@@ -210,6 +217,7 @@ public:
* a remote application.
*
* @param window The window to show. This method will return when the window is hidden.
+ * @return The exit status.
*
* @newin{3,4}
*/
@@ -225,6 +233,8 @@ public:
* It is an error to call this function if @a application is a proxy for
* a remote application.
*
+ * @return The exit status.
+ *
* @newin{3,4}
*/
int run();
diff --git a/gtk/src/bin.hg b/gtk/src/bin.hg
index a372fa2..6b3dff1 100644
--- a/gtk/src/bin.hg
+++ b/gtk/src/bin.hg
@@ -88,7 +88,7 @@ public:
Align x_align, Align y_align = ALIGN_CENTER);
//TODO: Change this to Pixbuf?
- /** Add Image and Label objects.
+ /* Add Image and Label objects.
* This does not correspond to any GTK+ function and is provided purely for
* convenience.
* This will create, manage, add, and show a new Image and Label (within an
diff --git a/gtk/src/box.hg b/gtk/src/box.hg
index 40c2d30..8a1fd32 100644
--- a/gtk/src/box.hg
+++ b/gtk/src/box.hg
@@ -114,7 +114,7 @@ public:
_WRAP_METHOD(void set_spacing(int spacing), gtk_box_set_spacing)
_WRAP_METHOD(int get_spacing() const, gtk_box_get_spacing)
- _WRAP_METHOD(void reorder_child(Widget& child, int pos), gtk_box_reorder_child)
+ _WRAP_METHOD(void reorder_child(Widget& child, int position), gtk_box_reorder_child)
_WRAP_PROPERTY("spacing", int)
_WRAP_PROPERTY("homogeneous", bool)
diff --git a/gtk/src/builder.hg b/gtk/src/builder.hg
index 7d6edfc..e1e6762 100644
--- a/gtk/src/builder.hg
+++ b/gtk/src/builder.hg
@@ -218,7 +218,7 @@ public:
/** Parses a file containing a GtkBuilder UI definition,
* and merges it with the current contents of the builder.
*
- * @param buffer The file to parse.
+ * @param filename The file to parse.
* @result true on success or false if an error occurred.
* @throws BuilderError, Glib::MarkupError, Glib::MarkupError
*
@@ -236,8 +236,8 @@ public:
* its child (for instance a GtkTreeView that depends on its
* GtkTreeModel), you have to explicitely list all of them.
*
- * @param buffer The file to parse.
- * @param The object to build.
+ * @param filename The file to parse.
+ * @param object_id The object to build.
* @result true on success or false if an error occurred.
* @throws BuilderError, Glib::MarkupError, Glib::MarkupError
*
@@ -253,8 +253,8 @@ public:
* its child (for instance a GtkTreeView that depends on its
* GtkTreeModel), you have to explicitely list all of them.
*
- * @param buffer The file to parse.
- * @param The object to build.
+ * @param filename The file to parse.
+ * @param object_id The object to build.
* @result true on success or false if an error occurred.
* @throws BuilderError, Glib::MarkupError, Glib::MarkupError
*
@@ -335,7 +335,7 @@ public:
* and merges it with the current contents of the builder.
*
* @param buffer The string to parse.
- * @param The object to build.
+ * @param object_id The object to build.
* @result true on success or false if an error occurred.
* @throws BuilderError, Glib::MarkupError
*
@@ -348,7 +348,7 @@ public:
* and merges it with the current contents of the builder.
*
* @param buffer The string to parse.
- * @param The object to build.
+ * @param object_id The object to build.
* @result true on success or false if an error occurred.
* @throws BuilderError, Glib::MarkupError
*
@@ -361,7 +361,7 @@ public:
* and merges it with the current contents of the builder.
*
* @param buffer The string to parse.
- * @param The objects to build.
+ * @param object_ids The objects to build.
* @result true on success or false if an error occurred.
* @throws BuilderError, Glib::MarkupError
*
@@ -374,7 +374,7 @@ public:
* and merges it with the current contents of the builder.
*
* @param buffer The string to parse.
- * @param length The length of @a buffer (may be -1 if @buffer is nul-terminated).
+ * @param length The length of @a buffer (may be -1 if @a buffer is nul-terminated).
* @result true on success or false if an error occurred.
* @throws BuilderError, Glib::MarkupError
*
diff --git a/gtk/src/calendar.hg b/gtk/src/calendar.hg
index d8f9b7f..6dd49e7 100644
--- a/gtk/src/calendar.hg
+++ b/gtk/src/calendar.hg
@@ -83,7 +83,7 @@ public:
*
* @param year The year for which details are needed.
* @param month The month for which details are needed.
- * @param day The day of @month for which details are needed.
+ * @param day The day of @a month for which details are needed.
* @result Pango markup with details for the specified day, or an empty string.
*
* This callback function provides Pango markup with detail information for the
diff --git a/gtk/src/cellrenderer.hg b/gtk/src/cellrenderer.hg
index 37fa12e..e004328 100644
--- a/gtk/src/cellrenderer.hg
+++ b/gtk/src/cellrenderer.hg
@@ -82,7 +82,7 @@ public:
_IGNORE(gtk_cell_renderer_editing_canceled) //deprecated
- _WRAP_METHOD(void set_alignment(float align, float yalign), gtk_cell_renderer_set_alignment)
+ _WRAP_METHOD(void set_alignment(float xalign, float yalign), gtk_cell_renderer_set_alignment)
_WRAP_METHOD(void get_alignment(float& xalign, float& yalign) const, gtk_cell_renderer_get_alignment)
_WRAP_METHOD(void set_padding(int xpad, int ypad), gtk_cell_renderer_set_padding)
diff --git a/gtk/src/cellrendereraccel.hg b/gtk/src/cellrendereraccel.hg
index 3f41591..b1f6663 100644
--- a/gtk/src/cellrendereraccel.hg
+++ b/gtk/src/cellrendereraccel.hg
@@ -28,8 +28,8 @@ namespace Gtk
_WRAP_ENUM(CellRendererAccelMode, GtkCellRendererAccelMode)
-/** .
- * Renders a keyboard accelerator in a cell
+/**
+ * Renders a keyboard accelerator in a cell.
*
* Gtk::CellRendererAccel displays a keyboard accelerator
* (i.e. a key combination like <Control>-a).
diff --git a/gtk/src/cellview.hg b/gtk/src/cellview.hg
index eb670fa..d3d739a 100644
--- a/gtk/src/cellview.hg
+++ b/gtk/src/cellview.hg
@@ -62,7 +62,7 @@ public:
* Optionally, the text can be marked up with the Pango text markup language.
*
* @param text The text to display in the cell view
- * @param markup Whether the @a text uses Pango text markup language.
+ * @param use_markup Whether the @a text uses Pango text markup language.
*/
explicit CellView(const Glib::ustring& text, bool use_markup = false);
_IGNORE(gtk_cell_view_new_with_text, gtk_cell_view_new_with_markup)
@@ -70,7 +70,6 @@ public:
/** Creates a new CellView widget, adds a CellRendererPixbuf to it, and makes it show the pixbuf.
*
* @param pixbuf The image to display in the cell view
- * @param markup Whether the @a text uses Pango text markup language.
*/
explicit CellView(const Glib::RefPtr<Gdk::Pixbuf>& pixbuf);
_IGNORE(gtk_cell_view_new_with_pixbuf)
diff --git a/gtk/src/checkmenuitem.hg b/gtk/src/checkmenuitem.hg
index 3de8fd1..4f69261 100644
--- a/gtk/src/checkmenuitem.hg
+++ b/gtk/src/checkmenuitem.hg
@@ -40,7 +40,7 @@ public:
explicit CheckMenuItem(const Glib::ustring& label, bool mnemonic = false);
- _WRAP_METHOD(void set_active(bool state = true), gtk_check_menu_item_set_active)
+ _WRAP_METHOD(void set_active(bool is_active = true), gtk_check_menu_item_set_active)
_WRAP_METHOD(bool get_active() const, gtk_check_menu_item_get_active)
_WRAP_METHOD(void toggled(), gtk_check_menu_item_toggled)
diff --git a/gtk/src/colorbutton.hg b/gtk/src/colorbutton.hg
index 1b6899e..cc5f935 100644
--- a/gtk/src/colorbutton.hg
+++ b/gtk/src/colorbutton.hg
@@ -81,7 +81,7 @@ public:
* initializes the button with this color. Equivalent to calling set_rgba(@a color)
* after the default constructor.
*
- * @param color A Gdk::RGBA to set the current color with.
+ * @param rgba A Gdk::RGBA to set the current color with.
*
* @newin{3,0}
*/
@@ -89,7 +89,7 @@ public:
_WRAP_METHOD(void set_color(const Gdk::Color& color), gtk_color_button_set_color, deprecated "Use set_rgba() instead.")
_WRAP_METHOD(void set_alpha(guint16 alpha), gtk_color_button_set_alpha, deprecated "Use set_rgba() instead.")
- _WRAP_METHOD(void set_rgba(const Gdk::RGBA& color), gtk_color_button_set_rgba)
+ _WRAP_METHOD(void set_rgba(const Gdk::RGBA& rgba), gtk_color_button_set_rgba)
#ifndef GTKMM_DISABLE_DEPRECATED
diff --git a/gtk/src/colorchooser.hg b/gtk/src/colorchooser.hg
index 0893a77..59d535b 100644
--- a/gtk/src/colorchooser.hg
+++ b/gtk/src/colorchooser.hg
@@ -54,8 +54,8 @@ public:
_WRAP_METHOD(void set_use_alpha(bool use_alpha = true), gtk_color_chooser_set_use_alpha)
/** Adds a palette to the color chooser. If @a orientation is horizontal,
- * the colors are grouped in rows, with @colors_per_line colors
- * in each row. If @horizontal is %FALSE, the colors are grouped
+ * the colors are grouped in rows, with @a colors_per_line colors
+ * in each row. If @a orientation is vertical, the colors are grouped
* in columns instead.
*
* The default color palette of ColorChooserWidget has
diff --git a/gtk/src/colorselection.hg b/gtk/src/colorselection.hg
index 29af098..ae6ef61 100644
--- a/gtk/src/colorselection.hg
+++ b/gtk/src/colorselection.hg
@@ -73,8 +73,8 @@ public:
Gdk::RGBA get_current_rgba() const;
Gdk::RGBA get_previous_rgba() const;
- _WRAP_METHOD(void set_current_rgba(const Gdk::RGBA& color), gtk_color_selection_set_current_rgba)
- _WRAP_METHOD(void set_previous_rgba(const Gdk::RGBA& color), gtk_color_selection_set_previous_rgba)
+ _WRAP_METHOD(void set_current_rgba(const Gdk::RGBA& rgba), gtk_color_selection_set_current_rgba)
+ _WRAP_METHOD(void set_previous_rgba(const Gdk::RGBA& rgba), gtk_color_selection_set_previous_rgba)
_WRAP_METHOD(bool is_adjusting() const, gtk_color_selection_is_adjusting)
diff --git a/gtk/src/combobox.hg b/gtk/src/combobox.hg
index 77f9e08..8abafd5 100644
--- a/gtk/src/combobox.hg
+++ b/gtk/src/combobox.hg
@@ -70,20 +70,21 @@ class ComboBox
_IMPLEMENTS_INTERFACE(CellEditable)
public:
- /** Creates a new empty #GtkComboBox, optionally with an entry.
+ /** Creates a new empty ComboBox, optionally with an entry.
* @param has_entry If this is true then this will have an Entry widget.
*/
explicit ComboBox(bool has_entry = false);
_IGNORE(gtk_combo_box_new_with_entry)
- /** Creates a new ComboBox with the model initialized to @a model.
+ /** Creates a new ComboBox with the model initialized to @a model, optionally with an entry.
* @param model The model containing data to display in the ComboBox.
* @param has_entry If this is true then this will have an Entry widget.
*/
explicit ComboBox(const Glib::RefPtr<TreeModel>& model, bool has_entry = false);
_IGNORE(gtk_combo_box_new_with_model, gtk_combo_box_new_with_model_and_entry)
- /** Creates a new empty #GtkComboBox, optionally with an entry.
+ /** Creates a new empty ComboBox using @a cell_area to layout cells, optionally with an entry.
+ * @param cell_area The CellArea to use to layout cell renderers.
* @param has_entry If this is true then this will have an Entry widget.
*/
explicit ComboBox(const Glib::RefPtr<CellArea>& cell_area, bool has_entry = false);
diff --git a/gtk/src/cssprovider.hg b/gtk/src/cssprovider.hg
index 8846201..b9c6215 100644
--- a/gtk/src/cssprovider.hg
+++ b/gtk/src/cssprovider.hg
@@ -28,14 +28,14 @@ namespace Gtk
/** CSS-like styling for widgets, implementing the StyleProvider base class.
*
- * It is able to parse <ulink url="http://www.w3.org/TR/CSS2";>CSS</ulink>-like
+ * It is able to parse <a href="http://www.w3.org/TR/CSS2";>CSS</a>-like
* input in order to style widgets.
*
* An application can cause GTK+ to parse a specific CSS style sheet by
* calling load_from_file() and adding the provider with
* StyleContext::add_provider() or StyleContext::add_provider_for_screen().
* In addition, certain files will be read when GTK+ is initialized.
- * See the <ulink url="http://library.gnome.org/devel/gtk3/unstable/GtkCssProvider.html#GtkCssProvider.description";>GtkCssProvider documentation</ulink> for details of these default files and details of the stylesheets.
+ * See the <a href="http://library.gnome.org/devel/gtk3/unstable/GtkCssProvider.html#GtkCssProvider.description";>GtkCssProvider documentation</a> for details of these default files and details of the stylesheets.
*
* @newin{3,0}
*/
diff --git a/gtk/src/dialog.hg b/gtk/src/dialog.hg
index 435a403..e9b3ab3 100644
--- a/gtk/src/dialog.hg
+++ b/gtk/src/dialog.hg
@@ -90,17 +90,17 @@ public:
* the order of the response ids in @a new_order.
*
* By default, GTK+ dialogs use the button order advocated by the Gnome
- * <ulink url="http://developer.gnome.org/projects/gup/hig/2.0/";>Human
- * Interface Guidelines</ulink> with the affirmative button at the far
+ * <a href="http://developer.gnome.org/hig-book/stable/";>Human
+ * Interface Guidelines</a> with the affirmative button at the far
* right, and the cancel button left of it. But the builtin GTK+ dialogs
- * and #GtkMessageDialog<!-- -->s do provide an alternative button order,
+ * and MessageDialog<!-- -->s do provide an alternative button order,
* which is more suitable on some platforms, e.g. Windows.
*
- * Use this function after adding all the buttons to your dialog
+ * Use this function after adding all the buttons to your dialog.
*
* @param new_order an array of response ids of the dialog's buttons.
*
- * @newinp26
+ * @newin{2,6}
*/
void set_alternative_button_order_from_array(const std::vector<int>& new_order);
_IGNORE(gtk_dialog_set_alternative_button_order_from_array, gtk_dialog_set_alternative_button_order)
diff --git a/gtk/src/editable.hg b/gtk/src/editable.hg
index f032c59..5569ead 100644
--- a/gtk/src/editable.hg
+++ b/gtk/src/editable.hg
@@ -51,7 +51,7 @@ public:
_WRAP_METHOD(void set_editable(bool is_editable = true), gtk_editable_set_editable)
_WRAP_METHOD(bool get_editable() const, gtk_editable_get_editable)
- _WRAP_METHOD(void insert_text(const Glib::ustring& text, int length, int& position), gtk_editable_insert_text)
+ _WRAP_METHOD(void insert_text(const Glib::ustring& new_text, int new_text_length, int& position), gtk_editable_insert_text)
_WRAP_METHOD(void delete_text(int start_pos, int end_pos), gtk_editable_delete_text)
_WRAP_METHOD(Glib::ustring get_chars(int start_pos, int end_pos) const, gtk_editable_get_chars)
diff --git a/gtk/src/filechooser.hg b/gtk/src/filechooser.hg
index a0eca64..1423b7b 100644
--- a/gtk/src/filechooser.hg
+++ b/gtk/src/filechooser.hg
@@ -108,7 +108,7 @@ public:
_WRAP_METHOD(bool set_current_folder_uri(const Glib::ustring& uri), gtk_file_chooser_set_current_folder_uri)
_WRAP_METHOD(Glib::ustring get_current_folder_uri() const, gtk_file_chooser_get_current_folder_uri)
- _WRAP_METHOD(bool set_file(const Glib::RefPtr<const Gio::File>& uri), gtk_file_chooser_set_file, errthrow)
+ _WRAP_METHOD(bool set_file(const Glib::RefPtr<const Gio::File>& file), gtk_file_chooser_set_file, errthrow)
_WRAP_METHOD(bool select_file(const Glib::RefPtr<const Gio::File>& file), gtk_file_chooser_select_file, errthrow)
_WRAP_METHOD(void unselect_file(const Glib::RefPtr<const Gio::File>& file), gtk_file_chooser_unselect_file)
diff --git a/gtk/src/filechooserbutton.hg b/gtk/src/filechooserbutton.hg
index 134b23b..788c122 100644
--- a/gtk/src/filechooserbutton.hg
+++ b/gtk/src/filechooserbutton.hg
@@ -51,7 +51,6 @@ class FileChooserButton
public:
/** Creates a new file-selecting button widget with the default title.
- * @param title The title of the browse dialog.
* @param action The open mode for the widget.
*/
explicit FileChooserButton(FileChooserAction action = FILE_CHOOSER_ACTION_OPEN);
diff --git a/gtk/src/fontchooser.hg b/gtk/src/fontchooser.hg
index a5f236e..7aa1e56 100644
--- a/gtk/src/fontchooser.hg
+++ b/gtk/src/fontchooser.hg
@@ -65,9 +65,9 @@ public:
_WRAP_METHOD(void set_font_desc(const Pango::FontDescription& font_desc), gtk_font_chooser_set_font_desc)
_WRAP_METHOD(Glib::ustring get_font() const, gtk_font_chooser_get_font)
- _WRAP_METHOD(void set_font(const Glib::ustring& font), gtk_font_chooser_set_font)
+ _WRAP_METHOD(void set_font(const Glib::ustring& fontname), gtk_font_chooser_set_font)
_WRAP_METHOD(Glib::ustring get_preview_text() const, gtk_font_chooser_get_preview_text)
- _WRAP_METHOD(void set_preview_text(const Glib::ustring& fontname),gtk_font_chooser_set_preview_text)
+ _WRAP_METHOD(void set_preview_text(const Glib::ustring& text),gtk_font_chooser_set_preview_text)
_WRAP_METHOD(bool get_show_preview_entry() const, gtk_font_chooser_get_show_preview_entry)
_WRAP_METHOD(void set_show_preview_entry(bool show_preview_entry = true), gtk_font_chooser_set_show_preview_entry)
diff --git a/gtk/src/fontselection.hg b/gtk/src/fontselection.hg
index a48298e..264d5cb 100644
--- a/gtk/src/fontselection.hg
+++ b/gtk/src/fontselection.hg
@@ -81,7 +81,7 @@ public:
_WRAP_METHOD(Glib::ustring get_font_name() const, gtk_font_selection_get_font_name)
_WRAP_METHOD(bool set_font_name(const Glib::ustring& fontname), gtk_font_selection_set_font_name)
_WRAP_METHOD(Glib::ustring get_preview_text() const, gtk_font_selection_get_preview_text)
- _WRAP_METHOD(void set_preview_text(const Glib::ustring& fontname),gtk_font_selection_set_preview_text)
+ _WRAP_METHOD(void set_preview_text(const Glib::ustring& text),gtk_font_selection_set_preview_text)
//TODO: Remove these accessors when we can break ABI.
//They probably all return null now anyway.
@@ -115,7 +115,7 @@ public:
_WRAP_METHOD(bool set_font_name(const Glib::ustring& fontname),gtk_font_selection_dialog_set_font_name)
_WRAP_METHOD(Glib::ustring get_font_name() const, gtk_font_selection_dialog_get_font_name)
_WRAP_METHOD(Glib::ustring get_preview_text() const,gtk_font_selection_dialog_get_preview_text)
- _WRAP_METHOD(void set_preview_text(const Glib::ustring& fontname), gtk_font_selection_dialog_set_preview_text)
+ _WRAP_METHOD(void set_preview_text(const Glib::ustring& text), gtk_font_selection_dialog_set_preview_text)
_WRAP_METHOD(Button* get_ok_button(), gtk_font_selection_dialog_get_ok_button)
_WRAP_METHOD(const Button* get_ok_button() const, gtk_font_selection_dialog_get_ok_button, constversion)
diff --git a/gtk/src/gtk_docs_override.xml b/gtk/src/gtk_docs_override.xml
index acae7fd..36e8889 100644
--- a/gtk/src/gtk_docs_override.xml
+++ b/gtk/src/gtk_docs_override.xml
@@ -538,6 +538,10 @@ See also set_tooltip_column() for a simpler alternative.
See also Tooltip::set_tip_area().
</description>
<parameters>
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
+</parameter_description>
+</parameter>
<parameter name="tooltip">
<parameter_description>A Gtk::Tooltip.
</parameter_description>
@@ -1110,7 +1114,7 @@ as a pure output parameter.
The returned pixmap can be an empty RefPtr, if the resulting @clip_area was empty.
-
+Since: 2.14
</description>
<parameters>
<parameter name="widget">
@@ -1123,8 +1127,6 @@ The returned pixmap can be an empty RefPtr, if the resulting @clip_area was empt
</parameter>
</parameters>
<return> #GdkPixmap snapshot of the widget
-
-Since: 2.14
</return>
</function>
@@ -2432,7 +2434,7 @@ Since: 2.4
Gets the current folder of @chooser as a local filename.
See gtk_file_chooser_set_current_folder().
-
+Since: 2.4
</description>
<parameters>
<parameter name="chooser">
@@ -2445,8 +2447,6 @@ path cannot be represented as a local filename. This function may also return
and empty string if the file chooser was unable to load the last folder that was
requested from it; for example, as would be for calling
gtk_file_chooser_set_current_folder() on a nonexistent folder.
-
-Since: 2.4
</return>
</function>
@@ -2475,7 +2475,7 @@ folders..
Queries the list of shortcut folders in the file chooser, as set by
gtk_file_chooser_add_shortcut_folder_uri().
-
+Since: 2.4
</description>
<parameters>
<parameter name="chooser">
@@ -2484,8 +2484,6 @@ gtk_file_chooser_add_shortcut_folder_uri().
</parameter>
</parameters>
<return> A list of folder URIs
-
-Since: 2.4
</return>
</function>
@@ -2494,7 +2492,7 @@ Since: 2.4
Lists the current set of user-selectable filters; see
gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter().
-
+Since: 2.4
</description>
<parameters>
<parameter name="chooser">
@@ -2504,8 +2502,6 @@ gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter().
</parameters>
<return> a list containing the current set of
user selectable filters.
-
-Since: 2.4
</return>
</function>
@@ -2515,7 +2511,7 @@ Since: 2.4
Lists all the selected files and subfolders in the current folder of
@chooser. The returned names are full absolute URIs.
-
+Since: 2.4
</description>
<parameters>
<parameter name="chooser">
@@ -2525,8 +2521,6 @@ Lists all the selected files and subfolders in the current folder of
</parameters>
<return> a list containing the URIs of all selected
files and subfolders in the current folder.
-
-Since: 2.4
</return>
</function>
@@ -2538,7 +2532,7 @@ Lists all the selected files and subfolders in the current folder of
folder cannot be represented as local filenames they will be ignored. (See
gtk_file_chooser_get_uris())
-
+Since: 2.4
</description>
<parameters>
<parameter name="chooser">
@@ -2548,8 +2542,6 @@ gtk_file_chooser_get_uris())
</parameters>
<return> a list containing the filenames of all selected
files and subfolders in the current folder.
-
-Since: 2.4
</return>
</function>
@@ -2560,6 +2552,7 @@ The set of values for the context string is system dependent,
but will typically include such values as 'Applications' and
'MimeTypes'.
+Since: 2.4
</description>
<parameters>
<parameter name="icon_theme">
@@ -2573,8 +2566,6 @@ but will typically include such values as 'Applications' and
</parameters>
<return> The names of all the
icons in the theme.
-
-Since: 2.4
</return>
</function>
@@ -2733,6 +2724,7 @@ Since: 2.12
<description>
Return value: The program name.
+Since: 2.12
</description>
<parameters>
<parameter name="about">
@@ -2741,8 +2733,6 @@ Return value: The program name.
</parameter>
</parameters>
<return> The program name.
-
-Since: 2.12
</return>
</function>
@@ -2750,6 +2740,7 @@ Since: 2.12
<description>
Return value: The label used for the website link.
+Since: 2.6
</description>
<parameters>
<parameter name="about">
@@ -2758,8 +2749,6 @@ Return value: The label used for the website link.
</parameter>
</parameters>
<return> The label used for the website link.
-
-Since: 2.6
</return>
</function>
@@ -2769,7 +2758,7 @@ Since: 2.6
Get the original text entered by the user that triggered
the completion or an empty string if there's no completion ongoing.
-
+Since: 2.12
</description>
<parameters>
<parameter name="completion">
@@ -2778,8 +2767,6 @@ the completion or an empty string if there's no completion ongoing.
</parameter>
</parameters>
<return> the prefix for the current completion
-
-Since: 2.12
</return>
</function>
@@ -2819,7 +2806,7 @@ If @icon_names contains more than one name, this function
tries them all in the given order before falling back to
inherited icon themes.
-
+Since: 2.12
</description>
<parameters>
<parameter name="icon_theme">
@@ -2842,8 +2829,6 @@ inherited icon themes.
<return> a #GtkIconInfo structure containing information
about the icon. IconInfo::operator bool() will be false if the icon wasn't found -
for instance, if (icon_info) { ... }.
-
-Since: 2.12
</return>
</function>
@@ -2853,7 +2838,7 @@ Since: 2.12
Gets the list of contexts available within the current
hierarchy of icon themes.
-
+Since: 2.12
</description>
<parameters>
<parameter name="icon_theme">
@@ -2863,8 +2848,6 @@ hierarchy of icon themes.
</parameters>
<return> a list holding the names of all the
contexts in the theme.
-
-Since: 2.12
</return>
</function>
@@ -2980,6 +2963,7 @@ Since: 2.4
This function saves the information from @setup to @file_name.
@throws Glib::FileError
+Since: 2.12
</description>
<parameters>
<parameter name="setup">
@@ -2992,8 +2976,6 @@ This function saves the information from @setup to @file_name.
</parameter>
</parameters>
<return> %TRUE on success
-
-Since: 2.12
</return>
</function>
@@ -3003,6 +2985,7 @@ Since: 2.12
This function saves the print settings from @settings to @file_name.
@throws FileError
+Since: 2.12
</description>
<parameters>
<parameter name="settings">
@@ -3015,8 +2998,6 @@ This function saves the print settings from @settings to @file_name.
</parameter>
</parameters>
<return> %TRUE on success
-
-Since: 2.12
</return>
</function>
@@ -3043,6 +3024,7 @@ Since: 2.12
<description>
Return value: a list of cell renderers.
+Since: 2.12
</description>
<parameters>
<parameter name="cell_layout">
@@ -3051,8 +3033,6 @@ Return value: a list of cell renderers.
</parameter>
</parameters>
<return> a list of cell renderers.
-
-Since: 2.12
</return>
</function>
@@ -3084,7 +3064,7 @@ Since: 2.12
<description>
Gets the contents of the tooltip for @widget.
-
+Since: 2.12
</description>
<parameters>
<parameter name="widget">
@@ -3093,8 +3073,6 @@ Gets the contents of the tooltip for @widget.
</parameter>
</parameters>
<return> the tooltip text.
-
-Since: 2.12
</return>
</function>
@@ -3103,7 +3081,7 @@ Since: 2.12
<description>
Gets the contents of the tooltip for @widget.
-
+Since: 2.12
</description>
<parameters>
<parameter name="widget">
@@ -3112,8 +3090,6 @@ Gets the contents of the tooltip for @widget.
</parameter>
</parameters>
<return> the tooltip text.
-
-Since: 2.12
</return>
</function>
@@ -3125,7 +3101,7 @@ can then be rendered into a pixbuf using
gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon()
combines these two steps if all you need is the pixbuf.)
-
+Since: 2.4
</description>
<parameters>
<parameter name="icon_theme">
@@ -3148,8 +3124,6 @@ combines these two steps if all you need is the pixbuf.)
<return> an IconInfo structure containing information
about the icon. IconInfo::operator bool() will return false if the icon wasn't found.
For instance, if (icon_info) { ... }.
-
-Since: 2.4
</return>
</function>
@@ -3218,6 +3192,8 @@ See also gtk_editable_get_chars().
<function name="gtk_selection_data_get_uris">
<description>
Gets the contents of the selection data as a container of URIs.
+
+Since: 2.6
</description>
<parameters>
<parameter name="selection_data">
@@ -3227,8 +3203,6 @@ Gets the contents of the selection data as a container of URIs.
</parameters>
<return>If the selection data contains a list of
URIs, a container containing the URIs, otherwise an empty container.
-
-Since: 2.6
</return>
</function>
diff --git a/gtk/src/hvbox.hg b/gtk/src/hvbox.hg
index a56ac66..091ea32 100644
--- a/gtk/src/hvbox.hg
+++ b/gtk/src/hvbox.hg
@@ -49,6 +49,7 @@ public:
//TODO: Remove the homogoenous parameter as it was removed in gtk_box_new().
/** Creates a new vertical box.
+ * @param homogeneous <tt>true</tt> if all children are to be given equal space allotments.
* @param spacing Determines the space in pixels between child widgets.
*/
_WRAP_CTOR(VBox(bool homogeneous = false, int spacing = 0), gtk_vbox_new)
@@ -80,6 +81,7 @@ public:
//TODO: Remove the homogoenous parameter as it was removed in gtk_box_new().
/** Creates a new horizontal box.
+ * @param homogeneous <tt>true</tt> if all children are to be given equal space allotments.
* @param spacing Determines the space in pixels between child widgets.
*/
_WRAP_CTOR(HBox(bool homogeneous = false, int spacing = 0), gtk_hbox_new)
diff --git a/gtk/src/icontheme.hg b/gtk/src/icontheme.hg
index 200dc6e..dfc3302 100644
--- a/gtk/src/icontheme.hg
+++ b/gtk/src/icontheme.hg
@@ -77,7 +77,7 @@ public:
* @return A list holding the names of all the
* icons in the theme.
*
- * @newin{2,10}.
+ * @newin{2,10}
*/
std::vector<Glib::ustring> list_icons() const;
diff --git a/gtk/src/iconview.hg b/gtk/src/iconview.hg
index 7a18e86..81357e0 100644
--- a/gtk/src/iconview.hg
+++ b/gtk/src/iconview.hg
@@ -134,7 +134,7 @@ public:
*
* @param x The x position to be identified.
* @param y The y position to be identified.
- * @param path The path.
+ * @param cell The renderer responsible for the cell at (@a x, @a y).
*
* @result true if an item exists at the specified position.
*
@@ -268,7 +268,7 @@ public:
/** Gets information about the item that is highlighted for feedback.
*
* @param path The highlighted item.
- * @pos The drop position.
+ * @param pos The drop position.
*
* @newin{2,10}
*/
@@ -284,7 +284,7 @@ public:
/** Gets information about the item that is highlighted for feedback.
*
- * @pos The drop position.
+ * @param pos The drop position.
*
* @newin{2,10}
*/
diff --git a/gtk/src/main.hg b/gtk/src/main.hg
index c0e1dc7..8323a00 100644
--- a/gtk/src/main.hg
+++ b/gtk/src/main.hg
@@ -102,13 +102,11 @@ _DEPRECATE_IFDEF_START
* standard C++. (You might need to use const_cast<>, though.)
*
* This function automatically generates nicely formatted
- * <option>--help</option> output. Note that your program will
+ * <tt>--help</tt> output. Note that your program will
* be terminated after writing out the help output.
*
* @param argc a reference to the number of command line arguments.
* @param argv a reference to the array of command line arguments.
- * @parameter_string a string which is displayed in the first line of <option>--help</option> output,
- * after <literal><replaceable>programname</replaceable> [OPTION...]</literal>
* @param option_context A Glib::OptionContext containing Glib::OptionGroups which described the command-line arguments taken by your program.
*
* @throw Glib::OptionError
diff --git a/gtk/src/menu.hg b/gtk/src/menu.hg
index cec0f38..12294fb 100644
--- a/gtk/src/menu.hg
+++ b/gtk/src/menu.hg
@@ -33,7 +33,7 @@ class AccelGroup;
/** A drop-down menu consisting of Gtk::MenuItem objects which can be navigated and activated by the user to perform application functions.
* Menus are normally placed inside a Gtk::MenuBar or another MenuItem as a sub menu.
* A Menu can also be popped up, for instance as a right-click context menu, by calling the popup() method.
- * .
+ *
* @ingroup Widgets
* @ingroup Menus
*/
@@ -66,7 +66,7 @@ public:
* The @a activate_time parameter should be the time stamp of the event that
* initiated the popup. If such an event is not available, use
* gtk_get_current_event_time() instead.
- * @param func A position_calc_slot supplied function used to position the menu, or <tt>0</tt>.
+ * @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.
*/
@@ -139,7 +139,7 @@ protected:
//TODO: What does "attach" actually mean here? murrayc
/** Attaches the menu to the widget.
*
- * param @attach_widget: the Widget that the menu will be attached to.
+ * @param attach_widget The Widget that the menu will be attached to.
*
* @newin{2,10}
*/
diff --git a/gtk/src/menubutton.hg b/gtk/src/menubutton.hg
index 071cd5d..d11dd35 100644
--- a/gtk/src/menubutton.hg
+++ b/gtk/src/menubutton.hg
@@ -33,7 +33,7 @@ namespace Gtk
* provided Gtk::Arrow.
*
* @ingroup Widgets
- * @newin{3.6}
+ * @newin{3,6}
*/
class MenuButton : public ToggleButton
{
@@ -43,7 +43,7 @@ public:
_CTOR_DEFAULT
- _WRAP_METHOD(void set_menu(Menu& menu), gtk_menu_button_set_popup, deprecated "Use set_popup() instead.")
+ _WRAP_METHOD(void set_menu(Menu& popup), gtk_menu_button_set_popup, deprecated "Use set_popup() instead.")
_IGNORE(gtk_menu_button_set_menu)
/** Disables the button.
@@ -56,7 +56,7 @@ public:
_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& menu), gtk_menu_button_set_popup)
+ _WRAP_METHOD(void set_popup(Menu& popup), gtk_menu_button_set_popup)
_DEPRECATE_IFDEF_START
/** Disables the button.
diff --git a/gtk/src/menushell.hg b/gtk/src/menushell.hg
index 2327f12..8809814 100644
--- a/gtk/src/menushell.hg
+++ b/gtk/src/menushell.hg
@@ -47,9 +47,9 @@ class MenuShell : public Container
public:
_CUSTOM_DTOR()
- _WRAP_METHOD(void append(MenuItem& menu_item), gtk_menu_shell_append)
- _WRAP_METHOD(void prepend(MenuItem& menu_item), gtk_menu_shell_prepend)
- _WRAP_METHOD(void insert(MenuItem& menu_item, int position), gtk_menu_shell_insert)
+ _WRAP_METHOD(void append(MenuItem& child), gtk_menu_shell_append)
+ _WRAP_METHOD(void prepend(MenuItem& child), gtk_menu_shell_prepend)
+ _WRAP_METHOD(void insert(MenuItem& child, int position), gtk_menu_shell_insert)
_WRAP_METHOD(void select_item(MenuItem& menu_item), gtk_menu_shell_select_item)
_WRAP_METHOD(void deselect(), gtk_menu_shell_deselect)
diff --git a/gtk/src/messagedialog.hg b/gtk/src/messagedialog.hg
index dbc3e1b..19d9b99 100644
--- a/gtk/src/messagedialog.hg
+++ b/gtk/src/messagedialog.hg
@@ -59,7 +59,7 @@ public:
/** Sets the primary text of the message dialog.
*
- * @param text The message.
+ * @param message The message.
* @param use_markup Whether @a message contains pango markup.
*/
void set_message(const Glib::ustring& message, bool use_markup = false);
@@ -68,7 +68,7 @@ public:
/** Sets the secondary text of the message dialog.
* Note that setting a secondary text makes the primary text become bold, unless you have provided explicit markup.
*
- * @newin{2,6}.
+ * @newin{2,6}
*
* @param text The message.
* @param use_markup Whether @a message contains pango markup.
diff --git a/gtk/src/pagesetup.hg b/gtk/src/pagesetup.hg
index 28ee413..ded62d2 100644
--- a/gtk/src/pagesetup.hg
+++ b/gtk/src/pagesetup.hg
@@ -77,7 +77,7 @@ public:
static Glib::RefPtr<PageSetup> create_from_key_file(const Glib::KeyFile& key_file, const Glib::ustring& group_name);
_IGNORE(gtk_page_setup_new_from_key_file)
- /** Reads the page setup from the file @file_name. Returns a
+ /** Reads the page setup from the file @a file_name. Returns a
* new PageSetup object with the restored page setup,
* or an empty RefPtr if an error occurred. See save_to_file().
*
@@ -113,7 +113,7 @@ public:
_WRAP_METHOD(PaperSize get_paper_size(), gtk_page_setup_get_paper_size)
_WRAP_METHOD(const PaperSize get_paper_size() const, gtk_page_setup_get_paper_size, constversion)
- _WRAP_METHOD(void set_paper_size(const PaperSize& paper_size), gtk_page_setup_set_paper_size)
+ _WRAP_METHOD(void set_paper_size(const PaperSize& size), gtk_page_setup_set_paper_size)
_WRAP_METHOD(double get_top_margin(Unit unit) const, gtk_page_setup_get_top_margin)
_WRAP_METHOD(void set_top_margin(double margin, Unit unit), gtk_page_setup_set_top_margin)
@@ -127,7 +127,7 @@ public:
_WRAP_METHOD(double get_right_margin(Unit unit) const, gtk_page_setup_get_right_margin)
_WRAP_METHOD(void set_right_margin(double margin, Unit unit), gtk_page_setup_set_right_margin)
- _WRAP_METHOD(void set_paper_size_and_default_margins(const PaperSize& paper_size),
+ _WRAP_METHOD(void set_paper_size_and_default_margins(const PaperSize& size),
gtk_page_setup_set_paper_size_and_default_margins)
_WRAP_METHOD(double get_paper_width(Unit unit) const, gtk_page_setup_get_paper_width)
diff --git a/gtk/src/printer.hg b/gtk/src/printer.hg
index 3d45187..89f9d7c 100644
--- a/gtk/src/printer.hg
+++ b/gtk/src/printer.hg
@@ -125,8 +125,8 @@ inline bool operator!=(const Glib::RefPtr<Printer>& lhs, const Glib::RefPtr<Prin
typedef sigc::slot< bool, const Glib::RefPtr<Printer>& > SlotPrinterEnumerator;
/** Calls a function for all Printers. If the callback returns true, the enumeration is stopped.
- * @slot A function to call for each printer
- * @parm wait If true, wait in a recursive mainloop until all printers are enumerated; otherwise return early.
+ * @param slot A function to call for each printer
+ * @param wait If true, wait in a recursive mainloop until all printers are enumerated; otherwise return early.
*
* @relates Gtk::Printer
*/
diff --git a/gtk/src/printoperation.hg b/gtk/src/printoperation.hg
index 8d576e2..b9db086 100644
--- a/gtk/src/printoperation.hg
+++ b/gtk/src/printoperation.hg
@@ -190,7 +190,7 @@ public:
*
* @param parent Transient parent.
* @param page_setup An existing GtkPageSetup.
- * @param settings Print settings.
+ * @param print_settings Print settings.
* @result A new PageSetup object.
*
* @since 2.10
@@ -207,7 +207,7 @@ public:
* See run_page_setup_dialog_async() if this is a problem.
*
* @param parent Transient parent.
- * @param settings Print settings.
+ * @param print_settings Print settings.
* @result A new PageSetup object.
*
* @since 2.22
@@ -228,7 +228,7 @@ public:
*
* @param parent Transient parent.
* @param page_setup An existing GtkPageSetup.
- * @param settings Print settings.
+ * @param print_settings Print settings.
* @result A new PageSetup object.
* @param slot
*
@@ -246,8 +246,7 @@ public:
* signal handler for the ::response signal of the dialog.
*
* @param parent Transient parent.
- * @param page_setup An existing GtkPageSetup.
- * @param settings Print settings.
+ * @param print_settings Print settings.
* @result A new PageSetup object.
* @param slot
*
diff --git a/gtk/src/printsettings.hg b/gtk/src/printsettings.hg
index 06de81a..0344245 100644
--- a/gtk/src/printsettings.hg
+++ b/gtk/src/printsettings.hg
@@ -209,7 +209,7 @@ public:
// helpers:
_WRAP_METHOD(Glib::ustring get_printer() const, gtk_print_settings_get_printer)
- _WRAP_METHOD(void set_printer(const Glib::ustring& name), gtk_print_settings_set_printer)
+ _WRAP_METHOD(void set_printer(const Glib::ustring& printer), gtk_print_settings_set_printer)
_WRAP_METHOD(PageOrientation get_orientation() const, gtk_print_settings_get_orientation)
_WRAP_METHOD(void set_orientation(PageOrientation orientation), gtk_print_settings_set_orientation)
@@ -260,7 +260,7 @@ public:
_WRAP_METHOD(void set_scale(double scale), gtk_print_settings_set_scale)
_WRAP_METHOD(PrintPages get_print_pages() const, gtk_print_settings_get_print_pages)
- _WRAP_METHOD(void set_print_pages(PrintPages print_pages), gtk_print_settings_set_print_pages)
+ _WRAP_METHOD(void set_print_pages(PrintPages pages), gtk_print_settings_set_print_pages)
//TODO: Move this out of the class when we can break ABI,
//because this is also used in PringJob.
diff --git a/gtk/src/printunixdialog.hg b/gtk/src/printunixdialog.hg
index a765d09..edccc88 100644
--- a/gtk/src/printunixdialog.hg
+++ b/gtk/src/printunixdialog.hg
@@ -63,7 +63,7 @@ public:
_WRAP_METHOD(void set_current_page(int current_page), gtk_print_unix_dialog_set_current_page)
_WRAP_METHOD(int get_current_page() const, gtk_print_unix_dialog_get_current_page)
- _WRAP_METHOD(void set_settings(const Glib::RefPtr<PrintSettings>& print_settings), gtk_print_unix_dialog_set_settings)
+ _WRAP_METHOD(void set_settings(const Glib::RefPtr<PrintSettings>& settings), gtk_print_unix_dialog_set_settings)
_WRAP_METHOD(Glib::RefPtr<PrintSettings> get_settings(), gtk_print_unix_dialog_get_settings, refreturn)
_WRAP_METHOD(Glib::RefPtr<const PrintSettings> get_settings() const, gtk_print_unix_dialog_get_settings, refreturn, constversion)
diff --git a/gtk/src/recentinfo.hg b/gtk/src/recentinfo.hg
index b7d0f21..1a72486 100644
--- a/gtk/src/recentinfo.hg
+++ b/gtk/src/recentinfo.hg
@@ -64,7 +64,7 @@ public:
_WRAP_METHOD_DOCS_ONLY(gtk_recent_info_get_application_info)
bool get_application_info(const Glib::ustring& app_name, std::string& app_exec,
- guint& count, std::time_t& time_) const;
+ guint& count, std::time_t& time) const;
_WRAP_METHOD_DOCS_ONLY(gtk_recent_info_get_applications)
std::vector<Glib::ustring> get_applications() const;
@@ -76,7 +76,7 @@ public:
_WRAP_METHOD_DOCS_ONLY(gtk_recent_info_get_groups)
std::vector<Glib::ustring> get_groups() const;
- _WRAP_METHOD(bool has_group(const Glib::ustring& group) const, gtk_recent_info_has_group)
+ _WRAP_METHOD(bool has_group(const Glib::ustring& group_name) const, gtk_recent_info_has_group)
_WRAP_METHOD(Glib::RefPtr<Gdk::Pixbuf> get_icon(int size),
gtk_recent_info_get_icon, refreturn)
@@ -97,7 +97,7 @@ public:
#m4begin
_CONVERSION(`const RecentInfo&',`GtkRecentInfo*', `const_cast<GtkRecentInfo*>(($3).gobj())')
#m4end
- _WRAP_METHOD(bool equal(const RecentInfo& b) const, gtk_recent_info_match)
+ _WRAP_METHOD(bool equal(const RecentInfo& info_b) const, gtk_recent_info_match)
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
diff --git a/gtk/src/scrollable.hg b/gtk/src/scrollable.hg
index 985004c..4442f0d 100644
--- a/gtk/src/scrollable.hg
+++ b/gtk/src/scrollable.hg
@@ -56,7 +56,7 @@ public:
_WRAP_METHOD(Glib::RefPtr<Adjustment> get_vadjustment(), gtk_scrollable_get_vadjustment, refreturn)
_WRAP_METHOD(Glib::RefPtr<const Adjustment> get_vadjustment() const, gtk_scrollable_get_vadjustment, refreturn, constversoin)
- _WRAP_METHOD(void set_vadjustment(const Glib::RefPtr<Adjustment>& hadjustment), gtk_scrollable_set_vadjustment)
+ _WRAP_METHOD(void set_vadjustment(const Glib::RefPtr<Adjustment>& vadjustment), gtk_scrollable_set_vadjustment)
/** This method removes the vadjustment.
* @see set_vadjustment().
diff --git a/gtk/src/textmark.hg b/gtk/src/textmark.hg
index e5dbc78..8e85195 100644
--- a/gtk/src/textmark.hg
+++ b/gtk/src/textmark.hg
@@ -68,8 +68,7 @@ protected:
* right of newly-inserted text. The standard left-to-right cursor is a
* mark with right gravity (when you type, the cursor stays on the right
* side of the text you're typing).
-
- * @param name mark name.
+ *
* @param left_gravity Whether the mark should have left gravity.
* @newin{2,12}
*/
@@ -83,7 +82,7 @@ protected:
* right of newly-inserted text. The standard left-to-right cursor is a
* mark with right gravity (when you type, the cursor stays on the right
* side of the text you're typing).
-
+ *
* @param name mark name.
* @param left_gravity Whether the mark should have left gravity.
* @newin{2,12}
@@ -100,8 +99,7 @@ public:
* right of newly-inserted text. The standard left-to-right cursor is a
* mark with right gravity (when you type, the cursor stays on the right
* side of the text you're typing).
-
- * @param name mark name.
+ *
* @param left_gravity Whether the mark should have left gravity.
* @result A RefPtr to a new text mark.
* @newin{2,12}
@@ -116,7 +114,7 @@ public:
* right of newly-inserted text. The standard left-to-right cursor is a
* mark with right gravity (when you type, the cursor stays on the right
* side of the text you're typing).
-
+ *
* @param name mark name.
* @param left_gravity Whether the mark should have left gravity.
* @result A RefPtr to a new text mark.
diff --git a/gtk/src/tooltip.hg b/gtk/src/tooltip.hg
index 5761669..ed3f15c 100644
--- a/gtk/src/tooltip.hg
+++ b/gtk/src/tooltip.hg
@@ -82,7 +82,7 @@ public:
*/
void unset_markup();
- _WRAP_METHOD(void set_text(const Glib::ustring& markup), gtk_tooltip_set_text)
+ _WRAP_METHOD(void set_text(const Glib::ustring& text), gtk_tooltip_set_text)
/** Hide the label.
* @newin{3,2}
@@ -90,7 +90,7 @@ public:
void unset_text();
_WRAP_METHOD(void set_icon(const Glib::RefPtr<Gdk::Pixbuf>& pixbuf), gtk_tooltip_set_icon)
- _WRAP_METHOD(void set_icon(const Glib::RefPtr<Gio::Icon>& icon, IconSize size), gtk_tooltip_set_icon_from_gicon)
+ _WRAP_METHOD(void set_icon(const Glib::RefPtr<Gio::Icon>& gicon, IconSize size), gtk_tooltip_set_icon_from_gicon)
//TODO: Remove the _from_*() suffixes?
_WRAP_METHOD(void set_icon_from_stock(const StockID& stock_id, IconSize size), gtk_tooltip_set_icon_from_stock)
diff --git a/gtk/src/treeiter.hg b/gtk/src/treeiter.hg
index 2c21f9e..6b99e91 100644
--- a/gtk/src/treeiter.hg
+++ b/gtk/src/treeiter.hg
@@ -238,7 +238,7 @@ public:
* This is a templated method, so the compiler will not allow you to provide an inappropriate type
* of data for the model column.
*
- * This is just a more convient syntax that does the same thing as set_value() and get_value().
+ * This is just a more convenient syntax that does the same thing as set_value() and get_value().
*
* @param column The model column..
*/
@@ -273,7 +273,7 @@ public:
* See also operator[].
*
* @param column The model column.
- * @result The new value to use for this column of this row.
+ * @result The value of this column of this row
*/
template <class ColumnType>
ColumnType get_value(const TreeModelColumn<ColumnType>& column) const;
@@ -281,8 +281,8 @@ public:
/** Use get_value(const TreeModelColumn<>& column) unless
* you do not know the column type at compile-time.
* If the @a data output argument is of an inappropriate C++ type then this might fail at runtime.
- * @param column The number of the column whose value you want to change.
- * @result data An output argument which will contain the value of this column of this row.
+ * @param column The number of the column whose value you want to query.
+ * @param[out] data An output argument which will contain the value of this column of this row.
*/
template <class ColumnType>
void get_value(int column, ColumnType& data) const;
diff --git a/gtk/src/widget.hg b/gtk/src/widget.hg
index 8f7bd01..8648acc 100644
--- a/gtk/src/widget.hg
+++ b/gtk/src/widget.hg
@@ -522,7 +522,7 @@ public:
_IGNORE(gtk_draw_insertion_cursor)
// Gtk+ 2.12 tooltip API
- _WRAP_METHOD(void set_tooltip_window(Window& widget), gtk_widget_set_tooltip_window)
+ _WRAP_METHOD(void set_tooltip_window(Window& custom_window), gtk_widget_set_tooltip_window)
_WRAP_METHOD(Window* get_tooltip_window(), gtk_widget_get_tooltip_window)
_WRAP_METHOD(void trigger_tooltip_query(), gtk_widget_trigger_tooltip_query)
_WRAP_METHOD(void set_tooltip_text(const Glib::ustring& text), gtk_widget_set_tooltip_text)
diff --git a/gtk/src/window.hg b/gtk/src/window.hg
index a33cce3..e93b6df 100644
--- a/gtk/src/window.hg
+++ b/gtk/src/window.hg
@@ -378,7 +378,7 @@ dnl
*/
void unset_application();
- _WRAP_METHOD(void set_has_resize_grip(bool setting = true), gtk_window_set_has_resize_grip)
+ _WRAP_METHOD(void set_has_resize_grip(bool value = true), gtk_window_set_has_resize_grip)
_WRAP_METHOD(bool get_has_resize_grip() const, gtk_window_get_has_resize_grip)
_WRAP_METHOD(bool get_resize_grip_is_visible() const, gtk_window_resize_grip_is_visible)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
