From 8190f0c4202a99b2df590f9d7cacab235cb43a76 Mon Sep 17 00:00:00 2001 From: David Lechner Date: Sat, 7 Nov 2020 17:46:26 +0000 Subject: [PATCH] gtk/enums: fix doc comment references Enum members need a "%" prefix rather than "@" or "%@" in order to automatically create links in the documentation. --- gtk/gtkbuilderscope.h | 2 +- gtk/gtkenums.h | 20 ++++++++++---------- gtk/gtkeventcontroller.c | 2 +- gtk/gtkfilter.h | 4 ++-- gtk/gtktreeviewcolumn.h | 2 +- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/gtk/gtkbuilderscope.h b/gtk/gtkbuilderscope.h index e08adaf6fc..2b987f3822 100644 --- a/gtk/gtkbuilderscope.h +++ b/gtk/gtkbuilderscope.h @@ -41,7 +41,7 @@ G_DECLARE_INTERFACE (GtkBuilderScope, gtk_builder_scope, GTK, BUILDER_SCOPE, GOb * The list of flags that can be passed to gtk_builder_create_closure(). * New values may be added in the future for new features, so external * implementations of GtkBuilderScopeInterface should test the flags for unknown - * values and raise a %@GTK_BUILDER_ERROR_INVALID_ATTRIBUTE error when they + * values and raise a %GTK_BUILDER_ERROR_INVALID_ATTRIBUTE error when they * encounter one. */ typedef enum { diff --git a/gtk/gtkenums.h b/gtk/gtkenums.h index 9a64124c49..96989351cd 100644 --- a/gtk/gtkenums.h +++ b/gtk/gtkenums.h @@ -64,12 +64,12 @@ G_BEGIN_DECLS * could be scaled and stretched, it could be centered, or it could be * positioned to one side of the space. * - * Note that in horizontal context @GTK_ALIGN_START and @GTK_ALIGN_END + * Note that in horizontal context %GTK_ALIGN_START and %GTK_ALIGN_END * are interpreted relative to text direction. * - * @GTK_ALIGN_BASELINE support is optional for containers and widgets, and + * %GTK_ALIGN_BASELINE support is optional for containers and widgets, and * it is only supported for vertical alignment. When it's not supported by - * a child or a container it is treated as @GTK_ALIGN_FILL. + * a child or a container it is treated as %GTK_ALIGN_FILL. */ typedef enum { @@ -760,7 +760,7 @@ typedef enum /** * GtkBorderStyle: * @GTK_BORDER_STYLE_NONE: No visible border - * @GTK_BORDER_STYLE_HIDDEN: Same as @GTK_BORDER_STYLE_NONE + * @GTK_BORDER_STYLE_HIDDEN: Same as %GTK_BORDER_STYLE_NONE * @GTK_BORDER_STYLE_SOLID: A single line segment * @GTK_BORDER_STYLE_INSET: Looks as if the content is sunken into the canvas * @GTK_BORDER_STYLE_OUTSET: Looks as if the content is coming out of the canvas @@ -811,8 +811,8 @@ G_END_DECLS * @GTK_INPUT_PURPOSE_URL: Edited field expects URL * @GTK_INPUT_PURPOSE_EMAIL: Edited field expects email address * @GTK_INPUT_PURPOSE_NAME: Edited field expects the name of a person - * @GTK_INPUT_PURPOSE_PASSWORD: Like @GTK_INPUT_PURPOSE_FREE_FORM, but characters are hidden - * @GTK_INPUT_PURPOSE_PIN: Like @GTK_INPUT_PURPOSE_DIGITS, but characters are hidden + * @GTK_INPUT_PURPOSE_PASSWORD: Like %GTK_INPUT_PURPOSE_FREE_FORM, but characters are hidden + * @GTK_INPUT_PURPOSE_PIN: Like %GTK_INPUT_PURPOSE_DIGITS, but characters are hidden * @GTK_INPUT_PURPOSE_TERMINAL: Allow any character, in addition to control codes * * Describes primary purpose of the input widget. This information is @@ -826,8 +826,8 @@ G_END_DECLS * application is expected to validate the entry contents, even if * it specified a purpose. * - * The difference between @GTK_INPUT_PURPOSE_DIGITS and - * @GTK_INPUT_PURPOSE_NUMBER is that the former accepts only digits + * The difference between %GTK_INPUT_PURPOSE_DIGITS and + * %GTK_INPUT_PURPOSE_NUMBER is that the former accepts only digits * while the latter also some punctuation (like commas or points, plus, * minus) and “e” or “E” as in 3.14E+000. * @@ -874,7 +874,7 @@ typedef enum * behaviour according to the #GtkInputPurpose of the entry. * * Some common sense is expected when using these flags - mixing - * @GTK_INPUT_HINT_LOWERCASE with any of the uppercase hints makes no sense. + * %GTK_INPUT_HINT_LOWERCASE with any of the uppercase hints makes no sense. * * This enumeration may be extended in the future; input methods should * ignore unknown values. @@ -1464,7 +1464,7 @@ typedef enum { * position with respect to the total number of columns within a table, * grid, or treegrid. Value type: integer * @GTK_ACCESSIBLE_RELATION_COL_INDEX_TEXT: Defines a human readable text - * alternative of @GTK_ACCESSIBLE_RELATION_COL_INDEX. Value type: string + * alternative of %GTK_ACCESSIBLE_RELATION_COL_INDEX. Value type: string * @GTK_ACCESSIBLE_RELATION_COL_SPAN: Defines the number of columns spanned * by a cell or gridcell within a table, grid, or treegrid. Value type: integer * @GTK_ACCESSIBLE_RELATION_CONTROLS: Identifies the element (or elements) whose diff --git a/gtk/gtkeventcontroller.c b/gtk/gtkeventcontroller.c index 68670a8e14..d41f24ebe1 100644 --- a/gtk/gtkeventcontroller.c +++ b/gtk/gtkeventcontroller.c @@ -516,7 +516,7 @@ gtk_event_controller_get_propagation_limit (GtkEventController *controller) * * Sets the event propagation limit on the event controller. * - * If the limit is set to %@GTK_LIMIT_SAME_NATIVE, the controller + * If the limit is set to %GTK_LIMIT_SAME_NATIVE, the controller * won't handle events that are targeted at widgets on a different * surface, such as popovers. */ diff --git a/gtk/gtkfilter.h b/gtk/gtkfilter.h index fcd1c7b02c..8fe080634f 100644 --- a/gtk/gtkfilter.h +++ b/gtk/gtkfilter.h @@ -40,7 +40,7 @@ G_BEGIN_DECLS * Describes the known strictness of a filter. * * Note that for filters where the strictness is not known, - * %@GTK_FILTER_MATCH_SOME is always an acceptable value, + * %GTK_FILTER_MATCH_SOME is always an acceptable value, * even if a filter does match all or no items. */ typedef enum { @@ -64,7 +64,7 @@ typedef enum { * using the filter to optimize refiltering items. * * If you are writing an implementation and are not sure which - * value to pass, @GTK_FILTER_CHANGE_DIFFERENT is always a correct + * value to pass, %GTK_FILTER_CHANGE_DIFFERENT is always a correct * choice. */ typedef enum { diff --git a/gtk/gtktreeviewcolumn.h b/gtk/gtktreeviewcolumn.h index 6c83cdbc66..7199636f24 100644 --- a/gtk/gtktreeviewcolumn.h +++ b/gtk/gtktreeviewcolumn.h @@ -44,7 +44,7 @@ typedef struct _GtkTreeViewColumn GtkTreeViewColumn; * @GTK_TREE_VIEW_COLUMN_FIXED: Columns are a fixed numbers of pixels wide. * * The sizing method the column uses to determine its width. Please note - * that @GTK_TREE_VIEW_COLUMN_AUTOSIZE are inefficient for large views, and + * that %GTK_TREE_VIEW_COLUMN_AUTOSIZE are inefficient for large views, and * can make columns appear choppy. */ typedef enum