From fd96694a21d1985da2c86c95c0f4cbae850eebc2 Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Mon, 27 May 2024 00:40:21 +0200 Subject: [PATCH] Fix various doxgen errors in YTK This is about half of the reported errors, then my patience ran out. More later --- libs/tk/ydk/ydk/gdk/gdkinternals.h | 14 +-- libs/tk/ydk/ydk/gdk/gdkpango.h | 2 +- libs/tk/ydkmm/ydkmm/gdkmm/display.h | 4 +- libs/tk/ydkmm/ydkmm/gdkmm/pixbuf.h | 6 +- libs/tk/ytk/ytk/gtk/gtkaboutdialog.h | 8 +- libs/tk/ytk/ytk/gtk/gtkaccelgroup.h | 6 +- libs/tk/ytk/ytk/gtk/gtkactivatable.h | 13 +- libs/tk/ytk/ytk/gtk/gtkassistant.h | 14 +-- libs/tk/ytk/ytk/gtk/gtkbox.h | 14 +-- libs/tk/ytk/ytk/gtk/gtkbuildable.h | 36 +++--- libs/tk/ytk/ytk/gtk/gtkenums.h | 10 +- libs/tk/ytk/ytk/gtk/gtkfilechooser.h | 26 ++-- libs/tk/ytk/ytk/gtk/gtkicontheme.h | 14 +-- libs/tk/ytk/ytk/gtk/gtkimage.h | 18 +-- libs/tk/ytk/ytk/gtk/gtkmessagedialog.h | 20 ++-- libs/tk/ytk/ytk/gtk/gtkobject.h | 4 +- libs/tk/ytk/ytk/gtk/gtkrecentchooser.h | 8 +- libs/tk/ytk/ytk/gtk/gtkrecentmanager.h | 28 ++--- libs/tk/ytk/ytk/gtk/gtksizegroup.h | 8 +- libs/tk/ytk/ytk/gtk/gtktoolpalette.h | 4 +- libs/tk/ytk/ytk/gtk/gtktoolshell.h | 18 +-- libs/tk/ytk/ytk/gtk/gtkwidget.h | 152 ++++++++++++------------ libs/tk/ytkmm/ytkmm/gtkmm/aboutdialog.h | 2 +- libs/tk/ytkmm/ytkmm/gtkmm/actiongroup.h | 14 +-- libs/tk/ytkmm/ytkmm/gtkmm/activatable.h | 15 ++- libs/tk/ytkmm/ytkmm/gtkmm/builder.h | 15 ++- libs/tk/ytkmm/ytkmm/gtkmm/toolitem.h | 28 ++--- 27 files changed, 253 insertions(+), 248 deletions(-) diff --git a/libs/tk/ydk/ydk/gdk/gdkinternals.h b/libs/tk/ydk/ydk/gdk/gdkinternals.h index e748125750..289878b1d4 100644 --- a/libs/tk/ydk/ydk/gdk/gdkinternals.h +++ b/libs/tk/ydk/ydk/gdk/gdkinternals.h @@ -547,9 +547,9 @@ GType _gdk_pixmap_impl_get_type (void) G_GNUC_CONST; /** * _gdk_windowing_gc_set_clip_region: - * @gc: a #GdkGC - * @region: the new clip region - * @reset_origin: if TRUE, reset the clip_x/y_origin values to 0 + * @param gc: a #GdkGC + * @param region: the new clip region + * @param reset_origin: if TRUE, reset the clip_x/y_origin values to 0 * * Do any window-system specific processing necessary * for a change in clip region. Since the clip origin @@ -566,12 +566,12 @@ void _gdk_windowing_gc_set_clip_region (GdkGC *gc, /** * _gdk_windowing_gc_copy: - * @dst_gc: a #GdkGC from the GDK backend - * @src_gc: a #GdkGC from the GDK backend + * @param dst_gc: a #GdkGC from the GDK backend + * @param src_gc: a #GdkGC from the GDK backend * - * Copies backend specific state from @src_gc to @dst_gc. + * Copies backend specific state from \p src_gc to \p dst_gc. * This is called before the generic state is copied, so - * the old generic state is still available from @dst_gc + * the old generic state is still available from \p dst_gc **/ void _gdk_windowing_gc_copy (GdkGC *dst_gc, GdkGC *src_gc); diff --git a/libs/tk/ydk/ydk/gdk/gdkpango.h b/libs/tk/ydk/ydk/gdk/gdkpango.h index 39ca22add5..300aae6c03 100644 --- a/libs/tk/ydk/ydk/gdk/gdkpango.h +++ b/libs/tk/ydk/ydk/gdk/gdkpango.h @@ -44,7 +44,7 @@ typedef struct _GdkPangoRendererPrivate GdkPangoRendererPrivate; /** * GdkPangoRenderer: * - * #GdkPangoRenderer is a subclass of #PangoRenderer used for rendering + * GdkPangoRenderer is a subclass of PangoRenderer used for rendering * Pango objects into GDK drawables. The default renderer for a particular * screen is obtained with gdk_pango_renderer_get_default(); Pango * functions like pango_renderer_draw_layout() and diff --git a/libs/tk/ydkmm/ydkmm/gdkmm/display.h b/libs/tk/ydkmm/ydkmm/gdkmm/display.h index 94e2f85e07..db9a4d3567 100644 --- a/libs/tk/ydkmm/ydkmm/gdkmm/display.h +++ b/libs/tk/ydkmm/ydkmm/gdkmm/display.h @@ -527,7 +527,7 @@ public: /** Looks up the Gdk::Pixmap that wraps the given native pixmap handle. * * For example in the X backend, a native pixmap handle is an Xlib - * XID. + * XID. * * @param anid A native pixmap handle. * @return The Gdk::Pixmap wrapper for the native pixmap, @@ -538,7 +538,7 @@ public: /** Looks up the Gdk::Pixmap that wraps the given native pixmap handle. * * For example in the X backend, a native pixmap handle is an Xlib - * XID. + * XID. * * @param anid A native pixmap handle. * @return The Gdk::Pixmap wrapper for the native pixmap, diff --git a/libs/tk/ydkmm/ydkmm/gdkmm/pixbuf.h b/libs/tk/ydkmm/ydkmm/gdkmm/pixbuf.h index de9e75cc99..8797282f29 100644 --- a/libs/tk/ydkmm/ydkmm/gdkmm/pixbuf.h +++ b/libs/tk/ydkmm/ydkmm/gdkmm/pixbuf.h @@ -311,7 +311,7 @@ protected: * image data from a server-side drawable to a client-side RGB(A) buffer. * This allows you to efficiently read individual pixels on the client side. * - * If the drawable @src has no colormap (See Gdk::Drawable::get_colormap()), + * If the drawable \p src has no colormap (See Gdk::Drawable::get_colormap()), * then a suitable colormap must be specified. Otherwise, you may use the * constructor that takes no colormap argument. * Typically a Gdk::Window or a pixmap created by passing a Gdk:Window @@ -433,7 +433,7 @@ public: * image data from a server-side drawable to a client-side RGB(A) buffer. * This allows you to efficiently read individual pixels on the client side. * - * If the drawable @src has no colormap (See Gdk::Drawable::get_colormap()), + * If the drawable \p src has no colormap (See Gdk::Drawable::get_colormap()), * then a suitable colormap must be specified. Otherwise, you may use the * constructor that takes no colormap argument. * Typically a Gdk::Window or a pixmap created by passing a Gdk:Window @@ -667,7 +667,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 \p 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; diff --git a/libs/tk/ytk/ytk/gtk/gtkaboutdialog.h b/libs/tk/ytk/ytk/gtk/gtkaboutdialog.h index 4fd9986ee7..53e231c300 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 GtkAboutDialog struct contains + * The \struct GtkAboutDialog struct contains * only private fields and should not be directly accessed. */ struct _GtkAboutDialog @@ -128,9 +128,9 @@ void gtk_about_dialog_set_logo_icon_name (GtkAboutDialog /** * GtkAboutDialogActivateLinkFunc: - * @about: the #GtkAboutDialog in which the link was activated - * @link_: the URL or email address to which the activated link points - * @data: user data that was passed when the function was registered + * @param about: the #GtkAboutDialog in which the link was activated + * @param link_: the URL or email address to which the activated link points + * @param data: user data that was passed when the function was registered * with gtk_about_dialog_set_email_hook() or * gtk_about_dialog_set_url_hook() * diff --git a/libs/tk/ytk/ytk/gtk/gtkaccelgroup.h b/libs/tk/ytk/ytk/gtk/gtkaccelgroup.h index f78e8bbbfd..1bc32b41c7 100644 --- a/libs/tk/ytk/ytk/gtk/gtkaccelgroup.h +++ b/libs/tk/ytk/ytk/gtk/gtkaccelgroup.h @@ -68,9 +68,9 @@ typedef gboolean (*GtkAccelGroupActivate) (GtkAccelGroup *accel_group, /** * GtkAccelGroupFindFunc: - * @key: - * @closure: - * @data: + * @param key: + * @param closure: + * @param data: * * Since: 2.2 */ diff --git a/libs/tk/ytk/ytk/gtk/gtkactivatable.h b/libs/tk/ytk/ytk/gtk/gtkactivatable.h index 94114923c7..02a32cfb79 100644 --- a/libs/tk/ytk/ytk/gtk/gtkactivatable.h +++ b/libs/tk/ytk/ytk/gtk/gtkactivatable.h @@ -42,13 +42,16 @@ typedef struct _GtkActivatableIface GtkActivatableIface; /** * GtkActivatableIface: - * @update: Called to update the activatable when its related action's properties change. + * @param update: Called to update the activatable when its related action's properties change. * You must check the #GtkActivatable:use-action-appearance property only apply action * properties that are meant to effect the appearance accordingly. - * @sync_action_properties: Called to update the activatable completely, this is called internally when - * #GtkActivatable::related-action property is set or unset and by the implementor when - * #GtkActivatable::use-action-appearance changes.This method can be called - * with a %NULL action at times + * @param sync_action_properties: Called to update the activatable completely, this is called internally when + * GtkActivatable::related-action property is set or unset and by the implementor when + * GtkActivatable::use-action-appearance changes. + * + * \note + * This method can be called + * with a %NULL action at times * * Since: 2.16 */ diff --git a/libs/tk/ytk/ytk/gtk/gtkassistant.h b/libs/tk/ytk/ytk/gtk/gtkassistant.h index 41c3b5e631..d6a3ee152e 100644 --- a/libs/tk/ytk/ytk/gtk/gtkassistant.h +++ b/libs/tk/ytk/ytk/gtk/gtkassistant.h @@ -43,14 +43,14 @@ G_BEGIN_DECLS /** * GtkAssistantPageType: - * @GTK_ASSISTANT_PAGE_CONTENT: The page has regular contents. - * @GTK_ASSISTANT_PAGE_INTRO: The page contains an introduction to the + * @param GTK_ASSISTANT_PAGE_CONTENT: The page has regular contents. + * @param GTK_ASSISTANT_PAGE_INTRO: The page contains an introduction to the * assistant task. - * @GTK_ASSISTANT_PAGE_CONFIRM: The page lets the user confirm or deny the + * @param GTK_ASSISTANT_PAGE_CONFIRM: The page lets the user confirm or deny the * changes. - * @GTK_ASSISTANT_PAGE_SUMMARY: The page informs the user of the changes + * @param GTK_ASSISTANT_PAGE_SUMMARY: The page informs the user of the changes * done. - * @GTK_ASSISTANT_PAGE_PROGRESS: Used for tasks that take a long time to + * @param GTK_ASSISTANT_PAGE_PROGRESS: Used for tasks that take a long time to * complete, blocks the assistant until the page is marked as complete. * * An enum for determining the page role inside the #GtkAssistant. It's @@ -107,8 +107,8 @@ struct _GtkAssistantClass /** * GtkAssistantPageFunc: - * @current_page: The page number used to calculate the next page. - * @data: user data. + * @param current_page: The page number used to calculate the next page. + * @param data: user data. * * A function used by gtk_assistant_set_forward_page_func() to know which * is the next page given a current one. It's called both for computing the diff --git a/libs/tk/ytk/ytk/gtk/gtkbox.h b/libs/tk/ytk/ytk/gtk/gtkbox.h index 6967687cdc..f389da33ef 100644 --- a/libs/tk/ytk/ytk/gtk/gtkbox.h +++ b/libs/tk/ytk/ytk/gtk/gtkbox.h @@ -66,18 +66,18 @@ struct _GtkBoxClass /** * GtkBoxChild: - * @widget: the child widget, packed into the GtkBox. - * @padding: the number of extra pixels to put between this child and its + * @param widget: the child widget, packed into the GtkBox. + * @param padding: the number of extra pixels to put between this child and its * neighbors, set when packed, zero by default. - * @expand: flag indicates whether extra space should be given to this child. + * @param expand: flag indicates whether extra space should be given to this child. * Any extra space given to the parent GtkBox is divided up among all children * with this attribute set to %TRUE; set when packed, %TRUE by default. - * @fill: flag indicates whether any extra space given to this child due to its - * @expand attribute being set is actually allocated to the child, rather than + * @param fill: flag indicates whether any extra space given to this child due to its + * \p expand attribute being set is actually allocated to the child, rather than * being used as padding around the widget; set when packed, %TRUE by default. - * @pack: one of #GtkPackType indicating whether the child is packed with + * @param pack: one of #GtkPackType indicating whether the child is packed with * reference to the start (top/left) or end (bottom/right) of the GtkBox. - * @is_secondary: %TRUE if the child is secondary + * @param is_secondary: %TRUE if the child is secondary * * The #GtkBoxChild holds a child widget of #GtkBox and describes how the child * is to be packed into the #GtkBox. All fields of this #GtkBoxChild should be diff --git a/libs/tk/ytk/ytk/gtk/gtkbuildable.h b/libs/tk/ytk/ytk/gtk/gtkbuildable.h index 78a46173db..0eaecfd2db 100644 --- a/libs/tk/ytk/ytk/gtk/gtkbuildable.h +++ b/libs/tk/ytk/ytk/gtk/gtkbuildable.h @@ -42,45 +42,45 @@ typedef struct _GtkBuildableIface GtkBuildableIface; /** * GtkBuildableIface: - * @g_iface: the parent class - * @set_name: Stores the name attribute given in the GtkBuilder UI definition. + * @param g_iface: the parent class + * @param set_name: Stores the name attribute given in the GtkBuilder UI definition. * #GtkWidget stores the name as object data. Implement this method if your * object has some notion of "name" and it makes sense to map the XML name * attribute to it. - * @get_name: The getter corresponding to @set_name. Implement this - * if you implement @set_name. - * @add_child: Adds a child. The @type parameter can be used to + * @param get_name: The getter corresponding to \p set_name. Implement this + * if you implement \p set_name. + * @param add_child: Adds a child. The \p type parameter can be used to * differentiate the kind of child. #GtkContainer implements this * to add add a child widget to the container, #GtkNotebook uses - * the @type to distinguish between page labels (of type "page-label") + * the \p type to distinguish between page labels (of type "page-label") * and normal children. - * @set_buildable_property: Sets a property of a buildable object. + * @param set_buildable_property: Sets a property of a buildable object. * It is normally not necessary to implement this, g_object_set_property() * is used by default. #GtkWindow implements this to delay showing itself * (i.e. setting the #GtkWidget:visible property) until the whole interface * is created. - * @construct_child: Constructs a child of a buildable that has been + * @param construct_child: Constructs a child of a buildable that has been * specified as "constructor" in the UI definition. #GtkUIManager implements * this to reference to a widget created in a <ui> tag which is outside * of the normal GtkBuilder UI definition hierarchy. A reference to the * constructed object is returned and becomes owned by the caller. - * @custom_tag_start: Implement this if the buildable needs to parse + * @param custom_tag_start: Implement this if the buildable needs to parse * content below <child>. To handle an element, the implementation - * must fill in the @parser structure and @user_data and return %TRUE. + * must fill in the \p parser structure and \p user_data and return %TRUE. * #GtkWidget implements this to parse keyboard accelerators specified * in <accelerator> elements. #GtkContainer implements it to map * properties defined via <packing> elements to child properties. - * Note that @user_data must be freed in @custom_tag_end or @custom_finished. - * @custom_tag_end: Called for the end tag of each custom element that is - * handled by the buildable (see @custom_tag_start). - * @custom_finished: Called for each custom tag handled by the buildable - * when the builder finishes parsing (see @custom_tag_start) - * @parser_finished: Called when a builder finishes the parsing + * Note that \p user_data must be freed in \p custom_tag_end or \p custom_finished. + * @param custom_tag_end: Called for the end tag of each custom element that is + * handled by the buildable (see \p custom_tag_start). + * @param custom_finished: Called for each custom tag handled by the buildable + * when the builder finishes parsing (see \p custom_tag_start) + * @param parser_finished: Called when a builder finishes the parsing * of a UI definition. It is normally not necessary to implement this, * unless you need to perform special cleanup actions. #GtkWindow sets * the #GtkWidget:visible property here. - * @get_internal_child: Returns an internal child of a buildable. - * #GtkDialog implements this to give access to its @vbox, making + * @param get_internal_child: Returns an internal child of a buildable. + * #GtkDialog implements this to give access to its \p vbox, making * it possible to add children to the vbox in a UI definition. * Implement this if the buildable has internal children that may * need to be accessed from a UI definition. diff --git a/libs/tk/ytk/ytk/gtk/gtkenums.h b/libs/tk/ytk/ytk/gtk/gtkenums.h index 29241362bf..5860021832 100644 --- a/libs/tk/ytk/ytk/gtk/gtkenums.h +++ b/libs/tk/ytk/ytk/gtk/gtkenums.h @@ -210,11 +210,11 @@ typedef enum /** * GtkMessageType: - * @GTK_MESSAGE_INFO: Informational message - * @GTK_MESSAGE_WARNING: Nonfatal warning message - * @GTK_MESSAGE_QUESTION: Question requiring a choice - * @GTK_MESSAGE_ERROR: Fatal error message - * @GTK_MESSAGE_OTHER: None of the above, doesn't get an icon + * @param GTK_MESSAGE_INFO: Informational message + * @param GTK_MESSAGE_WARNING: Nonfatal warning message + * @param GTK_MESSAGE_QUESTION: Question requiring a choice + * @param GTK_MESSAGE_ERROR: Fatal error message + * @param GTK_MESSAGE_OTHER: None of the above, doesn't get an icon * * The type of message being displayed in the dialog. */ diff --git a/libs/tk/ytk/ytk/gtk/gtkfilechooser.h b/libs/tk/ytk/ytk/gtk/gtkfilechooser.h index aa27be4357..7680daa532 100644 --- a/libs/tk/ytk/ytk/gtk/gtkfilechooser.h +++ b/libs/tk/ytk/ytk/gtk/gtkfilechooser.h @@ -38,15 +38,15 @@ typedef struct _GtkFileChooser GtkFileChooser; /** * GtkFileChooserAction: - * @GTK_FILE_CHOOSER_ACTION_OPEN: Indicates open mode. The file chooser + * @param GTK_FILE_CHOOSER_ACTION_OPEN: Indicates open mode. The file chooser * will only let the user pick an existing file. - * @GTK_FILE_CHOOSER_ACTION_SAVE: Indicates save mode. The file chooser + * @param GTK_FILE_CHOOSER_ACTION_SAVE: Indicates save mode. The file chooser * will let the user pick an existing file, or type in a new * filename. - * @GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER: Indicates an Open mode for + * @param GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER: Indicates an Open mode for * selecting folders. The file chooser will let the user pick an * existing folder. - * @GTK_FILE_CHOOSER_ACTION_CREATE_FOLDER: Indicates a mode for creating a + * @param GTK_FILE_CHOOSER_ACTION_CREATE_FOLDER: Indicates a mode for creating a * new folder. The file chooser will let the user name an existing or * new folder. * @@ -63,15 +63,15 @@ typedef enum /** * GtkFileChooserConfirmation: - * @GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM: The file chooser will present + * @param GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM: The file chooser will present * its stock dialog to confirm about overwriting an existing file. - * @GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME: The file chooser will + * @param GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME: The file chooser will * terminate and accept the user's choice of a file name. - * @GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN: The file chooser will + * @param GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN: The file chooser will * continue running, so as to let the user select another file name. * * Used as a return value of handlers for the - * #GtkFileChooser::confirm-overwrite signal of a #GtkFileChooser. This + * GtkFileChooser::confirm-overwrite signal of a #GtkFileChooser. This * value determines whether the file chooser will present the stock * confirmation dialog, accept the user's choice of a filename, or * let the user choose another filename. @@ -91,17 +91,17 @@ GType gtk_file_chooser_get_type (void) G_GNUC_CONST; /** * GTK_FILE_CHOOSER_ERROR: * - * Used to get the #GError quark for #GtkFileChooser errors. + * Used to get the GError quark for #GtkFileChooser errors. */ #define GTK_FILE_CHOOSER_ERROR (gtk_file_chooser_error_quark ()) /** * GtkFileChooserError: - * @GTK_FILE_CHOOSER_ERROR_NONEXISTENT: Indicates that a file does not exist. - * @GTK_FILE_CHOOSER_ERROR_BAD_FILENAME: Indicates a malformed filename. - * @GTK_FILE_CHOOSER_ERROR_ALREADY_EXISTS: Indicates a duplicate path (e.g. when + * @param GTK_FILE_CHOOSER_ERROR_NONEXISTENT: Indicates that a file does not exist. + * @param GTK_FILE_CHOOSER_ERROR_BAD_FILENAME: Indicates a malformed filename. + * @param GTK_FILE_CHOOSER_ERROR_ALREADY_EXISTS: Indicates a duplicate path (e.g. when * adding a bookmark). - * @GTK_FILE_CHOOSER_ERROR_INCOMPLETE_HOSTNAME: Indicates an incomplete hostname (e.g. "http://foo" without a slash after that). + * @param GTK_FILE_CHOOSER_ERROR_INCOMPLETE_HOSTNAME: Indicates an incomplete hostname (e.g. "http://foo" without a slash after that). * * These identify the various errors that can occur while calling * #GtkFileChooser functions. diff --git a/libs/tk/ytk/ytk/gtk/gtkicontheme.h b/libs/tk/ytk/ytk/gtk/gtkicontheme.h index 3611c7401f..92b2fd2567 100644 --- a/libs/tk/ytk/ytk/gtk/gtkicontheme.h +++ b/libs/tk/ytk/ytk/gtk/gtkicontheme.h @@ -60,19 +60,19 @@ struct _GtkIconThemeClass /** * GtkIconLookupFlags: - * @GTK_ICON_LOOKUP_NO_SVG: Never return SVG icons, even if gdk-pixbuf + * @param GTK_ICON_LOOKUP_NO_SVG: Never return SVG icons, even if gdk-pixbuf * supports them. Cannot be used together with %GTK_ICON_LOOKUP_FORCE_SVG. - * @GTK_ICON_LOOKUP_FORCE_SVG: Return SVG icons, even if gdk-pixbuf + * @param GTK_ICON_LOOKUP_FORCE_SVG: Return SVG icons, even if gdk-pixbuf * doesn't support them. * Cannot be used together with %GTK_ICON_LOOKUP_NO_SVG. - * @GTK_ICON_LOOKUP_USE_BUILTIN: When passed to + * @param GTK_ICON_LOOKUP_USE_BUILTIN: When passed to * gtk_icon_theme_lookup_icon() includes builtin icons * as well as files. For a builtin icon, gtk_icon_info_get_filename() * returns %NULL and you need to call gtk_icon_info_get_builtin_pixbuf(). - * @GTK_ICON_LOOKUP_GENERIC_FALLBACK: Try to shorten icon name at '-' + * @param GTK_ICON_LOOKUP_GENERIC_FALLBACK: Try to shorten icon name at '-' * characters before looking at inherited themes. For more general * fallback, see gtk_icon_theme_choose_icon(). Since 2.12. - * @GTK_ICON_LOOKUP_FORCE_SIZE: Always return the icon scaled to the + * @param GTK_ICON_LOOKUP_FORCE_SIZE: Always return the icon scaled to the * requested size. Since 2.14. * * Used to specify options for gtk_icon_theme_lookup_icon() @@ -90,8 +90,8 @@ typedef enum /** * GtkIconThemeError: - * @GTK_ICON_THEME_NOT_FOUND: The icon specified does not exist in the theme - * @GTK_ICON_THEME_FAILED: An unspecified error occurred. + * @param GTK_ICON_THEME_NOT_FOUND: The icon specified does not exist in the theme + * @param GTK_ICON_THEME_FAILED: An unspecified error occurred. * * Error codes for GtkIconTheme operations. **/ diff --git a/libs/tk/ytk/ytk/gtk/gtkimage.h b/libs/tk/ytk/ytk/gtk/gtkimage.h index e40ed71002..28a252e062 100644 --- a/libs/tk/ytk/ytk/gtk/gtkimage.h +++ b/libs/tk/ytk/ytk/gtk/gtkimage.h @@ -106,16 +106,16 @@ struct _GtkImageGIconData /** * GtkImageType: - * @GTK_IMAGE_EMPTY: there is no image displayed by the widget - * @GTK_IMAGE_PIXMAP: the widget contains a #GdkPixmap - * @GTK_IMAGE_IMAGE: the widget contains a #GdkImage - * @GTK_IMAGE_PIXBUF: the widget contains a #GdkPixbuf - * @GTK_IMAGE_STOCK: the widget contains a stock icon name (see ) - * @GTK_IMAGE_ICON_SET: the widget contains a #GtkIconSet - * @GTK_IMAGE_ANIMATION: the widget contains a #GdkPixbufAnimation - * @GTK_IMAGE_ICON_NAME: the widget contains a named icon. + * @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_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_ICON_NAME: the widget contains a named icon. * This image type was added in GTK+ 2.6 - * @GTK_IMAGE_GICON: the widget contains a #GIcon. + * @param GTK_IMAGE_GICON: the widget contains a GIcon. * This image type was added in GTK+ 2.14 * * Describes the image data representation used by a #GtkImage. If you diff --git a/libs/tk/ytk/ytk/gtk/gtkmessagedialog.h b/libs/tk/ytk/ytk/gtk/gtkmessagedialog.h index b65078c247..5fd15a9c61 100644 --- a/libs/tk/ytk/ytk/gtk/gtkmessagedialog.h +++ b/libs/tk/ytk/ytk/gtk/gtkmessagedialog.h @@ -70,21 +70,21 @@ struct _GtkMessageDialogClass /** * GtkButtonsType: - * @GTK_BUTTONS_NONE: no buttons at all - * @GTK_BUTTONS_OK: an OK button - * @GTK_BUTTONS_CLOSE: a Close button - * @GTK_BUTTONS_CANCEL: a Cancel button - * @GTK_BUTTONS_YES_NO: Yes and No buttons - * @GTK_BUTTONS_OK_CANCEL: OK and Cancel buttons + * @param GTK_BUTTONS_NONE: no buttons at all + * @param GTK_BUTTONS_OK: an OK button + * @param GTK_BUTTONS_CLOSE: a Close button + * @param GTK_BUTTONS_CANCEL: a Cancel button + * @param GTK_BUTTONS_YES_NO: Yes and No buttons + * @param GTK_BUTTONS_OK_CANCEL: OK and Cancel buttons * * Prebuilt sets of buttons for the dialog. If * none of these choices are appropriate, simply use %GTK_BUTTONS_NONE * then call gtk_dialog_add_buttons(). - * + * + * \note * Please note that %GTK_BUTTONS_OK, %GTK_BUTTONS_YES_NO - * and %GTK_BUTTONS_OK_CANCEL are discouraged by the - * GNOME HIG. - * + * and %GTK_BUTTONS_OK_CANCEL are discouraged by the GNOME HIG. + * */ typedef enum { diff --git a/libs/tk/ytk/ytk/gtk/gtkobject.h b/libs/tk/ytk/ytk/gtk/gtkobject.h index 97f1efaa52..8b877b7910 100644 --- a/libs/tk/ytk/ytk/gtk/gtkobject.h +++ b/libs/tk/ytk/ytk/gtk/gtkobject.h @@ -56,7 +56,7 @@ G_BEGIN_DECLS #ifndef GTK_DISABLE_DEPRECATED /** * GTK_OBJECT_TYPE: - * @object: a #GtkObject. + * @param object: a #GtkObject. * * Gets the type of an object. * @@ -65,7 +65,7 @@ G_BEGIN_DECLS #define GTK_OBJECT_TYPE G_OBJECT_TYPE /** * GTK_OBJECT_TYPE_NAME: - * @object: a #GtkObject. + * @param object: a #GtkObject. * * Gets the name of an object's type. * diff --git a/libs/tk/ytk/ytk/gtk/gtkrecentchooser.h b/libs/tk/ytk/ytk/gtk/gtkrecentchooser.h index 8df0cb2c0f..130084c4a6 100644 --- a/libs/tk/ytk/ytk/gtk/gtkrecentchooser.h +++ b/libs/tk/ytk/ytk/gtk/gtkrecentchooser.h @@ -39,13 +39,13 @@ G_BEGIN_DECLS /** * GtkRecentSortType: - * @GTK_RECENT_SORT_NONE: Do not sort the returned list of recently used + * @param GTK_RECENT_SORT_NONE: Do not sort the returned list of recently used * resources. - * @GTK_RECENT_SORT_MRU: Sort the returned list with the most recently used + * @param GTK_RECENT_SORT_MRU: Sort the returned list with the most recently used * items first. - * @GTK_RECENT_SORT_LRU: Sort the returned list with the least recently used + * @param GTK_RECENT_SORT_LRU: Sort the returned list with the least recently used * items first. - * @GTK_RECENT_SORT_CUSTOM: Sort the returned list using a custom sorting + * @param GTK_RECENT_SORT_CUSTOM: Sort the returned list using a custom sorting * function passed using gtk_recent_manager_set_sort_func(). * * Used to specify the sorting method to be applyed to the recently diff --git a/libs/tk/ytk/ytk/gtk/gtkrecentmanager.h b/libs/tk/ytk/ytk/gtk/gtkrecentmanager.h index 10dd2eebb0..5bb97e69ba 100644 --- a/libs/tk/ytk/ytk/gtk/gtkrecentmanager.h +++ b/libs/tk/ytk/ytk/gtk/gtkrecentmanager.h @@ -48,19 +48,19 @@ typedef struct _GtkRecentManagerPrivate GtkRecentManagerPrivate; /** * GtkRecentData: - * @display_name: a UTF-8 encoded string, containing the name of the recently + * @param display_name: a UTF-8 encoded string, containing the name of the recently * used resource to be displayed, or %NULL; - * @description: a UTF-8 encoded string, containing a short description of + * @param description: a UTF-8 encoded string, containing a short description of * the resource, or %NULL; - * @mime_type: the MIME type of the resource; - * @app_name: the name of the application that is registering this recently + * @param mime_type: the MIME type of the resource; + * @param app_name: the name of the application that is registering this recently * used resource; - * @app_exec: command line used to launch this resource; may contain the + * @param app_exec: command line used to launch this resource; may contain the * "%f" and "%u" escape characters which will be expanded * to the resource file path and URI respectively when the command line * is retrieved; - * @groups: a vector of strings containing groups names; - * @is_private: whether this resource should be displayed only by the + * @param groups: a vector of strings containing groups names; + * @param is_private: whether this resource should be displayed only by the * applications that have registered it or not. * * Meta-data to be passed to gtk_recent_manager_add_full() when @@ -105,18 +105,18 @@ struct _GtkRecentManagerClass /** * GtkRecentManagerError: - * @GTK_RECENT_MANAGER_ERROR_NOT_FOUND: the URI specified does not exists in + * @param GTK_RECENT_MANAGER_ERROR_NOT_FOUND: the URI specified does not exists in * the recently used resources list. - * @GTK_RECENT_MANAGER_ERROR_INVALID_URI: the URI specified is not valid. - * @GTK_RECENT_MANAGER_ERROR_INVALID_ENCODING: the supplied string is not + * @param GTK_RECENT_MANAGER_ERROR_INVALID_URI: the URI specified is not valid. + * @param GTK_RECENT_MANAGER_ERROR_INVALID_ENCODING: the supplied string is not * UTF-8 encoded. - * @GTK_RECENT_MANAGER_ERROR_NOT_REGISTERED: no application has registered + * @param GTK_RECENT_MANAGER_ERROR_NOT_REGISTERED: no application has registered * the specified item. - * @GTK_RECENT_MANAGER_ERROR_READ: failure while reading the recently used + * @param GTK_RECENT_MANAGER_ERROR_READ: failure while reading the recently used * resources file. - * @GTK_RECENT_MANAGER_ERROR_WRITE: failure while writing the recently used + * @param GTK_RECENT_MANAGER_ERROR_WRITE: failure while writing the recently used * resources file. - * @GTK_RECENT_MANAGER_ERROR_UNKNOWN: unspecified error. + * @param GTK_RECENT_MANAGER_ERROR_UNKNOWN: unspecified error. * * Error codes for GtkRecentManager operations **/ diff --git a/libs/tk/ytk/ytk/gtk/gtksizegroup.h b/libs/tk/ytk/ytk/gtk/gtksizegroup.h index f1ff8b1f9e..87e68d3cf4 100644 --- a/libs/tk/ytk/ytk/gtk/gtksizegroup.h +++ b/libs/tk/ytk/ytk/gtk/gtksizegroup.h @@ -69,10 +69,10 @@ struct _GtkSizeGroupClass /** * GtkSizeGroupMode: - * @GTK_SIZE_GROUP_NONE: group has no effect - * @GTK_SIZE_GROUP_HORIZONTAL: group affects horizontal requisition - * @GTK_SIZE_GROUP_VERTICAL: group affects vertical requisition - * @GTK_SIZE_GROUP_BOTH: group affects both horizontal and vertical requisition + * @param GTK_SIZE_GROUP_NONE: group has no effect + * @param GTK_SIZE_GROUP_HORIZONTAL: group affects horizontal requisition + * @param GTK_SIZE_GROUP_VERTICAL: group affects vertical requisition + * @param GTK_SIZE_GROUP_BOTH: group affects both horizontal and vertical requisition * * The mode of the size group determines the directions in which the size * group affects the requested sizes of its component widgets. diff --git a/libs/tk/ytk/ytk/gtk/gtktoolpalette.h b/libs/tk/ytk/ytk/gtk/gtktoolpalette.h index 90aa701e4e..0959d45e2e 100644 --- a/libs/tk/ytk/ytk/gtk/gtktoolpalette.h +++ b/libs/tk/ytk/ytk/gtk/gtktoolpalette.h @@ -45,8 +45,8 @@ typedef struct _GtkToolPalettePrivate GtkToolPalettePrivate; /** * GtkToolPaletteDragTargets: - * @GTK_TOOL_PALETTE_DRAG_ITEMS: Support drag of items. - * @GTK_TOOL_PALETTE_DRAG_GROUPS: Support drag of groups. + * @param GTK_TOOL_PALETTE_DRAG_ITEMS: Support drag of items. + * @param GTK_TOOL_PALETTE_DRAG_GROUPS: Support drag of groups. * * Flags used to specify the supported drag targets. */ diff --git a/libs/tk/ytk/ytk/gtk/gtktoolshell.h b/libs/tk/ytk/ytk/gtk/gtktoolshell.h index 6cf3db5ae6..c4c4d60fca 100644 --- a/libs/tk/ytk/ytk/gtk/gtktoolshell.h +++ b/libs/tk/ytk/ytk/gtk/gtktoolshell.h @@ -45,15 +45,15 @@ typedef struct _GtkToolShellIface GtkToolShellIface; /** * GtkToolShellIface: - * @get_icon_size: mandatory implementation of gtk_tool_shell_get_icon_size(). - * @get_orientation: mandatory implementation of gtk_tool_shell_get_orientation(). - * @get_style: mandatory implementation of gtk_tool_shell_get_style(). - * @get_relief_style: optional implementation of gtk_tool_shell_get_relief_style(). - * @rebuild_menu: optional implementation of gtk_tool_shell_rebuild_menu(). - * @get_text_orientation: optional implementation of gtk_tool_shell_get_text_orientation(). - * @get_text_alignment: optional implementation of gtk_tool_shell_get_text_alignment(). - * @get_ellipsize_mode: optional implementation of gtk_tool_shell_get_ellipsize_mode(). - * @get_text_size_group: optional implementation of gtk_tool_shell_get_text_size_group(). + * @param get_icon_size: mandatory implementation of gtk_tool_shell_get_icon_size(). + * @param get_orientation: mandatory implementation of gtk_tool_shell_get_orientation(). + * @param get_style: mandatory implementation of gtk_tool_shell_get_style(). + * @param get_relief_style: optional implementation of gtk_tool_shell_get_relief_style(). + * @param rebuild_menu: optional implementation of gtk_tool_shell_rebuild_menu(). + * @param get_text_orientation: optional implementation of gtk_tool_shell_get_text_orientation(). + * @param get_text_alignment: optional implementation of gtk_tool_shell_get_text_alignment(). + * @param get_ellipsize_mode: optional implementation of gtk_tool_shell_get_ellipsize_mode(). + * @param get_text_size_group: optional implementation of gtk_tool_shell_get_text_size_group(). * * Virtual function table for the #GtkToolShell interface. */ diff --git a/libs/tk/ytk/ytk/gtk/gtkwidget.h b/libs/tk/ytk/ytk/gtk/gtkwidget.h index 1fcf21a12d..f18fa0d5eb 100644 --- a/libs/tk/ytk/ytk/gtk/gtkwidget.h +++ b/libs/tk/ytk/ytk/gtk/gtkwidget.h @@ -43,58 +43,58 @@ G_BEGIN_DECLS /** * GtkWidgetFlags: - * @GTK_TOPLEVEL: widgets without a real parent, as there are #GtkWindows and + * @param GTK_TOPLEVEL: widgets without a real parent, as there are #GtkWindow and * #GtkMenus have this flag set throughout their lifetime. * Toplevel widgets always contain their own #GdkWindow. - * @GTK_NO_WINDOW: Indicative for a widget that does not provide its 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. - * @GTK_REALIZED: Set by gtk_widget_realize(), unset by gtk_widget_unrealize(). + * @param GTK_REALIZED: Set by gtk_widget_realize(), unset by gtk_widget_unrealize(). * A realized widget has an associated #GdkWindow. - * @GTK_MAPPED: Set by gtk_widget_map(), unset by gtk_widget_unmap(). + * @param GTK_MAPPED: Set by gtk_widget_map(), unset by gtk_widget_unmap(). * Only realized widgets can be mapped. It means that gdk_window_show() * has been called on the widgets window(s). - * @GTK_VISIBLE: Set by gtk_widget_show(), unset by gtk_widget_hide(). Implies that a + * @param GTK_VISIBLE: Set by gtk_widget_show(), unset by gtk_widget_hide(). Implies that a * widget will be mapped as soon as its parent is mapped. - * @GTK_SENSITIVE: Set and unset by gtk_widget_set_sensitive(). + * @param GTK_SENSITIVE: Set and unset by gtk_widget_set_sensitive(). * The sensitivity of a widget determines whether it will receive * certain events (e.g. button or key presses). One premise for * the widget's sensitivity is to have this flag set. - * @GTK_PARENT_SENSITIVE: Set and unset by gtk_widget_set_sensitive() operations on the + * @param GTK_PARENT_SENSITIVE: Set and unset by gtk_widget_set_sensitive() operations on the * parents of the widget. * This is the second premise for the widget's sensitivity. Once * it has %GTK_SENSITIVE and %GTK_PARENT_SENSITIVE set, its state is * effectively sensitive. This is expressed (and can be examined) by * the #GTK_WIDGET_IS_SENSITIVE macro. - * @GTK_CAN_FOCUS: Determines whether a widget is able to handle focus grabs. - * @GTK_HAS_FOCUS: Set by gtk_widget_grab_focus() for widgets that also + * @param GTK_CAN_FOCUS: Determines whether a widget is able to handle focus grabs. + * @param GTK_HAS_FOCUS: Set by gtk_widget_grab_focus() for widgets that also * have %GTK_CAN_FOCUS set. The flag will be unset once another widget * grabs the focus. - * @GTK_CAN_DEFAULT: The widget is allowed to receive the default action via + * @param GTK_CAN_DEFAULT: The widget is allowed to receive the default action via * gtk_widget_grab_default() and will reserve space to draw the default if possible - * @GTK_HAS_DEFAULT: The widget currently is receiving the default action and + * @param GTK_HAS_DEFAULT: The widget currently is receiving the default action and * should be drawn appropriately if possible - * @GTK_HAS_GRAB: Set by gtk_grab_add(), unset by gtk_grab_remove(). It means that the + * @param GTK_HAS_GRAB: Set by gtk_grab_add(), unset by gtk_grab_remove(). It means that the * widget is in the grab_widgets stack, and will be the preferred one for * receiving events other than ones of cosmetic value. - * @GTK_RC_STYLE: Indicates that the widget's style has been looked up through the rc + * @param GTK_RC_STYLE: Indicates that the widget's style has been looked up through the rc * mechanism. It does not imply that the widget actually had a style * defined through the rc mechanism. - * @GTK_COMPOSITE_CHILD: Indicates that the widget is a composite child of its parent; see + * @param GTK_COMPOSITE_CHILD: Indicates that the widget is a composite child of its parent; see * gtk_widget_push_composite_child(), gtk_widget_pop_composite_child(). - * @GTK_NO_REPARENT: Unused since before GTK+ 1.2, will be removed in a future version. - * @GTK_APP_PAINTABLE: Set and unset by gtk_widget_set_app_paintable(). + * @param GTK_NO_REPARENT: Unused since before GTK+ 1.2, will be removed in a future version. + * @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 - * for a detailed + * #app-paintable-widgets for a detailed * description of this flag. - * @GTK_RECEIVES_DEFAULT: The widget when focused will receive the default action and have + * @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. - * @GTK_DOUBLE_BUFFERED: Set and unset by gtk_widget_set_double_buffered(). + * @param GTK_DOUBLE_BUFFERED: Set and unset by gtk_widget_set_double_buffered(). * Indicates that exposes done on the widget should be - * double-buffered. See for a + * double-buffered. #double-buffering" for a * detailed discussion of how double-buffering works in GTK+ and * why you may want to disable it for special cases. - * @GTK_NO_SHOW_ALL: + * @param GTK_NO_SHOW_ALL: * * Tells about certain properties of the widget. */ @@ -145,7 +145,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_TYPE: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Gets the type of a widget. * @@ -157,7 +157,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_STATE: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Returns the current state of the widget, as a #GtkStateType. * @@ -169,7 +169,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_SAVED_STATE: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Returns the saved state of the widget, as a #GtkStateType. * @@ -187,9 +187,9 @@ typedef enum */ /** * GTK_WIDGET_FLAGS: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * - * Returns the widget flags from @wid. + * Returns the widget flags from \p wid. * * Deprecated: 2.20: Use the proper function to test individual states: * gtk_widget_get_app_paintable(), gtk_widget_get_can_default(), @@ -207,7 +207,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_TOPLEVEL: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Evaluates to %TRUE if the widget is a toplevel widget. * @@ -219,7 +219,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_NO_WINDOW: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Evaluates to %TRUE if the widget doesn't have an own #GdkWindow. * @@ -231,7 +231,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_REALIZED: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Evaluates to %TRUE if the widget is realized. * @@ -243,7 +243,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_MAPPED: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Evaluates to %TRUE if the widget is mapped. * @@ -255,7 +255,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_VISIBLE: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Evaluates to %TRUE if the widget is visible. * @@ -267,7 +267,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_DRAWABLE: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Evaluates to %TRUE if the widget is mapped and visible. * @@ -279,7 +279,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_SENSITIVE: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Evaluates to %TRUE if the #GTK_SENSITIVE flag has be set on the widget. * @@ -291,7 +291,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_PARENT_SENSITIVE: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Evaluates to %TRUE if the #GTK_PARENT_SENSITIVE flag has be set on the widget. * @@ -303,7 +303,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_IS_SENSITIVE: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Evaluates to %TRUE if the widget is effectively sensitive. * @@ -316,7 +316,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_CAN_FOCUS: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Evaluates to %TRUE if the widget is able to handle focus grabs. * @@ -328,7 +328,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_HAS_FOCUS: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Evaluates to %TRUE if the widget has grabbed the focus and no other * widget has done so more recently. @@ -341,7 +341,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_CAN_DEFAULT: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Evaluates to %TRUE if the widget is allowed to receive the default action * via gtk_widget_grab_default(). @@ -354,7 +354,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_HAS_DEFAULT: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Evaluates to %TRUE if the widget currently is receiving the default action. * @@ -366,7 +366,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_HAS_GRAB: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Evaluates to %TRUE if the widget is in the grab_widgets stack, and will be * the preferred one for receiving events other than ones of cosmetic value. @@ -379,7 +379,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_RC_STYLE: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Evaluates to %TRUE if the widget's style has been looked up through the rc * mechanism. @@ -392,7 +392,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_COMPOSITE_CHILD: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Evaluates to %TRUE if the widget is a composite child of its parent. * @@ -404,7 +404,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_APP_PAINTABLE: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Evaluates to %TRUE if the #GTK_APP_PAINTABLE flag has been set on the widget. * @@ -416,7 +416,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_RECEIVES_DEFAULT: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Evaluates to %TRUE if the widget when focused will receive the default action * even if there is a different widget set as default. @@ -429,7 +429,7 @@ typedef enum #ifndef GTK_DISABLE_DEPRECATED /** * GTK_WIDGET_DOUBLE_BUFFERED: - * @wid: a #GtkWidget. + * @param wid: a #GtkWidget. * * Evaluates to %TRUE if the #GTK_DOUBLE_BUFFERED flag has been set on the widget. * @@ -443,8 +443,8 @@ typedef enum */ /** * GTK_WIDGET_SET_FLAGS: - * @wid: a #GtkWidget. - * @flag: the flags to set. + * @param wid: a #GtkWidget. + * @param flag: the flags to set. * * Turns on certain widget flags. * @@ -461,8 +461,8 @@ typedef enum /** * GTK_WIDGET_UNSET_FLAGS: - * @wid: a #GtkWidget. - * @flag: the flags to unset. + * @param wid: a #GtkWidget. + * @param flag: the flags to unset. * * Turns off certain widget flags. * @@ -486,21 +486,21 @@ typedef struct _GtkWindow GtkWindow; /** * GtkAllocation: - * @x: the X position of the widget's area relative to its parents allocation. - * @y: the Y position of the widget's area relative to its parents allocation. - * @width: the width of the widget's allocated area. - * @height: the height of the widget's allocated area. + * @param x: the X position of the widget's area relative to its parents allocation. + * @param y: the Y position of the widget's area relative to its parents allocation. + * @param width: the width of the widget's allocated area. + * @param height: the height of the widget's allocated area. * - * A GtkAllocation of a widget represents region which has been allocated to the + * 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 - * for more information. + * #size-allocation for more information. */ typedef GdkRectangle GtkAllocation; /** * GtkCallback: - * @widget: the widget to operate on - * @data: user-supplied data + * @param widget: the widget to operate on + * @param data: user-supplied data * * The type of the callback functions used for e.g. iterating over * the children of a container, see gtk_container_foreach(). @@ -510,11 +510,11 @@ typedef void (*GtkCallback) (GtkWidget *widget, /** * GtkRequisition: - * @width: the widget's desired width - * @height: the widget's desired height + * @param width: the widget's desired width + * @param height: the widget's desired height * - * A GtkRequisition represents the desired size of a widget. See - * for more information. + * A GtkRequisition represents the desired size of a widget. See + * #size-requisition for more information. */ struct _GtkRequisition { @@ -595,17 +595,17 @@ struct _GtkWidget /** * GtkWidgetClass: - * @parent_class: - * @activate_signal: - * @set_scroll_adjustments_signal: + * @param parent_class: + * @param activate_signal: + * @param set_scroll_adjustments_signal: * - * activate_signal + * activate_signal * The signal to emit when a widget of this class is activated, * gtk_widget_activate() handles the emission. Implementation of this * signal is optional. * * - * set_scroll_adjustment_signal + * set_scroll_adjustment_signal * This signal is emitted when a widget of this class is added * to a scrolling aware parent, gtk_widget_set_scroll_adjustments() * handles the emission. @@ -1067,8 +1067,8 @@ GdkPixmap * gtk_widget_get_snapshot (GtkWidget *widget, /** * gtk_widget_set_visual: - * @widget: a #GtkWidget - * @visual: a visual + * @param widget: a #GtkWidget + * @param visual: a visual * * This function is deprecated; it does nothing. */ @@ -1076,7 +1076,7 @@ GdkPixmap * gtk_widget_get_snapshot (GtkWidget *widget, /** * gtk_widget_push_visual: - * @visual: a visual + * @param visual: a visual * * This function is deprecated; it does nothing. */ @@ -1091,7 +1091,7 @@ GdkPixmap * gtk_widget_get_snapshot (GtkWidget *widget, /** * gtk_widget_set_default_visual: - * @visual: a visual + * @param visual: a visual * * This function is deprecated; it does nothing. */ @@ -1165,21 +1165,21 @@ void gtk_widget_modify_font (GtkWidget *widget, /** * gtk_widget_set_rc_style: - * @widget: a #GtkWidget. + * @param widget: a #GtkWidget. * - * Equivalent to gtk_widget_set_style (widget, NULL). + * Equivalent to gtk_widget_set_style (widget, NULL). * - * Deprecated: 2.0: Use gtk_widget_set_style() with a %NULL @style argument instead. + * Deprecated: 2.0: Use gtk_widget_set_style() with a %NULL \p style argument instead. */ #define gtk_widget_set_rc_style(widget) (gtk_widget_set_style (widget, NULL)) /** * gtk_widget_restore_default_style: - * @widget: a #GtkWidget. + * @param widget: a #GtkWidget. * - * Equivalent to gtk_widget_set_style (widget, NULL). + * Equivalent to gtk_widget_set_style (widget, NULL). * - * Deprecated: 2.0: Use gtk_widget_set_style() with a %NULL @style argument instead. + * Deprecated: 2.0: Use gtk_widget_set_style() with a %NULL \p style argument instead. */ #define gtk_widget_restore_default_style(widget) (gtk_widget_set_style (widget, NULL)) #endif diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/aboutdialog.h b/libs/tk/ytkmm/ytkmm/gtkmm/aboutdialog.h index 2f156ca564..c3610de726 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/aboutdialog.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/aboutdialog.h @@ -51,7 +51,7 @@ namespace Gtk * About dialogs often contain links and email addresses. Gtk::AboutDialog supports this by offering global * hooks, which are called when the user clicks on a link or email address, see set_email_hook() and * set_url_hook(). Email addresses in the authors, documenters and artists properties are recognized by looking - * for , URLs are recognized by looking for http://url, with the URL extending to the next space, + * 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: diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/actiongroup.h b/libs/tk/ytkmm/ytkmm/gtkmm/actiongroup.h index d88a0fc94f..b7d2cff668 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/actiongroup.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/actiongroup.h @@ -240,7 +240,7 @@ public: * @param action the action * @param proxy the proxy * - * @par Slot Prototype: + * @paragraph Slot Prototype: * void on_my_%disconnect_proxy(const Glib::RefPtr& action, Widget* proxy) * */ @@ -248,15 +248,15 @@ public: Glib::SignalProxy2< void,const Glib::RefPtr&,Widget* > signal_disconnect_proxy(); - /** The pre_activate signal is emitted just before the @action in the + /** The pre_activate signal is emitted just before the \p action in the * action_group is activated * * This is intended for UIManager to proxy the signal and provide global * notification just before any action is activated. * - * @action the action + * @param action the action * - * @par Slot Prototype: + * @paragraph Slot Prototype: * void on_my_%pre_activate(const Glib::RefPtr& action) * */ @@ -264,15 +264,15 @@ public: Glib::SignalProxy1< void,const Glib::RefPtr& > signal_pre_activate(); - /** The post_activate signal is emitted just after the @action in the - * @action_group is activated + /** The post_activate signal is emitted just after the \p action in the + * \p action_group is activated * * This is intended for UIManager to proxy the signal and provide global * notification just after any action is activated. * * @param action the action * - * @par Slot Prototype: + * @paragraph Slot Prototype: * void on_my_%post_activate(const Glib::RefPtr& action) * */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/activatable.h b/libs/tk/ytkmm/ytkmm/gtkmm/activatable.h index 1c8ad564ee..2e297dc58f 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/activatable.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/activatable.h @@ -137,9 +137,10 @@ public: * method is called when the related Gtk::Action properties change * and registers to the action's proxy list. * - * Be careful to call this before setting the local + * \note + * Be careful to call this before setting the local * copy of the Gtk::Action property, since this function uses - * gtk_activatable_get_action() to retrieve the previous action + * gtk_activatable_get_action() to retrieve the previous action * * @param action The Gtk::Action to set. */ @@ -176,8 +177,9 @@ public: /** Sets the related action on the @a activatable object. * - * Gtk::Activatable implementors need to handle the Gtk::Activatable::property_related_action() - * property and call do_set_related_action() when it changes. + * \note + * Gtk::Activatable implementors need to handle the Gtk::Activatable::property_related_action() + * property and call do_set_related_action() when it changes. * * @param action The Gtk::Action to set. */ @@ -186,10 +188,11 @@ public: /** Sets whether this activatable should reset its layout and appearance * when setting the related action or when the action changes appearance * - * Gtk::Activatable implementors need to handle the + * \note + * Gtk::Activatable implementors need to handle the * Gtk::Activatable::property_use_action_appearance() property and call * sync_action_properties() to update @a activatable - * if needed. + * if needed. * * @param use_appearance Whether to use the actions appearance. */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/builder.h b/libs/tk/ytkmm/ytkmm/gtkmm/builder.h index 2219a33e03..2b228c4378 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/builder.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/builder.h @@ -275,7 +275,7 @@ public: * GtkTreeModel), you have to explicitely list all of them. * * @param buffer The file 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, Glib::MarkupError */ @@ -290,7 +290,7 @@ public: * GtkTreeModel), you have to explicitely list all of them. * * @param buffer The file 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, Glib::MarkupError */ @@ -305,11 +305,10 @@ public: * Error from the Gtk::BUILDER_ERROR, MARKUP_ERROR or FILE_ERROR * domain. * - * + * \note * If you are adding an object that depends on an object that is not * its child (for instance a Gtk::TreeView that depends on its * Gtk::TreeModel), you have to explicitely list all of them in @a object_ids. - * * * @param filename The name of the file to parse. * @param object_ids Nul-terminated array of objects to build. @@ -333,7 +332,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 */ @@ -344,7 +343,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 */ @@ -355,7 +354,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_id The objects to build. * @result true on success or false if an error occurred. * @throws BuilderError, Glib::MarkupError */ @@ -366,7 +365,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 \p buffer is nul-terminated). * @result true on success or false if an error occurred. * @throws BuilderError, Glib::MarkupError */ diff --git a/libs/tk/ytkmm/ytkmm/gtkmm/toolitem.h b/libs/tk/ytkmm/ytkmm/gtkmm/toolitem.h index 0117d11f4d..6f0181dc03 100644 --- a/libs/tk/ytkmm/ytkmm/gtkmm/toolitem.h +++ b/libs/tk/ytkmm/ytkmm/gtkmm/toolitem.h @@ -423,20 +423,20 @@ public: /** This signal is emitted when the toolbar needs information from @tool_item * about whether the item should appear in the toolbar overflow menu. In * response the tool item should either - * - * call set_proxy_menu_item() with a NULL + *
    + *
  • call set_proxy_menu_item() with a NULL * pointer and return true to indicate that the item should not appear * in the overflow menu - * - * call set_proxy_menu_item() with a new menu + *
    • + *
  • call set_proxy_menu_item() with a new menu * item and return true, or - * - * return false to indicate that the signal was not + *
    • + *
  • return false to indicate that the signal was not * handled by the item. This means that * the item will not appear in the overflow menu unless a later handler * installs a menu item. - * - * + *
    • + *
* * The toolbar may cache the result of this signal. When the tool item changes * how it will respond to this signal it must call rebuild_menu() @@ -456,12 +456,12 @@ public: /** This signal is emitted when some property of the toolbar that the * item is a child of changes. For custom subclasses of ToolItem, * the default handler of this signal use the functions - * - * Toolbar::get_orientation() - * Toolbar::get_style() - * Toolbar::get_icon_size() - * Toolbar::get_relief_style() - * + *
    + *
  • Toolbar::get_orientation()
    • + *
  • Toolbar::get_style()
    • + *
  • Toolbar::get_icon_size()
    • + *
  • Toolbar::get_relief_style()
    • + *
* to find out what the toolbar should look like and change * themselves accordingly. *