From e317d75b171ebed90ebf04230086ca20c491c26d Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Mon, 27 May 2024 22:21:29 +0200 Subject: [PATCH] Fix YTK doxygen errors --- libs/tk/ydkmm/ydkmm/gdkmm/color.h | 2 +- libs/tk/ydkmm/ydkmm/gdkmm/device.h | 6 +++--- libs/tk/ydkmm/ydkmm/gdkmm/dragcontext.h | 2 +- libs/tk/ydkmm/ydkmm/gdkmm/drawable.h | 2 +- libs/tk/ydkmm/ydkmm/gdkmm/gc.h | 2 +- libs/tk/ydkmm/ydkmm/gdkmm/rectangle.h | 2 +- libs/tk/ydkmm/ydkmm/gdkmm/region.h | 2 +- libs/tk/ydkmm/ydkmm/gdkmm/screen.h | 2 +- libs/tk/ydkmm/ydkmm/gdkmm/visual.h | 6 +++--- libs/tk/ydkmm/ydkmm/gdkmm/window.h | 8 ++------ libs/tk/ytk/ytk/gtk/gtkaboutdialog.h | 2 +- libs/tk/ytk/ytk/gtk/gtkimage.h | 4 ++-- libs/tk/ytk/ytk/gtk/gtkwidget.h | 10 +++++----- libs/tk/ytkmm/ytkmm/gtkmm/aboutdialog.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/accelmap.h | 4 ++-- libs/tk/ytkmm/ytkmm/gtkmm/actiongroup.h | 8 ++++---- libs/tk/ytkmm/ytkmm/gtkmm/arrow.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/box.h | 4 ++-- libs/tk/ytkmm/ytkmm/gtkmm/builder.h | 12 ++++++------ libs/tk/ytkmm/ytkmm/gtkmm/button.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/buttonbox.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/cellrenderer.h | 2 +- libs/tk/ytkmm/ytkmm/gtkmm/cellrendereraccel.h | 5 ++--- libs/tk/ytkmm/ytkmm/gtkmm/cellview.h | 3 +-- libs/tk/ytkmm/ytkmm/gtkmm/checkbutton.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/clipboard.h | 4 ++-- libs/tk/ytkmm/ytkmm/gtkmm/colorbutton.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/colorselection.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/combobox.h | 6 ------ libs/tk/ytkmm/ytkmm/gtkmm/comboboxentry.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/comboboxentrytext.h | 2 +- libs/tk/ytkmm/ytkmm/gtkmm/comboboxtext.h | 4 ++-- libs/tk/ytkmm/ytkmm/gtkmm/dialog.h | 9 ++++----- libs/tk/ytkmm/ytkmm/gtkmm/editable.h | 4 ++-- libs/tk/ytkmm/ytkmm/gtkmm/entry.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/entrycompletion.h | 4 ++-- libs/tk/ytkmm/ytkmm/gtkmm/eventbox.h | 4 ++-- libs/tk/ytkmm/ytkmm/gtkmm/filechooser.h | 4 ++-- libs/tk/ytkmm/ytkmm/gtkmm/filechooserbutton.h | 5 ----- libs/tk/ytkmm/ytkmm/gtkmm/filechooserdialog.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/fontbutton.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/fontselection.h | 7 ++----- libs/tk/ytkmm/ytkmm/gtkmm/frame.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/iconview.h | 10 +++++----- libs/tk/ytkmm/ytkmm/gtkmm/image.h | 5 +---- libs/tk/ytkmm/ytkmm/gtkmm/infobar.h | 5 +---- libs/tk/ytkmm/ytkmm/gtkmm/label.h | 8 +++----- libs/tk/ytkmm/ytkmm/gtkmm/linkbutton.h | 2 -- libs/tk/ytkmm/ytkmm/gtkmm/liststore.h | 3 +-- libs/tk/ytkmm/ytkmm/gtkmm/main.h | 4 +--- libs/tk/ytkmm/ytkmm/gtkmm/menu.h | 6 +++--- libs/tk/ytkmm/ytkmm/gtkmm/menubar.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/messagedialog.h | 5 +---- libs/tk/ytkmm/ytkmm/gtkmm/notebook.h | 5 +---- libs/tk/ytkmm/ytkmm/gtkmm/progressbar.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/radiobutton.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/recentaction.h | 4 ++-- libs/tk/ytkmm/ytkmm/gtkmm/recentchooser.h | 2 +- libs/tk/ytkmm/ytkmm/gtkmm/recentchooserdialog.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/recentinfo.h | 6 +++--- libs/tk/ytkmm/ytkmm/gtkmm/scale.h | 6 ------ libs/tk/ytkmm/ytkmm/gtkmm/scrollbar.h | 6 ------ libs/tk/ytkmm/ytkmm/gtkmm/separator.h | 6 ------ libs/tk/ytkmm/ytkmm/gtkmm/spinbutton.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/statusbar.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/table.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/textiter.h | 4 ++-- libs/tk/ytkmm/ytkmm/gtkmm/textmark.h | 4 +--- libs/tk/ytkmm/ytkmm/gtkmm/textview.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/toggletoolbutton.h | 3 --- libs/tk/ytkmm/ytkmm/gtkmm/toolbar.h | 6 +++--- libs/tk/ytkmm/ytkmm/gtkmm/toolitem.h | 4 ++-- libs/tk/ytkmm/ytkmm/gtkmm/tooltip.h | 4 ++-- libs/tk/ytkmm/ytkmm/gtkmm/treeiter.h | 3 +++ libs/tk/ytkmm/ytkmm/gtkmm/treemodelfilter.h | 2 +- libs/tk/ytkmm/ytkmm/gtkmm/treemodelsort.h | 4 +--- libs/tk/ytkmm/ytkmm/gtkmm/treepath.h | 4 ++-- libs/tk/ytkmm/ytkmm/gtkmm/treeselection.h | 2 +- libs/tk/ytkmm/ytkmm/gtkmm/treeview.h | 15 ++++++++------- libs/tk/ytkmm/ytkmm/gtkmm/uimanager.h | 10 +++++----- libs/tk/ytkmm/ytkmm/gtkmm/widget.h | 11 +++++------ 81 files changed, 119 insertions(+), 241 deletions(-) diff --git a/libs/tk/ydkmm/ydkmm/gdkmm/color.h b/libs/tk/ydkmm/ydkmm/gdkmm/color.h index b796df16d1..608955ed53 100644 --- a/libs/tk/ydkmm/ydkmm/gdkmm/color.h +++ b/libs/tk/ydkmm/ydkmm/gdkmm/color.h @@ -212,7 +212,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/libs/tk/ydkmm/ydkmm/gdkmm/device.h b/libs/tk/ydkmm/ydkmm/gdkmm/device.h index adbaeaa312..35c7de3202 100644 --- a/libs/tk/ydkmm/ydkmm/gdkmm/device.h +++ b/libs/tk/ydkmm/ydkmm/gdkmm/device.h @@ -187,16 +187,16 @@ public: * @param keyval Return value for the keyval. * @param modifiers Return value for modifiers. */ - void get_key(guint index_, guint& keyval, ModifierType& modifiers) const; + void get_key(guint index, guint& keyval, ModifierType& modifiers) const; - void set_key(guint index_, guint keyval, ModifierType modifiers); + void set_key(guint index, guint keyval, ModifierType modifiers); /** Returns the axis use for @a index. * * @param index The index of the axis. * @return A Gdk::AxisUse specifying how the axis is used. */ - AxisUse get_axis_use(guint index_) const; + AxisUse get_axis_use(guint index) const; void set_axis_use(guint index_, AxisUse use); diff --git a/libs/tk/ydkmm/ydkmm/gdkmm/dragcontext.h b/libs/tk/ydkmm/ydkmm/gdkmm/dragcontext.h index 6cabac714c..d480ae2142 100644 --- a/libs/tk/ydkmm/ydkmm/gdkmm/dragcontext.h +++ b/libs/tk/ydkmm/ydkmm/gdkmm/dragcontext.h @@ -285,7 +285,7 @@ public: /** 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 time The timestamp from the "drag_data_drop" signal. */ void drag_finish(bool success, bool del, guint32 time); //Gtk::Widget* get_source_widget() - see Gtk::Widget::drag_get_source_widget() diff --git a/libs/tk/ydkmm/ydkmm/gdkmm/drawable.h b/libs/tk/ydkmm/ydkmm/gdkmm/drawable.h index d337f71427..05d7f261b8 100644 --- a/libs/tk/ydkmm/ydkmm/gdkmm/drawable.h +++ b/libs/tk/ydkmm/ydkmm/gdkmm/drawable.h @@ -436,7 +436,7 @@ public: * @param n_segs The number of line segments to draw, i.e. the size of the * @a segs array. */ - void draw_segments(const Glib::RefPtr& gc, GdkSegment* segs, int nsegs); + void draw_segments(const Glib::RefPtr& gc, GdkSegment* segs, int n_segs); #endif // GDKMM_DISABLE_DEPRECATED // TODO diff --git a/libs/tk/ydkmm/ydkmm/gdkmm/gc.h b/libs/tk/ydkmm/ydkmm/gdkmm/gc.h index b2e072cdb9..2799f4b9b5 100644 --- a/libs/tk/ydkmm/ydkmm/gdkmm/gc.h +++ b/libs/tk/ydkmm/ydkmm/gdkmm/gc.h @@ -602,7 +602,7 @@ public: * Deprecated: 2.22: Use the Cairo functions cairo_set_line_width(), * cairo_set_line_join(), cairo_set_line_cap() and cairo_set_dash() * to affect the stroking behavior in Cairo. Keep in mind that the default - * attributes of a #cairo_t are different from the default attributes of + * attributes of a cairo_t are different from the default attributes of * a Gdk::GC. * * @param line_width The width of lines. diff --git a/libs/tk/ydkmm/ydkmm/gdkmm/rectangle.h b/libs/tk/ydkmm/ydkmm/gdkmm/rectangle.h index 01ed85767c..7e123d1ac1 100644 --- a/libs/tk/ydkmm/ydkmm/gdkmm/rectangle.h +++ b/libs/tk/ydkmm/ydkmm/gdkmm/rectangle.h @@ -102,7 +102,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/libs/tk/ydkmm/ydkmm/gdkmm/region.h b/libs/tk/ydkmm/ydkmm/gdkmm/region.h index 7730b9aba1..94961e511b 100644 --- a/libs/tk/ydkmm/ydkmm/gdkmm/region.h +++ b/libs/tk/ydkmm/ydkmm/gdkmm/region.h @@ -205,7 +205,7 @@ public: /** Tests whether a rectangle is within a region. * - * @param rectangle A Gdk::Rectangle. + * @param rect A Gdk::Rectangle. * @return Gdk::OVERLAP_RECTANGLE_IN, Gdk::OVERLAP_RECTANGLE_OUT, or * Gdk::OVERLAP_RECTANGLE_PART, depending on whether the rectangle is inside, * outside, or partly inside the Gdk::Region, respectively. diff --git a/libs/tk/ydkmm/ydkmm/gdkmm/screen.h b/libs/tk/ydkmm/ydkmm/gdkmm/screen.h index 3e6295e2a1..fcfda1554e 100644 --- a/libs/tk/ydkmm/ydkmm/gdkmm/screen.h +++ b/libs/tk/ydkmm/ydkmm/gdkmm/screen.h @@ -481,7 +481,7 @@ public: * default set of font options does not affect contexts that * have already been created. * - * @param options A #cairo_font_options_t, or 0 to unset any + * @param options A cairo_font_options_t, or 0 to unset any * previously set default font options. */ void set_font_options(const Cairo::FontOptions& options); diff --git a/libs/tk/ydkmm/ydkmm/gdkmm/visual.h b/libs/tk/ydkmm/ydkmm/gdkmm/visual.h index 4c432121f3..182563bff8 100644 --- a/libs/tk/ydkmm/ydkmm/gdkmm/visual.h +++ b/libs/tk/ydkmm/ydkmm/gdkmm/visual.h @@ -273,7 +273,7 @@ public: * to be in position (according to the "mask"). Finally, "precision" refers * to how much precision the pixel value contains for a particular primary. * - * @param mask A pointer to a #guint32 to be filled in, or 0. + * @param mask A pointer to a guint32 to be filled in, or 0. * @param shift A pointer to a int to be filled in, or 0. * @param precision A pointer to a int to be filled in, or 0. */ @@ -285,7 +285,7 @@ public: * to be in position (according to the "mask"). Finally, "precision" refers * to how much precision the pixel value contains for a particular primary. * - * @param mask A pointer to a #guint32 to be filled in, or 0. + * @param mask A pointer to a guint32 to be filled in, or 0. * @param shift A pointer to a int to be filled in, or 0. * @param precision A pointer to a int to be filled in, or 0. */ @@ -297,7 +297,7 @@ public: * to be in position (according to the "mask"). Finally, "precision" refers * to how much precision the pixel value contains for a particular primary. * - * @param mask A pointer to a #guint32 to be filled in, or 0. + * @param mask A pointer to a guint32 to be filled in, or 0. * @param shift A pointer to a int to be filled in, or 0. * @param precision A pointer to a int to be filled in, or 0. */ diff --git a/libs/tk/ydkmm/ydkmm/gdkmm/window.h b/libs/tk/ydkmm/ydkmm/gdkmm/window.h index 8cd0cfeaaa..d951bb5bef 100644 --- a/libs/tk/ydkmm/ydkmm/gdkmm/window.h +++ b/libs/tk/ydkmm/ydkmm/gdkmm/window.h @@ -1127,8 +1127,7 @@ public: * and an expose event is emitted on the parent of the composited * window. It is the responsibility of the parent's expose handler * to manually merge the off-screen content onto the screen in - * whatever way it sees fit. See - * for an example. + * whatever way it sees fit. * * It only makes sense for child windows to be composited; see * set_opacity() if you need translucent toplevel @@ -1586,14 +1585,13 @@ public: * Gdk::EventConfigure. get_position() in contrast gets the * position from the most recent configure event. * - * + * \note * If @a window is not a toplevel, it is much better * to call get_position() and Gdk::Drawable::get_size() instead, * because it avoids the roundtrip to the X server and because * Gdk::Drawable::get_size() supports the full 32-bit coordinate space, * whereas get_geometry() is restricted to the 16-bit * coordinates of X11. - * * * @param x Return location for X coordinate of window (relative to its parent). * @param y Return location for Y coordinate of window (relative to its parent). @@ -2134,7 +2132,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. */ @@ -2529,7 +2526,6 @@ public: * signal on the @a embedder and the Gdk::Window::signal_to_embedder() and * Gdk::Window::signal_from_embedder() signals on @a window. * - * @param window A Gdk::Window. * @param embedder The Gdk::Window that @a window gets embedded in. */ void set_offscreen_embedder(const Glib::RefPtr& embedder); diff --git a/libs/tk/ytk/ytk/gtk/gtkaboutdialog.h b/libs/tk/ytk/ytk/gtk/gtkaboutdialog.h index 53e231c300..aef5f40386 100644 --- a/libs/tk/ytk/ytk/gtk/gtkaboutdialog.h +++ b/libs/tk/ytk/ytk/gtk/gtkaboutdialog.h @@ -46,7 +46,7 @@ typedef struct _GtkAboutDialogClass GtkAboutDialogClass; /** * GtkAboutDialog: * - * The \struct GtkAboutDialog struct contains + * The struct GtkAboutDialog struct contains * only private fields and should not be directly accessed. */ struct _GtkAboutDialog diff --git a/libs/tk/ytk/ytk/gtk/gtkimage.h b/libs/tk/ytk/ytk/gtk/gtkimage.h index 28a252e062..167ea90235 100644 --- a/libs/tk/ytk/ytk/gtk/gtkimage.h +++ b/libs/tk/ytk/ytk/gtk/gtkimage.h @@ -109,10 +109,10 @@ struct _GtkImageGIconData * @param GTK_IMAGE_EMPTY: there is no image displayed by the widget * @param GTK_IMAGE_PIXMAP: the widget contains a #GdkPixmap * @param GTK_IMAGE_IMAGE: the widget contains a #GdkImage - * @param GTK_IMAGE_PIXBUF: the widget contains a #GdkPixbuf + * @param GTK_IMAGE_PIXBUF: the widget contains a GdkPixbuf * @param GTK_IMAGE_STOCK: the widget contains a stock icon name * @param GTK_IMAGE_ICON_SET: the widget contains a #GtkIconSet - * @param GTK_IMAGE_ANIMATION: the widget contains a #GdkPixbufAnimation + * @param GTK_IMAGE_ANIMATION: the widget contains a GdkPixbufAnimation * @param GTK_IMAGE_ICON_NAME: the widget contains a named icon. * This image type was added in GTK+ 2.6 * @param GTK_IMAGE_GICON: the widget contains a GIcon. diff --git a/libs/tk/ytk/ytk/gtk/gtkwidget.h b/libs/tk/ytk/ytk/gtk/gtkwidget.h index f18fa0d5eb..d26cd4d077 100644 --- a/libs/tk/ytk/ytk/gtk/gtkwidget.h +++ b/libs/tk/ytk/ytk/gtk/gtkwidget.h @@ -44,7 +44,7 @@ G_BEGIN_DECLS /** * GtkWidgetFlags: * @param GTK_TOPLEVEL: widgets without a real parent, as there are #GtkWindow and - * #GtkMenus have this flag set throughout their lifetime. + * #GtkMenu have this flag set throughout their lifetime. * Toplevel widgets always contain their own #GdkWindow. * @param GTK_NO_WINDOW: Indicative for a widget that does not provide its own #GdkWindow. * Visible action (e.g. drawing) is performed on the parent's #GdkWindow. @@ -85,13 +85,13 @@ G_BEGIN_DECLS * @param GTK_APP_PAINTABLE: Set and unset by gtk_widget_set_app_paintable(). * Must be set on widgets whose window the application directly draws on, * in order to keep GTK+ from overwriting the drawn stuff. See - * #app-paintable-widgets for a detailed + * app-paintable-widgets for a detailed * description of this flag. * @param GTK_RECEIVES_DEFAULT: The widget when focused will receive the default action and have * %GTK_HAS_DEFAULT set even if there is a different widget set as default. * @param GTK_DOUBLE_BUFFERED: Set and unset by gtk_widget_set_double_buffered(). * Indicates that exposes done on the widget should be - * double-buffered. #double-buffering" for a + * double-buffered. See "double-buffering" for a * detailed discussion of how double-buffering works in GTK+ and * why you may want to disable it for special cases. * @param GTK_NO_SHOW_ALL: @@ -493,7 +493,7 @@ typedef struct _GtkWindow GtkWindow; * * A GtkAllocation of a widget represents region which has been allocated to the * widget by its parent. It is a subregion of its parents allocation. See - * #size-allocation for more information. + * size-allocation for more information. */ typedef GdkRectangle GtkAllocation; @@ -514,7 +514,7 @@ typedef void (*GtkCallback) (GtkWidget *widget, * @param height: the widget's desired height * * A GtkRequisition represents the desired size of a widget. See - * #size-requisition for more information. + * size-requisition for more information. */ struct _GtkRequisition { diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/aboutdialog.h b/libs/tk/ytkmm/ytkmm/gtkmm/aboutdialog.h index c3610de726..6d233ff078 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/aboutdialog.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/aboutdialog.h @@ -54,9 +54,6 @@ namespace Gtk * for , 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: - * @image html aboutdialog1.png - * * @ingroup Dialogs */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/accelmap.h b/libs/tk/ytkmm/ytkmm/gtkmm/accelmap.h index 0aca40649a..776b8400f4 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/accelmap.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/accelmap.h @@ -41,8 +41,8 @@ namespace AccelMap * with the canonical accel_key and accel_mods for this path. * To change the accelerator during runtime programatically, use * change_entry(). - * The accelerator path must consist of "/Category1/Category2/.../Action", - * where should be a unique application-specific identifier, that + * The accelerator path must consist of "<WINDOWTYPE>/Category1/Category2/.../Action", + * where <void on_my_%disconnect_proxy(const Glib::RefPtr& action, Widget* proxy) * */ @@ -256,7 +256,7 @@ public: * * @param action the action * - * @paragraph Slot Prototype: + * \par Slot Prototype: * void on_my_%pre_activate(const Glib::RefPtr& action) * */ @@ -272,7 +272,7 @@ public: * * @param action the action * - * @paragraph Slot Prototype: + * \par Slot Prototype: * void on_my_%post_activate(const Glib::RefPtr& action) * */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/arrow.h b/libs/tk/ytkmm/ytkmm/gtkmm/arrow.h index 8b41b7d10c..d5bf3dae7b 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/arrow.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/arrow.h @@ -53,9 +53,6 @@ namespace Gtk * from Gtk::Misc, it can be padded and/or aligned, to fill exactly the * space the programmer desires. * - * The Arrow widget looks like this: - * @image html arrow1.png - * * @ingroup Widgets */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/box.h b/libs/tk/ytkmm/ytkmm/gtkmm/box.h index bce29f9b7a..01709c7a6f 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/box.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/box.h @@ -424,7 +424,7 @@ public: int get_spacing() const; - /** Moves @a child to a new @a position in the list of @a box children. + /** Moves @a child to a new @a pos in the list of @a box children. * The list is the children field of * Gtk::Box-struct, and contains both widgets packed Gtk::PACK_START * as well as widgets packed Gtk::PACK_END, in the order that these @@ -436,7 +436,7 @@ public: * same packing type that appear earlier in the list. * * @param child The Gtk::Widget to move. - * @param position The new position for @a child in the list of children + * @param pos The new position for @a child in the list of children * of @a box, starting from 0. If negative, indicates the end of * the list. */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/builder.h b/libs/tk/ytkmm/ytkmm/gtkmm/builder.h index 2b228c4378..5d5ada069b 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/builder.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/builder.h @@ -258,7 +258,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 */ @@ -274,7 +274,7 @@ 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 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 @@ -289,7 +289,7 @@ 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 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 @@ -354,7 +354,7 @@ public: * and merges it with the current contents of the builder. * * @param buffer The string to parse. - * @param object_id 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 */ @@ -398,7 +398,7 @@ public: * container widget. * * @param name The name of the widget. - * @retval widget A pointer to the widget, or 0 on failure. + * @param widget A pointer to the widget, or 0 on failure. */ template inline void get_widget(const Glib::ustring& name, T_Widget*& widget) @@ -427,7 +427,7 @@ public: * @endcode * * @param name The name of the widget. - * @retval widget A pointer to the widget, or 0 on failure. + * @param widget A pointer to the widget, or 0 on failure. */ template inline void get_widget_derived(const Glib::ustring& name, T_Widget*& widget) diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/button.h b/libs/tk/ytkmm/ytkmm/gtkmm/button.h index a3b153cda3..b9971bfd5f 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/button.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/button.h @@ -53,9 +53,6 @@ namespace Stock { struct BuiltinStockID; } * This widget is generally used with a signal handler that is called when the button is pressed. * It can hold any valid child widget. The most commonly used child is the Gtk::Label. * - * The Button widget looks like this: - * @image html button2.png - * * @ingroup Widgets */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/buttonbox.h b/libs/tk/ytkmm/ytkmm/gtkmm/buttonbox.h index aba1fa8b78..971f5a517a 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/buttonbox.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/buttonbox.h @@ -282,9 +282,6 @@ public: * The layout/spacing can then be altered by the programmer, or if desired, * by the user to alter the 'feel' of a program to a small degree. * - * The HButtonBox widget looks like this: - * @image html hbuttonbox1.png - * * @ingroup Widgets * @ingroup Containers */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/cellrenderer.h b/libs/tk/ytkmm/ytkmm/gtkmm/cellrenderer.h index 883512941a..f09eb61079 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/cellrenderer.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/cellrenderer.h @@ -315,7 +315,7 @@ public: * @param xalign The x alignment of the cell renderer. * @param yalign The y alignment of the cell renderer. */ - void set_alignment(float align, float yalign); + void set_alignment(float xalign, float yalign); /** Fills in @a xalign and @a yalign with the appropriate values of @a cell. * diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/cellrendereraccel.h b/libs/tk/ytkmm/ytkmm/gtkmm/cellrendereraccel.h index e1b7442a1c..8f0d623739 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/cellrendereraccel.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/cellrendereraccel.h @@ -77,11 +77,10 @@ namespace Gtk { -/** . - * 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 -a). + * (i.e. a key combination like Ctrl+a). * If the cell renderer is editable, the accelerator can be changed by * simply typing the new combination. * diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/cellview.h b/libs/tk/ytkmm/ytkmm/gtkmm/cellview.h index df936f062b..2b0264dba7 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/cellview.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/cellview.h @@ -118,7 +118,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); @@ -126,7 +126,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& pixbuf); diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/checkbutton.h b/libs/tk/ytkmm/ytkmm/gtkmm/checkbutton.h index 5c232059e2..b0ff62217c 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/checkbutton.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/checkbutton.h @@ -49,9 +49,6 @@ namespace Gtk * information about toggle/check buttons. The important signal, * signal_toggled() is also inherited from Gtk::ToggleButton. * - * The CheckButton widget looks like this: - * @image html checkbutton1.png - * * @ingroup Widgets */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/clipboard.h b/libs/tk/ytkmm/ytkmm/gtkmm/clipboard.h index b324a90777..bb553aa061 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/clipboard.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/clipboard.h @@ -310,8 +310,8 @@ public: * 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/libs/tk/ytkmm/ytkmm/gtkmm/colorbutton.h b/libs/tk/ytkmm/ytkmm/gtkmm/colorbutton.h index 39d48ac9fe..969609d9e5 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/colorbutton.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/colorbutton.h @@ -49,9 +49,6 @@ namespace Gtk * open a color selection dialog to change the color. It is suitable widget for selecting a * color in a preference dialog. * - * The ColorButton widget looks like this: - * @image html colorbutton1.png - * * @ingroup Widgets */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/colorselection.h b/libs/tk/ytkmm/ytkmm/gtkmm/colorselection.h index b8b9306110..5d92bfae2d 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/colorselection.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/colorselection.h @@ -278,9 +278,6 @@ public: }; /** This dialog allows the user to select a color. - * - * A ColorSelectionDialog looks like this: - * @image html colorselectiondialog1.png * * @ingroup Dialogs */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/combobox.h b/libs/tk/ytkmm/ytkmm/gtkmm/combobox.h index 474d68f845..999b6a71dd 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/combobox.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/combobox.h @@ -60,12 +60,6 @@ namespace Gtk * valid choices is not restricted to a flat list, it can be a real tree, and the popup will reflect the tree * structure. * - * The ComboBox widget looks like this with has_entry = false: - * @image html combobox1.png - * - * The ComboBox widget looks like this with has_entry = true: - * @image html comboboxentry1.png - * * See also ComboBoxText, which is specialised for a single text column. * * @ingroup Widgets diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/comboboxentry.h b/libs/tk/ytkmm/ytkmm/gtkmm/comboboxentry.h index 7c48cd222d..55db46a030 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/comboboxentry.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/comboboxentry.h @@ -65,9 +65,6 @@ namespace Gtk * If you have special needs that go beyond a simple entry (e.g. input validation), it is possible to replace the * child entry by a different widget using Gtk::Container::remove() and Gtk::Container::add(). * - * The ComboBoxEntry widget looks like this: - * @image html comboboxentry1.png - * * @ingroup Widgets * * @deprecated Instead use ComboBox with has_entry = true. diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/comboboxentrytext.h b/libs/tk/ytkmm/ytkmm/gtkmm/comboboxentrytext.h index 1adf16b4b2..03a1c03aec 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/comboboxentrytext.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/comboboxentrytext.h @@ -110,7 +110,7 @@ public: void clear_items(); /** Remove the specified item if it is in the drop-down menu. - * @text The text of the item that should be removed. + * @param text The text of the item that should be removed. */ void remove_text(const Glib::ustring& text); diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/comboboxtext.h b/libs/tk/ytkmm/ytkmm/gtkmm/comboboxtext.h index cae71bd74a..5c8934bbc9 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/comboboxtext.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/comboboxtext.h @@ -121,7 +121,7 @@ public: Glib::ustring get_active_text() const; /** Set the currently-chosen item if it matches the specified text. - * @text The text of the item that should be selected. + * @param text The text of the item that should be selected. */ void set_active_text(const Glib::ustring& text); @@ -135,7 +135,7 @@ public: void remove_all(); /** Remove the specified item if it is in the drop-down menu. - * @text The text of the item that should be removed. + * @param text The text of the item that should be removed. */ void remove_text(const Glib::ustring& text); diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/dialog.h b/libs/tk/ytkmm/ytkmm/gtkmm/dialog.h index c0f964f04e..1f4df7ac65 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/dialog.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/dialog.h @@ -215,7 +215,7 @@ public: * appended to the end of the dialog's action area. The button widget is * returned, but usually you don't need it. * - * @param button_text Text of button, or stock ID. + * @param stock_id Text of button, or stock ID. * @param response_id Response ID for the button. * @return The button widget that was added. */ @@ -286,7 +286,7 @@ public: * about alternative button order. * * If you need to use this function, you should probably connect - * to the ::notify:gtk-alternative-button-order signal on the + * to the notify:gtk-alternative-button-order signal on the * Gtk::Settings object associated to @a screen, in order to be * notified if the button order setting changes. * @@ -300,10 +300,9 @@ public: * the order of the response ids in @a new_order. * * By default, GTK+ dialogs use the button order advocated by the Gnome - * Human - * Interface Guidelines with the affirmative button at the far + * Human Interface Guidelines with the affirmative button at the far * right, and the cancel button left of it. But the builtin GTK+ dialogs - * and #GtkMessageDialogs do provide an alternative button order, + * and #GtkMessageDialog 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 diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/editable.h b/libs/tk/ytkmm/ytkmm/gtkmm/editable.h index 0aa13943ad..0680c5aeb6 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/editable.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/editable.h @@ -172,8 +172,8 @@ public: * Note that the position is in characters, not in bytes. * The function updates @a position to point after the newly inserted text. * - * @param new_text The text to append. - * @param new_text_length The length of the text in bytes, or -1. + * @param text The text to append. + * @param length The length of the text in bytes, or -1. * @param position Location of the position text will be inserted at. */ void insert_text(const Glib::ustring& text, int length, int& position); diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/entry.h b/libs/tk/ytkmm/ytkmm/gtkmm/entry.h index ff83cde16f..854e16ecfb 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/entry.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/entry.h @@ -91,9 +91,6 @@ namespace Gtk * longer than the allocation of the widget, the widget will scroll so that * the cursor position is visible. * - * The Entry widget looks like this: - * @image html entry1.png - * * @ingroup Widgets */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/entrycompletion.h b/libs/tk/ytkmm/ytkmm/gtkmm/entrycompletion.h index 95910a71af..38f2626662 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/entrycompletion.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/entrycompletion.h @@ -338,7 +338,7 @@ public: * * This functions creates and adds a Gtk::CellRendererText for the selected * column. If you need to set the text column, but don't want the cell - * renderer, use Glib::object_set() to set the ::text_column property directly. + * renderer, use Glib::object_set() to set the text_column property directly. * * @param column The column in the model of @a completion to get strings from. */ @@ -351,7 +351,7 @@ public: * * This functions creates and adds a Gtk::CellRendererText for the selected * column. If you need to set the text column, but don't want the cell - * renderer, use Glib::object_set() to set the ::text_column property directly. + * renderer, use Glib::object_set() to set the text_column property directly. * * @param column The column in the model of @a completion to get strings from. */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/eventbox.h b/libs/tk/ytkmm/ytkmm/gtkmm/eventbox.h index 53d7133315..475bbf54cc 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/eventbox.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/eventbox.h @@ -141,7 +141,7 @@ public: * you want to set the background to a different color or * draw on it. * - * + * \note * There is one unexpected issue for an invisible event box that has its * window below the child. (See set_above_child().) * Since the input-only window is not an ancestor window of any windows @@ -151,10 +151,10 @@ public: * mask for the descendant window (see Gtk::Widget::add_events()), * it won't be received by the event box. * + * \note * This problem doesn't occur for visible event boxes, because in * that case, the event box window is actually the ancestor of the * descendant windows, not just at the same place on the screen. - * * * @param visible_window Boolean value. */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/filechooser.h b/libs/tk/ytkmm/ytkmm/gtkmm/filechooser.h index 6a245fe7e7..04b69b11ff 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/filechooser.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/filechooser.h @@ -612,7 +612,7 @@ public: * * [C example ellipted] * - * @param file The File to set as current. + * @param uri The File/URI to set as current. * @return true if both the folder could be changed and the file was * selected successfully, false otherwise. */ @@ -1019,7 +1019,7 @@ public: /** This signal is emitted when the user "activates" a file in the file * chooser. This can happen by double-clicking on a file in the file list, or - * by pressing Enter. + * by pressing Enter. * * Normally you do not need to connect to this signal. It is used internally * by FileChooserDialog to know when to activate the default button in the diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/filechooserbutton.h b/libs/tk/ytkmm/ytkmm/gtkmm/filechooserbutton.h index 10fa795800..9f7b4bbed2 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/filechooserbutton.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/filechooserbutton.h @@ -55,9 +55,6 @@ namespace Gtk * space, you should call size_request(), set_width_chars(), or pack the button in such a way that other interface * elements give space to the widget. * - * The FileChooserButton widget looks like this: - * @image html filechooserbutton1.png - * * @ingroup Widgets */ @@ -121,9 +118,7 @@ private: 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. - * @param backend The name of the Gtk::FileSystem backend to use. */ explicit FileChooserButton(FileChooserAction action = FILE_CHOOSER_ACTION_OPEN); diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/filechooserdialog.h b/libs/tk/ytkmm/ytkmm/gtkmm/filechooserdialog.h index e7d6a395d7..503954ee3e 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/filechooserdialog.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/filechooserdialog.h @@ -44,9 +44,6 @@ namespace Gtk { /** Convenient file chooser window. - * - * A FileChooserDialog looks like this: - * @image html filechooserdialog1.png * * @ingroup Dialogs */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/fontbutton.h b/libs/tk/ytkmm/ytkmm/gtkmm/fontbutton.h index 701a6b2476..2ae711aa0d 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/fontbutton.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/fontbutton.h @@ -48,9 +48,6 @@ namespace Gtk * allows to open a font selection dialog to change the font. It is suitable widget * for selecting a font in a preference dialog. * - * The FontButton widget looks like this: - * @image html fontbutton1.png - * * @ingroup Widgets */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/fontselection.h b/libs/tk/ytkmm/ytkmm/gtkmm/fontselection.h index b471fce2b4..e49c258f0a 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/fontselection.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/fontselection.h @@ -281,7 +281,7 @@ public: * * @param text The text to display in the preview area. */ - void set_preview_text(const Glib::ustring& fontname); + void set_preview_text(const Glib::ustring& text); //TODO: Remove these accessors when we can break ABI. //They probably all return null now anyway. @@ -352,9 +352,6 @@ public: * * The Gtk::FontSelectionDialog widget is a dialog box for selecting a font. * - * A FontSelectionDialog looks like this: - * @image html fontselectiondialog1.png - * * @ingroup Dialogs */ @@ -453,7 +450,7 @@ public: * * @param text The text to display in the preview area. */ - void set_preview_text(const Glib::ustring& fontname); + void set_preview_text(const Glib::ustring& text); /** Gets the 'OK' button. diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/frame.h b/libs/tk/ytkmm/ytkmm/gtkmm/frame.h index d4c6175bee..84dc8c703c 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/frame.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/frame.h @@ -50,9 +50,6 @@ namespace Gtk * side of the frame. The position of the label can be controlled with * set_label_align(). * - * A Frame widget looks like this: - * @image html frame1.png - * * @ingroup Widgets * @ingroup Containers */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/iconview.h b/libs/tk/ytkmm/ytkmm/gtkmm/iconview.h index da822dcecb..532ed0d00b 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/iconview.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/iconview.h @@ -206,7 +206,7 @@ public: /** Sets the column with text for @a icon_view to be @a column. The text * column must be of type TYPE_STRING. * - * @param column A column in the currently used model, or -1 to display no text. + * @param model_column A column in the currently used model, or -1 to display no text. */ void set_text_column(const TreeModelColumnBase& model_column); @@ -415,11 +415,11 @@ public: */ bool get_item_at_pos(int x, int y, TreeModel::Path& path) const; - /** Finds the path at the point (@a x, @a y), relative to widget coordinates. + /** Finds the cell renderer at the point (@a x, @a y). * * @param x The x position to be identified. * @param y The y position to be identified. - * @param path The path. + * @param cell The cellrender or 0 if none is found. * * @result true if an item exists at the specified position. */ @@ -663,7 +663,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. */ void get_drag_dest_item(TreeModel::Path& path, IconViewDropPosition& pos) const; @@ -675,7 +675,7 @@ public: /** Gets information about the item that is highlighted for feedback. * - * @pos The drop position. + * @param pos The drop position. */ void get_drag_dest_item(IconViewDropPosition& pos) const; diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/image.h b/libs/tk/ytkmm/ytkmm/gtkmm/image.h index 71e967bcf6..d61eb387ec 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/image.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/image.h @@ -101,9 +101,6 @@ namespace Gtk * image, such as button clicks, place the image inside a Gtk::EventBox, then * connect to the event signals on the event box. * - * The Image widget looks like this: - * @image html image1.png - * * @ingroup Widgets */ @@ -209,7 +206,7 @@ public: * constructor that takes a StockID. This will allow themes to override the icon you ship with your application. * * @param icon_set An IconSet - * @param size A stock icon size. + * @param icon_size A stock icon size. */ explicit Image(const IconSet& icon_set, IconSize icon_size); diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/infobar.h b/libs/tk/ytkmm/ytkmm/gtkmm/infobar.h index 8ad9c26d6a..5f1b5c0959 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/infobar.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/infobar.h @@ -58,9 +58,6 @@ namespace Gtk * warning, informational message, etc, by using set_message_type(). This * determines the background color of the message area. * - * The InfoBar widget looks like - * @image html infobar1.png - * * @ingroup Widgets */ @@ -182,7 +179,7 @@ public: * to the end of the info bars's action area. The button widget is * returned, but usually you don't need it. * - * @param button_text Text of button, or stock ID. + * @param stock_id A stock ID. * @param response_id Response ID for the button. * @return The button widget that was added. */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/label.h b/libs/tk/ytkmm/ytkmm/gtkmm/label.h index bd65e3eb0d..a63293b158 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/label.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/label.h @@ -48,9 +48,6 @@ class Menu; * * A simple setable widget for holding a Glib::ustring. * - * The Label widget looks like this: - * @image html label1.png - * * @ingroup Widgets */ @@ -160,12 +157,13 @@ public: /** Sets a Pango::AttrList; the attributes in the list are applied to the * label text. * - * The attributes set with this function will be applied + * \note + * The attributes set with this function will be applied * and merged with any other attributes previously effected by way * of the Gtk::Label::property_use_underline() or Gtk::Label::property_use_markup() properties. * While it is not recommended to mix markup strings with manually set * attributes, if you must; know that the attributes will be applied - * to the label after the markup string is parsed. + * to the label after the markup string is parsed. * * @param attrs A Pango::AttrList. */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/linkbutton.h b/libs/tk/ytkmm/ytkmm/gtkmm/linkbutton.h index 2e1c5321fe..975e19a864 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/linkbutton.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/linkbutton.h @@ -52,8 +52,6 @@ namespace Gtk * and retrieved using get_uri(). * Gtk::LinkButton offers a global hook, which is called when the used clicks on it: see set_uri_hook(). * - * The LinkButton widget looks like this: - * @image html linkbutton1.png * @ingroup Widgets */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/liststore.h b/libs/tk/ytkmm/ytkmm/gtkmm/liststore.h index dfa363da5e..ad4d060547 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/liststore.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/liststore.h @@ -209,8 +209,7 @@ public: void clear(); - /** This function is slow. Only use it for debugging and/or testing - * purposes. + /** \warning This function is slow. Only use it for debugging and/or testing * purposes. * * Checks if the given iter is a valid iter for this Gtk::ListStore. * diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/main.h b/libs/tk/ytkmm/ytkmm/gtkmm/main.h index de3b1333a6..ee0c5a17d5 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/main.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/main.h @@ -138,13 +138,11 @@ public: * standard C++. (You might need to use const_cast<>, though.) * * This function automatically generates nicely formatted - * output. Note that your program will + * --help 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 output, - * after programname [OPTION...] * @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/libs/tk/ytkmm/ytkmm/gtkmm/menu.h b/libs/tk/ytkmm/ytkmm/gtkmm/menu.h index 7b551c7a79..caefff2143 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/menu.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/menu.h @@ -50,7 +50,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 */ @@ -135,7 +135,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 0. + * @param position_calc_slot A function used to position the menu, or 0. * @param button The mouse button which was pressed to initiate the event. * @param activate_time The time at which the activation event occurred. */ @@ -461,7 +461,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. */ void attach_to_widget(Widget& attach_widget); diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/menubar.h b/libs/tk/ytkmm/ytkmm/gtkmm/menubar.h index 28896d04a2..361310b5ab 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/menubar.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/menubar.h @@ -83,9 +83,6 @@ namespace Gtk /** A standard menu bar which usually holds Gtk::Menu submenu items. * The useful methods are in the base class - Gtk::MenuShell. * - * The MenuBar widget looks like this: - * @image html menubar1.png - * * @ingroup Widgets * @ingroup Menus */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/messagedialog.h b/libs/tk/ytkmm/ytkmm/gtkmm/messagedialog.h index fe5997f830..f22adea969 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/messagedialog.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/messagedialog.h @@ -90,9 +90,6 @@ namespace Gtk * Gtk::MessageDialog from Gtk::Dialog without too much effort, but * Gtk::MessageDialog saves typing. * - * A MessageDialog looks like this: - * @image html messagedialog1.png - * * @ingroup Dialogs */ @@ -191,7 +188,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); diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/notebook.h b/libs/tk/ytkmm/ytkmm/gtkmm/notebook.h index 69173bb2e0..765353319f 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/notebook.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/notebook.h @@ -354,9 +354,6 @@ protected: * The Gtk::Notebook widget is a Gtk::Container whose children are pages that * can be switched between using tab labels along one edge. * - * A Notebook widget looks like this: - * @image html notebook1.png - * * @ingroup Widgets * @ingroup Containers */ @@ -603,7 +600,7 @@ public: * via drag and drop. A notebook with a 0 group name will * not be able to exchange tabs with any other notebook. * - * @param name The name of the notebook group, or 0 to unset it. + * @param group_name The name of the notebook group, or 0 to unset it. */ void set_group_name(const Glib::ustring& group_name); diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/progressbar.h b/libs/tk/ytkmm/ytkmm/gtkmm/progressbar.h index 775fa8e72d..58d7f2f988 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/progressbar.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/progressbar.h @@ -102,9 +102,6 @@ namespace Gtk * the bar, optional text can be displayed along with the bar, and the step * size used in activity mode can be set. * - * The ProgressBar widget looks like this: - * @image html progressbar1.png - * * @ingroup Widgets */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/radiobutton.h b/libs/tk/ytkmm/ytkmm/gtkmm/radiobutton.h index a5f61071c2..c3dcec5bd2 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/radiobutton.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/radiobutton.h @@ -48,9 +48,6 @@ namespace Gtk * After constructing the first RadioButton in a group, use get_group() and provide this Group to the constructors ot the other RadioButtons in the same group. * To remove a Gtk::RadioButton from one group and make it part of a new one, use set_group(). * - * The RadioButton widget looks like this: - * @image html radiobutton1.png - * * @ingroup Widgets */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/recentaction.h b/libs/tk/ytkmm/ytkmm/gtkmm/recentaction.h index c4912e44a8..3cf3e8888e 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/recentaction.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/recentaction.h @@ -52,9 +52,9 @@ namespace Gtk * 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 . 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 element. + * Gtk::RecentAction as the action for a toolitem element. * * See also the methods in the RecentChooser base class. * diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/recentchooser.h b/libs/tk/ytkmm/ytkmm/gtkmm/recentchooser.h index 6bdbc4c454..5380c6e65e 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/recentchooser.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/recentchooser.h @@ -487,7 +487,7 @@ public: /** This signal is emitted when the user "activates" a recent item * in the recent chooser. This can happen by double-clicking on an item * in the recently used resources list, or by pressing - * Enter. + * Enter. * * @par Slot Prototype: * void on_my_%item_activated() diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/recentchooserdialog.h b/libs/tk/ytkmm/ytkmm/gtkmm/recentchooserdialog.h index abd56dd8e3..2b7b9586ba 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/recentchooserdialog.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/recentchooserdialog.h @@ -50,9 +50,6 @@ namespace Gtk * Note that RecentChooserDialog does not have any methods of its own. * Instead, you should use the functions that work on a RecentChooser. * - * A RecentChooserDialog looks like this: - * @image html recentchooserdialog1.png - * * @ingroup RecentFiles */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/recentinfo.h b/libs/tk/ytkmm/ytkmm/gtkmm/recentinfo.h index 370254e16d..1921762225 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/recentinfo.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/recentinfo.h @@ -177,7 +177,7 @@ public: */ bool get_application_info(const Glib::ustring& app_name, std::string& app_exec, - guint& count, time_t& time_) const; + guint& count, time_t& time) const; /** Retrieves the list of applications that have registered this resource. @@ -221,7 +221,7 @@ public: /** Checks whether @a group_name appears inside the groups registered for the * recently used item @a info. * - * @param group_name Name of a group. + * @param group Name of a group. * @return true if the group was found. */ bool has_group(const Glib::ustring& group) const; @@ -289,7 +289,7 @@ public: /** Checks whether two Gtk::RecentInfo structures point to the same * resource. * - * @param info_b A Gtk::RecentInfo. + * @param b A Gtk::RecentInfo. * @return true if both Gtk::RecentInfo structures point to se same * resource, false otherwise. */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/scale.h b/libs/tk/ytkmm/ytkmm/gtkmm/scale.h index 4d6549515b..a6241fa02c 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/scale.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/scale.h @@ -309,9 +309,6 @@ protected: * vertical slider. See the Gtk::Scale documentation for more information * on how to use a Gtk::VScale. * - * A VScale widget looks like this: - * @image html vscale1.png - * * @ingroup Widgets */ @@ -389,9 +386,6 @@ public: * horizontal slider. See the Gtk::Scale documentation for more information * on how to use a Gtk::HScale. * - * The HScale widget looks like this: - * @image html hscale1.png - * * @ingroup Widgets */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/scrollbar.h b/libs/tk/ytkmm/ytkmm/gtkmm/scrollbar.h index ba20fe6b8d..4cdac0e125 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/scrollbar.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/scrollbar.h @@ -145,9 +145,6 @@ protected: * adjustment of the scrollbar. If not specified, one will be created for * you. See Gtk::Adjustment for details. * - * A VScrollbar widget looks like this: - * @image html vscrollbar1.png - * * @ingroup Widgets */ @@ -221,9 +218,6 @@ public: * adjustment of the scrollbar. If not specified, one will be created for * you. See Gtk::Adjustment for details. * - * The HScrollbar widget looks like this: - * @image html hscrollbar1.png - * * @ingroup Widgets */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/separator.h b/libs/tk/ytkmm/ytkmm/gtkmm/separator.h index dfef53e821..641cd6e809 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/separator.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/separator.h @@ -133,9 +133,6 @@ protected: * This widget has no window and receives no configuration events. * It should be considered a leaf widget. * - * A VSeparator widget looks like this: - * @image html vseparator1.png - * * @ingroup Widgets */ @@ -205,9 +202,6 @@ public: * This widget has no window and receives no configuration events. * It should be considered a leaf widget. * - * The HSeparator widget looks like this: - * @image html hseparator1.png - * * @ingroup Widgets */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/spinbutton.h b/libs/tk/ytkmm/ytkmm/gtkmm/spinbutton.h index b50fb36f76..76965ee40f 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/spinbutton.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/spinbutton.h @@ -120,9 +120,6 @@ class Adjustment; /** numeric Entry with up/down buttons * Slightly misnamed, this should be called a SpinEntry. * - * The SpinButton widget looks like this: - * @image html spinbutton1.png - * * @ingroup Widgets */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/statusbar.h b/libs/tk/ytkmm/ytkmm/gtkmm/statusbar.h index e2e9e0ec3d..56ae8110a6 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/statusbar.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/statusbar.h @@ -51,9 +51,6 @@ namespace Gtk * It derives from Gtk::HBox so that additional information can be added * easily. * - * The Statusbar widget looks like this: - * @image html statusbar1.png - * * @ingroup Widgets */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/table.h b/libs/tk/ytkmm/ytkmm/gtkmm/table.h index 8dc03c29e7..5e874ec133 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/table.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/table.h @@ -177,9 +177,6 @@ virtual void remove(Widget& w); //Implented as custom or by LIST_CONTAINER_REMOV * spacing can be used in the table. Padding is added on either side of a * widget, while spacing is placed between widgets. * - * A Table widget looks like this: - * @image html table1.png - * * @see Gtk::HBox, Gtk::VBox */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/textiter.h b/libs/tk/ytkmm/ytkmm/gtkmm/textiter.h index 332a7bb1d2..984f11a475 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/textiter.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/textiter.h @@ -192,7 +192,7 @@ protected: * If @a pred never returns true, @a iter is set to @a limit if * @a limit is non-0, otherwise to the end iterator. * - * @param pred A function to be called on each character. + * @param predicate A function to be called on each character. * @param user_data User data for @a pred. * @param limit Search limit, or 0 for none. * @return Whether a match was found. @@ -202,7 +202,7 @@ protected: /** Same as forward_find_char(), but goes backward from @a iter. * - * @param pred Function to be called on each character. + * @param predicate Function to be called on each character. * @param user_data User data for @a pred. * @param limit Search limit, or 0 for none. * @return Whether a match was found. diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/textmark.h b/libs/tk/ytkmm/ytkmm/gtkmm/textmark.h index 071ab363e0..7b3ef6e067 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/textmark.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/textmark.h @@ -137,7 +137,6 @@ protected: * 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. */ explicit TextMark(bool left_gravity = true); @@ -167,8 +166,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/libs/tk/ytkmm/ytkmm/gtkmm/textview.h b/libs/tk/ytkmm/ytkmm/gtkmm/textview.h index da46de720f..08dc1afc78 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/textview.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/textview.h @@ -95,9 +95,6 @@ namespace Gtk */ /** Multi-line text editing widget. It displays a Gtk::TextBuffer. - * - * The TextView widget looks like this: - * @image html textview1.png * * @ingroup Widgets * @ingroup Containers diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/toggletoolbutton.h b/libs/tk/ytkmm/ytkmm/gtkmm/toggletoolbutton.h index af30498a47..c3f7c9a253 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/toggletoolbutton.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/toggletoolbutton.h @@ -46,9 +46,6 @@ namespace Gtk * * A ToggleToolButton is a Gtk::ToolItem that contains a toggle button. * - * A ToggleToolButton widget looks like this: - * @image html toggletoolbutton1.png - * * @ingroup Widgets */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/toolbar.h b/libs/tk/ytkmm/ytkmm/gtkmm/toolbar.h index 50f88b4dbd..6c6e466344 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/toolbar.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/toolbar.h @@ -341,9 +341,9 @@ public: /** Emitted when the style of the toolbar changes. * - * @param @style The new ToolbarStyle of the toolbar. + * @param style The new ToolbarStyle of the toolbar. * - * @par Slot Prototype: + * \par Slot Prototype: * void on_my_%toolbar_style_changed(ToolbarStyle style) * */ @@ -363,7 +363,7 @@ public: * @param x The x coordinate of the point where the menu should appear. * @param y The y coordinate of the point where the menu should appear. * @param button The mouse button the user pressed, or -1 - * @resultt true if the signal was handled, false if not. + * @result true if the signal was handled, false if not. * * @par Slot Prototype: * bool on_my_%popup_context_menu(int x, int y, int button_number) diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/toolitem.h b/libs/tk/ytkmm/ytkmm/gtkmm/toolitem.h index 6f0181dc03..635df4bd96 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/toolitem.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/toolitem.h @@ -312,7 +312,7 @@ public: * Gtk::ToolItem should call this function to find out how text should * be aligned. * - * @return A #gfloat indicating the horizontal text alignment + * @return A float indicating the horizontal text alignment * used for @a tool_item. */ float get_text_alignment() const; @@ -420,7 +420,7 @@ public: //TODO: This suggests calling set_proxy_menu_item() with NULL. but the function asserts against that. - /** This signal is emitted when the toolbar needs information from @tool_item + /** This signal is emitted when the toolbar needs information from @a tool_item * about whether the item should appear in the toolbar overflow menu. In * response the tool item should either *
    diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/tooltip.h b/libs/tk/ytkmm/ytkmm/gtkmm/tooltip.h index 8f957b6c9a..4e83f1dc6c 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/tooltip.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/tooltip.h @@ -155,7 +155,7 @@ public: * * @param text A text string or 0. */ - void set_text(const Glib::ustring& markup); + void set_text(const Glib::ustring& text); /** Sets the icon of the tooltip (which is in front of the text) to be * @a pixbuf. If @a pixbuf is 0, the image will be hidden. @@ -168,7 +168,7 @@ public: * to be the icon indicated by @a gicon with the size indicated * by @a size. If @a gicon is 0, the image will be hidden. * - * @param gicon A Icon representing the icon, or 0. + * @param icon A Icon representing the icon, or 0. * @param size A stock icon size. */ void set_icon(const Glib::RefPtr& icon, IconSize size); diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/treeiter.h b/libs/tk/ytkmm/ytkmm/gtkmm/treeiter.h index 768c7f0f03..225d526f45 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/treeiter.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/treeiter.h @@ -304,8 +304,11 @@ 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. + * @param data The column type of the given colomn. * @result data An output argument which will contain the value of this column of this row. */ template diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/treemodelfilter.h b/libs/tk/ytkmm/ytkmm/gtkmm/treemodelfilter.h index 83c43b82f9..86eae7e9c3 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/treemodelfilter.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/treemodelfilter.h @@ -266,7 +266,7 @@ public: Path convert_path_to_child_path(const Path& filter_path) const; - /** Emits ::row_changed for each row in the child model, which causes + /** Emits row_changed for each row in the child model, which causes * the filter to re-evaluate whether a row is visible or not. */ void refilter(); diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/treemodelsort.h b/libs/tk/ytkmm/ytkmm/gtkmm/treemodelsort.h index 9b4cb77c11..b3402fbd8d 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/treemodelsort.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/treemodelsort.h @@ -195,9 +195,7 @@ public: void clear_cache(); - /** - * This function is slow. Only use it for debugging and/or testing purposes. - * + /** \warning This function is slow. Only use it for debugging and/or testing purposes. * * Checks if the given iter is a valid iter for this Gtk::TreeModelSort. * diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/treepath.h b/libs/tk/ytkmm/ytkmm/gtkmm/treepath.h index 631e158df9..b9e6df9feb 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/treepath.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/treepath.h @@ -275,7 +275,7 @@ public: * you can assume that selection data of type "GTK_TREE_MODEL_ROW" is * from the current process. * - * @param selection_data a #SelectionData + * @param selection_data a @a SelectionData * @param model a Gtk::TreeModel * @param path a row in model * @@ -292,7 +292,7 @@ public: * Sets selection data of target type "GTK_TREE_MODEL_ROW". Normally used * in a drag_data_get signal handler. * - * @param selection_data some #SelectionData + * @param selection_data some @a SelectionData * @param model: a Gtk::TreeModel * * @return true if the selection_data had the proper target type to allow us to set a tree row diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/treeselection.h b/libs/tk/ytkmm/ytkmm/gtkmm/treeselection.h index 508708d6aa..f640a579cd 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/treeselection.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/treeselection.h @@ -296,7 +296,7 @@ public: /** Selects the specified iterator. * - * @param iter The Gtk::TreeIter to be selected. + * @param row The Gtk::TreeModel::Row to be selected. */ void select(const TreeModel::Row& row); diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/treeview.h b/libs/tk/ytkmm/ytkmm/gtkmm/treeview.h index b8d9f87a25..cee18dc3d3 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/treeview.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/treeview.h @@ -565,7 +565,7 @@ public: int insert_column_with_data_func(int position, const Glib::ustring& title, CellRenderer& cell, const SlotCellData& slot); - /** Gets the Gtk::TreeViewColumn at the given position in the #tree_view. + /** Gets the Gtk::TreeViewColumn at the given position in the Gtk::TreeView * * @param n The position of the column, counting from 0. * @return The Gtk::TreeViewColumn, or 0 if the @@ -573,7 +573,7 @@ public: */ TreeViewColumn* get_column(int n); - /** Gets the Gtk::TreeViewColumn at the given position in the #tree_view. + /** Gets the Gtk::TreeViewColumn at the given position in the Gtk::TreeView * * @param n The position of the column, counting from 0. * @return The Gtk::TreeViewColumn, or 0 if the @@ -949,8 +949,8 @@ public: /** Finds the path at the point (@a x, @a y), relative to bin_window coordinates * (please 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 == - * gtk_tree_view_get_bin_window (). It is primarily for + * come from an event on the TreeView only where event->window == + * gtk_tree_view_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 @@ -1002,7 +1002,7 @@ public: * of the rectangle will be filled with 0. The sum of all cell rects does not cover the * entire tree; there are extra pixels in between rows, for example. The * returned rectangle is equivalent to the @a cell_area passed to - * Gtk::CellRenderer::render(). This function is only valid if #tree_view is + * Gtk::CellRenderer::render(). This function is only valid if @a Gtk::TreeView is * realized. * * @deprecated Use the const version @@ -1023,7 +1023,7 @@ public: * of the rectangle will be filled with 0. The sum of all cell rects does not cover the * entire tree; there are extra pixels in between rows, for example. The * returned rectangle is equivalent to the @a cell_area passed to - * Gtk::CellRenderer::render(). This function is only valid if #tree_view is + * Gtk::CellRenderer::render(). This function is only valid if @a Gtk::TreeView is * realized. * * @param path A Gtk::TreePath for the row. @@ -1518,7 +1518,7 @@ public: /** Sets whether to draw lines interconnecting the expanders in @a tree_view. * This does not have any visible effects for lists. * - * @param enabled true to enable tree line drawing, false otherwise. + * @param enable true to enable tree line drawing, false otherwise. */ void set_enable_tree_lines(bool enable = true); @@ -1573,6 +1573,7 @@ public: * * See also Tooltip::set_tip_area(). * + * @param tooltip A Gtk::Tooltip. * @param path A Gtk::TreePath. */ void set_tooltip_row(const Glib::RefPtr& tooltip, const TreePath& path); diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/uimanager.h b/libs/tk/ytkmm/ytkmm/gtkmm/uimanager.h index b6ffd27051..156a2c60ed 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/uimanager.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/uimanager.h @@ -237,7 +237,7 @@ namespace Gtk * \par Accelerators * * Every action has an accelerator path. Accelerators are installed together with menuitem - * proxies, but they can also be explicitly added with 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. * @@ -389,10 +389,10 @@ public: /** Looks up a widget by following a path. * The path consists of the names specified in the XML description of the UI. * separated by '/'. Elements which don't have a name or action attribute in - * the XML (e.g. ) can be addressed by their XML element name + * the XML (e.g. <popup> can be addressed by their XML element name * (e.g. "popup"). The root element ("/ui") can be omitted in the path. * - * Note that the widget found by following a path that ends in a + * Note that the widget found by following a path that ends in a <menu> * element is the menuitem to which the menu is attached, not the menu itself. * * Also note that the widgets constructed by a ui manager are not tied to @@ -409,10 +409,10 @@ public: /** Looks up a widget by following a path. * The path consists of the names specified in the XML description of the UI. * separated by '/'. Elements which don't have a name or action attribute in - * the XML (e.g. ) can be addressed by their XML element name + * the XML (e.g. <popup>) can be addressed by their XML element name * (e.g. "popup"). The root element ("/ui") can be omitted in the path. * - * Note that the widget found by following a path that ends in a + * Note that the widget found by following a path that ends in a <menu> * element is the menuitem to which the menu is attached, not the menu itself. * * Also note that the widgets constructed by a ui manager are not tied to diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/widget.h b/libs/tk/ytkmm/ytkmm/gtkmm/widget.h index 1fbadc01fa..058d030cc9 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/widget.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/widget.h @@ -2516,7 +2516,6 @@ public: /** Sets the icon that will be used for drags from a particular source * to a themed icon. See the docs for Gtk::IconTheme for more details. * - * @param widget A Gtk::Widget. * @param icon_name Name of icon to use. */ void drag_source_set_icon(const Glib::ustring& icon_name); @@ -2679,9 +2678,9 @@ public: * If the custom window should have the default theming it needs to * have the name "gtk-tooltip", see set_name(). * - * @param custom_window A Gtk::Window, or 0. + * @param window A Gtk::Window, or 0. */ - void set_tooltip_window(Window& widget); + void set_tooltip_window(Window& window); /** Returns the Gtk::Window of the current tooltip. This can be the * GtkWindow created by default, or the custom tooltip window set @@ -3051,7 +3050,7 @@ public: Glib::SignalProxy1< void,bool > signal_grab_notify(); - /** The ::child-notify signal is emitted for each child property that has + /** The child-notify signal is emitted for each child property that has * changed on an object. The signal's detail holds the property name. * * @param pspec The GParamSpec of the changed child property. @@ -3522,13 +3521,13 @@ public: /** The drag_data_received signal is emitted on the drop site when the dragged data has been * received. If the data was received in order to determine whether the drop will be accepted, - * the handler is expected to call drag_status() and not finish the drag. + * the handler is expected to call drag_status() and not finish the drag. * If the data was received in response to a drag_drop signal (and this is the last target to be * received), the handler for this signal is expected to process the received data and then call * drag_finish(), setting the @a success parameter depending on whether the data was processed * successfully. * - * The handler may inspect and modify @drag_context->action before calling gtk_drag_finish(), + * The handler may inspect and modify @p drag_context->action before calling gtk_drag_finish(), * e.g. to implement %Gdk::ACTION_ASK. * * @param drag_context the drag context