[gtksourceview: 5/21] docs: port links to the gi-docgen way
- From: Christian Hergert <chergert src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtksourceview: 5/21] docs: port links to the gi-docgen way
- Date: Thu, 2 Dec 2021 00:02:52 +0000 (UTC)
commit 8f0864641e8d93733fa40f5f50dea68eb97de224
Author: Bilal Elmoussaoui <bil elmoussaoui gmail com>
Date: Tue Nov 30 15:42:07 2021 +0100
docs: port links to the gi-docgen way
.../snippets/gtksourcecompletionsnippets.c | 8 +-
.../words/gtksourcecompletionwords.c | 8 +-
gtksourceview/gtksourcebuffer.c | 220 +++++++++++----------
gtksourceview/gtksourcecompletion.c | 56 +++---
gtksourceview/gtksourcecompletioncell.c | 10 +-
gtksourceview/gtksourcecompletioncontext.c | 23 +--
gtksourceview/gtksourcecompletionproposal.c | 4 +-
gtksourceview/gtksourcecompletionprovider.c | 30 +--
gtksourceview/gtksourceencoding-private.h | 2 +-
gtksourceview/gtksourceencoding.c | 9 +-
gtksourceview/gtksourcefile.c | 43 ++--
gtksourceview/gtksourcefile.h | 2 +-
gtksourceview/gtksourcefileloader.c | 50 ++---
gtksourceview/gtksourcefilesaver.c | 33 ++--
gtksourceview/gtksourcefilesaver.h | 2 +-
gtksourceview/gtksourcegutter.c | 20 +-
gtksourceview/gtksourcegutterlines.c | 28 +--
gtksourceview/gtksourcegutterrenderer.c | 109 +++++-----
gtksourceview/gtksourcegutterrendererpixbuf.c | 8 +-
gtksourceview/gtksourcegutterrenderertext.c | 4 +-
gtksourceview/gtksourcehover.c | 15 +-
gtksourceview/gtksourcehovercontext.c | 14 +-
gtksourceview/gtksourcehoverdisplay.c | 8 +-
gtksourceview/gtksourcehoverprovider.c | 10 +-
gtksourceview/gtksourceindenter.c | 34 ++--
gtksourceview/gtksourcelanguage.c | 25 ++-
gtksourceview/gtksourcelanguagemanager.c | 82 ++++----
gtksourceview/gtksourcemap.c | 28 +--
gtksourceview/gtksourcemark.c | 36 ++--
gtksourceview/gtksourcemarkattributes.c | 77 ++++----
gtksourceview/gtksourceprintcompositor.c | 197 +++++++++---------
gtksourceview/gtksourceregion.c | 57 +++---
gtksourceview/gtksourceregion.h | 5 +-
gtksourceview/gtksourcescheduler.c | 8 +-
gtksourceview/gtksourcescheduler.h | 2 +-
gtksourceview/gtksourcesearchcontext.c | 139 ++++++-------
gtksourceview/gtksourcesearchsettings.c | 47 +++--
gtksourceview/gtksourcesignalgroup.c | 14 +-
gtksourceview/gtksourcesnippet.c | 24 +--
gtksourceview/gtksourcesnippetchunk.c | 24 +--
gtksourceview/gtksourcesnippetcontext.c | 15 +-
gtksourceview/gtksourcesnippetmanager.c | 48 ++---
gtksourceview/gtksourcespacedrawer.c | 67 ++++---
gtksourceview/gtksourcestyle.c | 8 +-
gtksourceview/gtksourcestylescheme.c | 6 +-
gtksourceview/gtksourcestyleschemechooser.c | 10 +-
gtksourceview/gtksourcestyleschemechooserbutton.c | 4 +-
gtksourceview/gtksourcestyleschemechooserwidget.c | 6 +-
gtksourceview/gtksourcestyleschememanager.c | 26 +--
gtksourceview/gtksourcestyleschemepreview.c | 6 +-
gtksourceview/gtksourcetag.c | 28 +--
gtksourceview/gtksourceutils.c | 6 +-
gtksourceview/gtksourceview.c | 206 ++++++++++---------
gtksourceview/gtksourcevimimcontext.c | 64 +++---
54 files changed, 1061 insertions(+), 954 deletions(-)
---
diff --git a/gtksourceview/completion-providers/snippets/gtksourcecompletionsnippets.c
b/gtksourceview/completion-providers/snippets/gtksourcecompletionsnippets.c
index 86e6bebf..1a8cb6c6 100644
--- a/gtksourceview/completion-providers/snippets/gtksourcecompletionsnippets.c
+++ b/gtksourceview/completion-providers/snippets/gtksourcecompletionsnippets.c
@@ -38,11 +38,11 @@
/**
* GtkSourceCompletionSnippets:
*
- * A GtkSourceCompletionProvider for the completion of snippets.
+ * A [iface@CompletionProvider] for the completion of snippets.
*
- * The #GtkSourceCompletionSnippets is an example of an implementation of
- * the #GtkSourceCompletionProvider interface. The proposals are snippets
- * registered with the #GtkSourceSnippetManager.
+ * The `GtkSourceCompletionSnippets` is an example of an implementation of
+ * the [iface@CompletionProvider] interface. The proposals are snippets
+ * registered with the [class@SnippetManager].
*/
struct _GtkSourceSnippetResults
diff --git a/gtksourceview/completion-providers/words/gtksourcecompletionwords.c
b/gtksourceview/completion-providers/words/gtksourcecompletionwords.c
index 73e796bb..bc088ebf 100644
--- a/gtksourceview/completion-providers/words/gtksourcecompletionwords.c
+++ b/gtksourceview/completion-providers/words/gtksourcecompletionwords.c
@@ -22,11 +22,11 @@
/**
* GtkSourceCompletionWords:
*
- * A GtkSourceCompletionProvider for the completion of words.
+ * A [iface@CompletionProvider] for the completion of words.
*
- * The #GtkSourceCompletionWords is an example of an implementation of
- * the #GtkSourceCompletionProvider interface. The proposals are words
- * appearing in the registered #GtkTextBuffer<!-- -->s.
+ * The `GtkSourceCompletionWords` is an example of an implementation of
+ * the [iface@CompletionProvider] interface. The proposals are words
+ * appearing in the registered [class@Gtk.TextBuffer]s.
*/
#include "config.h"
diff --git a/gtksourceview/gtksourcebuffer.c b/gtksourceview/gtksourcebuffer.c
index e2b384f2..f3080cd6 100644
--- a/gtksourceview/gtksourcebuffer.c
+++ b/gtksourceview/gtksourcebuffer.c
@@ -46,66 +46,68 @@
/**
* GtkSourceBuffer:
*
- * Subclass of #GtkTextBuffer.
+ * Subclass of [class@Gtk.TextBuffer].
*
- * A #GtkSourceBuffer object is the model for #GtkSourceView widgets.
- * It extends the #GtkTextBuffer class by adding features useful to display
+ * A `GtkSourceBuffer` object is the model for [class@View] widgets.
+ * It extends the [class@Gtk.TextBuffer] class by adding features useful to display
* and edit source code such as syntax highlighting and bracket matching.
*
- * To create a #GtkSourceBuffer use gtk_source_buffer_new() or
- * gtk_source_buffer_new_with_language(). The second form is just a convenience
- * function which allows you to initially set a #GtkSourceLanguage. You can also
- * directly create a #GtkSourceView and get its #GtkSourceBuffer with
- * gtk_text_view_get_buffer().
+ * To create a `GtkSourceBuffer` use [ctor GtkSource Buffer new] or
+ * [ctor@GtkSource.Buffer.new_with_language]. The second form is just a convenience
+ * function which allows you to initially set a [class@Language]. You can also
+ * directly create a [class@View] and get its [class@Buffer] with
+ * [method@Gtk.TextView.get_buffer].
*
* The highlighting is enabled by default, but you can disable it with
- * gtk_source_buffer_set_highlight_syntax().
+ * [method@Buffer.set_highlight_syntax].
*
- * # Context Classes # {#context-classes}
+ * # Context Classes:
*
* It is possible to retrieve some information from the syntax highlighting
* engine. The default context classes that are applied to regions of a
- * #GtkSourceBuffer:
- * - <emphasis>comment</emphasis>: the region delimits a comment;
- * - <emphasis>no-spell-check</emphasis>: the region should not be spell checked;
- * - <emphasis>path</emphasis>: the region delimits a path to a file;
- * - <emphasis>string</emphasis>: the region delimits a string.
+ * `GtkSourceBuffer`:
+ *
+ * - **comment**: the region delimits a comment;
+ * - **no-spell-check**: the region should not be spell checked;
+ * - **path**: the region delimits a path to a file;
+ * - **string**: the region delimits a string.
*
* Custom language definition files can create their own context classes,
- * since the functions like gtk_source_buffer_iter_has_context_class() take
+ * since the functions like [method@Buffer.iter_has_context_class] take
* a string parameter as the context class.
*
- * #GtkSourceBuffer provides an API to access the context classes:
- * gtk_source_buffer_iter_has_context_class(),
- * gtk_source_buffer_get_context_classes_at_iter(),
- * gtk_source_buffer_iter_forward_to_context_class_toggle() and
- * gtk_source_buffer_iter_backward_to_context_class_toggle().
+ * `GtkSourceBuffer` provides an API to access the context classes:
+ * [method@Buffer.iter_has_context_class],
+ * [method@Buffer.get_context_classes_at_iter],
+ * [method@Buffer.iter_forward_to_context_class_toggle] and
+ * [method@Buffer.iter_backward_to_context_class_toggle].
*
- * And the #GtkSourceBuffer::highlight-updated signal permits to be notified
+ * And the [signal@GtkSource.Buffer::highlight-updated] signal permits to be notified
* when a context class region changes.
*
- * Each context class has also an associated #GtkTextTag with the name
- * <emphasis>gtksourceview:context-classes:<name></emphasis>. For example to
- * retrieve the #GtkTextTag for the string context class, one can write:
- * |[
+ * Each context class has also an associated [class@Gtk.TextTag] with the name
+ * `gtksourceview:context-classes:<name>`. For example to
+ * retrieve the [class@Gtk.TextTag] for the string context class, one can write:
+ * ```c
* GtkTextTagTable *tag_table;
* GtkTextTag *tag;
*
* tag_table = gtk_text_buffer_get_tag_table (buffer);
* tag = gtk_text_tag_table_lookup (tag_table, "gtksourceview:context-classes:string");
- * ]|
+ * ```
*
* The tag must be used for read-only purposes.
*
- * Accessing a context class via the associated #GtkTextTag is less
- * convenient than the #GtkSourceBuffer API, because:
+ * Accessing a context class via the associated [class@Gtk.TextTag] is less
+ * convenient than the `GtkSourceBuffer` API, because:
+ *
* - The tag doesn't always exist, you need to listen to the
- * #GtkTextTagTable::tag-added and #GtkTextTagTable::tag-removed signals.
- * - Instead of the #GtkSourceBuffer::highlight-updated signal, you can listen
- * to the #GtkTextBuffer::apply-tag and #GtkTextBuffer::remove-tag signals.
+ * [signal@Gtk.TextTagTable::tag-added] and [signal@Gtk.TextTagTable::tag-removed] signals.
+ * - Instead of the [signal@GtkSource.Buffer::highlight-updated] signal, you can listen
+ * to the [signal@Gtk.TextBuffer::apply-tag] and [signal@Gtk.TextBuffer::remove-tag] signals.
*
* A possible use-case for accessing a context class via the associated
- * #GtkTextTag is to read the region but without adding a hard dependency on the
+ * [class@Gtk.TextTag] is to read the region but without adding a hard dependency on the
* GtkSourceView library (for example for a spell-checking library that wants to
* read the no-spell-check region).
*/
@@ -348,7 +350,7 @@ gtk_source_buffer_class_init (GtkSourceBufferClass *klass)
* GtkSourceBuffer:implicit-trailing-newline:
*
* Whether the buffer has an implicit trailing newline. See
- * gtk_source_buffer_set_implicit_trailing_newline().
+ * [method@Buffer.set_implicit_trailing_newline].
*/
buffer_properties[PROP_IMPLICIT_TRAILING_NEWLINE] =
g_param_spec_boolean ("implicit-trailing-newline",
@@ -402,7 +404,7 @@ gtk_source_buffer_class_init (GtkSourceBufferClass *klass)
/**
* GtkSourceBuffer::source-mark-updated:
* @buffer: the buffer that received the signal
- * @mark: the #GtkSourceMark
+ * @mark: the [class@Mark]
*
* The ::source-mark-updated signal is emitted each time
* a mark is added to, moved or removed from the @buffer.
@@ -433,7 +435,7 @@ gtk_source_buffer_class_init (GtkSourceBufferClass *klass)
* The signal is emitted only when the @state changes, typically when
* the cursor moves.
*
- * A use-case for this signal is to show messages in a #GtkStatusbar.
+ * A use-case for this signal is to show messages in a [class@Gtk.Statusbar].
*/
buffer_signals[BRACKET_MATCHED] =
g_signal_new ("bracket-matched",
@@ -623,12 +625,13 @@ gtk_source_buffer_new (GtkTextTagTable *table)
* gtk_source_buffer_new_with_language:
* @language: a #GtkSourceLanguage.
*
- * Creates a new source buffer using the highlighting patterns in
- * @language. This is equivalent to creating a new source buffer with
- * a new tag table and then calling gtk_source_buffer_set_language().
+ * Creates a new source buffer using the highlighting patterns in `language`.
+ *
+ * This is equivalent to creating a new source buffer with
+ * a new tag table and then calling [method@Buffer.set_language].
*
* Returns: a new source buffer which will highlight text
- * according to the highlighting patterns in @language.
+ * according to the highlighting patterns in `language`.
*/
GtkSourceBuffer *
gtk_source_buffer_new_with_language (GtkSourceLanguage *language)
@@ -1374,8 +1377,9 @@ gtk_source_buffer_get_highlight_matching_brackets (GtkSourceBuffer *buffer)
* @buffer: a #GtkSourceBuffer.
* @highlight: %TRUE if you want matching brackets highlighted.
*
- * Controls the bracket match highlighting function in the buffer. If
- * activated, when you position your cursor over a bracket character
+ * Controls the bracket match highlighting function in the buffer.
+ *
+ * If activated, when you position your cursor over a bracket character
* (a parenthesis, a square bracket, etc.) the matching opening or
* closing bracket character will be highlighted.
*/
@@ -1426,11 +1430,10 @@ gtk_source_buffer_get_highlight_syntax (GtkSourceBuffer *buffer)
* Controls whether syntax is highlighted in the buffer.
*
* If @highlight is %TRUE, the text will be highlighted according to the syntax
- * patterns specified in the #GtkSourceLanguage set with
- * gtk_source_buffer_set_language().
+ * patterns specified in the [class@Language] set with [method@Buffer.set_language].
*
* If @highlight is %FALSE, syntax highlighting is disabled and all the
- * #GtkTextTag objects that have been added by the syntax highlighting engine
+ * [class@Gtk.TextTag] objects that have been added by the syntax highlighting engine
* are removed from the buffer.
*/
void
@@ -1455,11 +1458,11 @@ gtk_source_buffer_set_highlight_syntax (GtkSourceBuffer *buffer,
* @buffer: a #GtkSourceBuffer.
* @language: (nullable): a #GtkSourceLanguage to set, or %NULL.
*
- * Associates a #GtkSourceLanguage with the buffer.
+ * Associates a [class@Language] with the buffer.
*
- * Note that a #GtkSourceLanguage affects not only the syntax highlighting, but
+ * Note that a [class@Language] affects not only the syntax highlighting, but
* also the [context classes][context-classes]. If you want to disable just the
- * syntax highlighting, see gtk_source_buffer_set_highlight_syntax().
+ * syntax highlighting, see [method@Buffer.set_highlight_syntax].
*
* The buffer holds a reference to @language.
*/
@@ -1510,11 +1513,12 @@ gtk_source_buffer_set_language (GtkSourceBuffer *buffer,
* gtk_source_buffer_get_language:
* @buffer: a #GtkSourceBuffer.
*
- * Returns the #GtkSourceLanguage associated with the buffer,
- * see gtk_source_buffer_set_language(). The returned object should not be
- * unreferenced by the user.
+ * Returns the [class@Language] associated with the buffer,
+ * see [method@Buffer.set_language].
+ *
+ * The returned object should not be unreferenced by the user.
*
- * Returns: (nullable) (transfer none): the #GtkSourceLanguage associated
+ * Returns: (nullable) (transfer none): the [class@Language] associated
* with the buffer, or %NULL.
*/
GtkSourceLanguage *
@@ -1602,13 +1606,11 @@ _gtk_source_buffer_has_search_highlights (GtkSourceBuffer *buffer)
*
* Forces buffer to analyze and highlight the given area synchronously.
*
- * <note>
- * <para>
- * This is a potentially slow operation and should be used only
- * when you need to make sure that some text not currently
- * visible is highlighted, for instance before printing.
- * </para>
- * </note>
+ * **Note**:
+ *
+ * This is a potentially slow operation and should be used only
+ * when you need to make sure that some text not currently
+ * visible is highlighted, for instance before printing.
**/
void
gtk_source_buffer_ensure_highlight (GtkSourceBuffer *buffer,
@@ -1624,15 +1626,15 @@ gtk_source_buffer_ensure_highlight (GtkSourceBuffer *buffer,
* @buffer: a #GtkSourceBuffer.
* @scheme: (nullable): a #GtkSourceStyleScheme or %NULL.
*
- * Sets a #GtkSourceStyleScheme to be used by the buffer and the view.
+ * Sets a [class@StyleScheme] to be used by the buffer and the view.
*
- * Note that a #GtkSourceStyleScheme affects not only the syntax highlighting,
- * but also other #GtkSourceView features such as highlighting the current line,
+ * Note that a [class@StyleScheme] affects not only the syntax highlighting,
+ * but also other [class@View] features such as highlighting the current line,
* matching brackets, the line numbers, etc.
*
* Instead of setting a %NULL @scheme, it is better to disable syntax
- * highlighting with gtk_source_buffer_set_highlight_syntax(), and setting the
- * #GtkSourceStyleScheme with the "classic" or "tango" ID, because those two
+ * highlighting with [method@Buffer.set_highlight_syntax], and setting the
+ * [class@StyleScheme] with the "classic" or "tango" ID, because those two
* style schemes follow more closely the GTK+ theme (for example for the
* background color).
*
@@ -1664,11 +1666,12 @@ gtk_source_buffer_set_style_scheme (GtkSourceBuffer *buffer,
* gtk_source_buffer_get_style_scheme:
* @buffer: a #GtkSourceBuffer.
*
- * Returns the #GtkSourceStyleScheme associated with the buffer,
- * see gtk_source_buffer_set_style_scheme().
+ * Returns the [class@StyleScheme] associated with the buffer,
+ * see [method@Buffer.set_style_scheme].
+ *
* The returned object should not be unreferenced by the user.
*
- * Returns: (nullable) (transfer none): the #GtkSourceStyleScheme
+ * Returns: (nullable) (transfer none): the [class@StyleScheme]
* associated with the buffer, or %NULL.
*/
GtkSourceStyleScheme *
@@ -1763,12 +1766,14 @@ gtk_source_buffer_real_mark_deleted (GtkTextBuffer *buffer,
* @category: a string defining the mark category.
* @where: location to place the mark.
*
- * Creates a source mark in the @buffer of category @category. A source mark is
- * a #GtkTextMark but organised into categories. Depending on the category
- * a pixbuf can be specified that will be displayed along the line of the mark.
+ * Creates a source mark in the `buffer` of category `category`.
+ *
+ * A source mark is a [class@Gtk.TextMark] but organized into categories.
+ * Depending on the category a pixbuf can be specified that will be displayed
+ * along the line of the mark.
*
- * Like a #GtkTextMark, a #GtkSourceMark can be anonymous if the
- * passed @name is %NULL. Also, the buffer owns the marks so you
+ * Like a [class@Gtk.TextMark], a [class@Mark] can be anonymous if the
+ * passed `name` is %NULL. Also, the buffer owns the marks so you
* shouldn't unreference it.
*
* Marks always have left gravity and are moved to the beginning of
@@ -1777,7 +1782,7 @@ gtk_source_buffer_real_mark_deleted (GtkTextBuffer *buffer,
* Typical uses for a source mark are bookmarks, breakpoints, current
* executing instruction indication in a source file, etc..
*
- * Returns: (transfer none): a new #GtkSourceMark, owned by the buffer.
+ * Returns: (transfer none): a new [class@Mark], owned by the buffer.
*/
GtkSourceMark *
gtk_source_buffer_create_source_mark (GtkSourceBuffer *buffer,
@@ -1866,11 +1871,13 @@ _gtk_source_buffer_source_mark_prev (GtkSourceBuffer *buffer,
* @iter: (inout): an iterator.
* @category: (nullable): category to search for, or %NULL
*
- * Moves @iter to the position of the next #GtkSourceMark of the given
- * @category. Returns %TRUE if @iter was moved. If @category is NULL, the
+ * Moves `iter` to the position of the next [class@Mark] of the given
+ * `category`.
+ *
+ * Returns %TRUE if `iter` was moved. If `category` is NULL, the
* next source mark can be of any category.
*
- * Returns: whether @iter was moved.
+ * Returns: whether `iter` was moved.
*/
gboolean
gtk_source_buffer_forward_iter_to_source_mark (GtkSourceBuffer *buffer,
@@ -1898,11 +1905,13 @@ gtk_source_buffer_forward_iter_to_source_mark (GtkSourceBuffer *buffer,
* @iter: (inout): an iterator.
* @category: (nullable): category to search for, or %NULL
*
- * Moves @iter to the position of the previous #GtkSourceMark of the given
- * category. Returns %TRUE if @iter was moved. If @category is NULL, the
+ * Moves `iter` to the position of the previous [class@Mark] of the given
+ * category.
+ *
+ * Returns %TRUE if `iter` was moved. If `category` is NULL, the
* previous source mark can be of any category.
*
- * Returns: whether @iter was moved.
+ * Returns: whether `iter` was moved.
*/
gboolean
gtk_source_buffer_backward_iter_to_source_mark (GtkSourceBuffer *buffer,
@@ -1930,8 +1939,9 @@ gtk_source_buffer_backward_iter_to_source_mark (GtkSourceBuffer *buffer,
* @iter: an iterator.
* @category: (nullable): category to search for, or %NULL
*
- * Returns the list of marks of the given category at @iter. If @category
- * is %NULL it returns all marks at @iter.
+ * Returns the list of marks of the given category at @iter.
+ *
+ * If @category is %NULL it returns all marks at @iter.
*
* Returns: (element-type GtkSource.Mark) (transfer container):
* a newly allocated #GSList.
@@ -1963,6 +1973,7 @@ gtk_source_buffer_get_source_marks_at_iter (GtkSourceBuffer *buffer,
* @category: (nullable): category to search for, or %NULL
*
* Returns the list of marks of the given category at @line.
+ *
* If @category is %NULL, all marks at @line are returned.
*
* Returns: (element-type GtkSource.Mark) (transfer container):
@@ -2008,6 +2019,7 @@ gtk_source_buffer_get_source_marks_at_line (GtkSourceBuffer *buffer,
* @category: (nullable): category to search for, or %NULL.
*
* Remove all marks of @category between @start and @end from the buffer.
+ *
* If @category is NULL, all marks in the range will be removed.
*/
void
@@ -2081,7 +2093,7 @@ get_context_class_tag (GtkSourceBuffer *buffer,
*
* Check if the class @context_class is set on @iter.
*
- * See the #GtkSourceBuffer description for the list of default context classes.
+ * See the [class@Buffer] description for the list of default context classes.
*
* Returns: whether @iter has the context class.
*/
@@ -2113,7 +2125,7 @@ gtk_source_buffer_iter_has_context_class (GtkSourceBuffer *buffer,
*
* Get all defined context classes at @iter.
*
- * See the #GtkSourceBuffer description for the list of default context classes.
+ * See the [class@Buffer] description for the list of default context classes.
*
* Returns: (array zero-terminated=1) (transfer full): a new %NULL
* terminated array of context class names.
@@ -2164,13 +2176,14 @@ gtk_source_buffer_get_context_classes_at_iter (GtkSourceBuffer *buffer,
* @iter: (inout): a #GtkTextIter.
* @context_class: the context class.
*
- * Moves forward to the next toggle (on or off) of the context class. If no
- * matching context class toggles are found, returns %FALSE, otherwise %TRUE.
+ * Moves forward to the next toggle (on or off) of the context class.
+ *
+ * If no matching context class toggles are found, returns %FALSE, otherwise %TRUE.
* Does not return toggles located at @iter, only toggles after @iter. Sets
* @iter to the location of the toggle, or to the end of the buffer if no
* toggle is found.
*
- * See the #GtkSourceBuffer description for the list of default context classes.
+ * See the [class@Buffer] description for the list of default context classes.
*
* Returns: whether we found a context class toggle after @iter
*/
@@ -2201,13 +2214,14 @@ gtk_source_buffer_iter_forward_to_context_class_toggle (GtkSourceBuffer *buffer,
* @iter: (inout): a #GtkTextIter.
* @context_class: the context class.
*
- * Moves backward to the next toggle (on or off) of the context class. If no
- * matching context class toggles are found, returns %FALSE, otherwise %TRUE.
+ * Moves backward to the next toggle (on or off) of the context class.
+ *
+ * If no matching context class toggles are found, returns %FALSE, otherwise %TRUE.
* Does not return toggles located at @iter, only toggles after @iter. Sets
* @iter to the location of the toggle, or to the end of the buffer if no
* toggle is found.
*
- * See the #GtkSourceBuffer description for the list of default context classes.
+ * See the [class@Buffer] description for the list of default context classes.
*
* Returns: whether we found a context class toggle before @iter
*/
@@ -2460,8 +2474,8 @@ do_title_case (GtkTextBuffer *buffer,
*
* Changes the case of the text between the specified iterators.
*
- * Since 5.4, this function will update the position of @start and
- * @end to surround the modified text.
+ * Since 5.4, this function will update the position of `start` and
+ * `end` to surround the modified text.
*/
void
gtk_source_buffer_change_case (GtkSourceBuffer *buffer,
@@ -2914,14 +2928,14 @@ _gtk_source_buffer_has_invalid_chars (GtkSourceBuffer *buffer)
*
* Sets whether the @buffer has an implicit trailing newline.
*
- * If an explicit trailing newline is present in a #GtkTextBuffer, #GtkTextView
+ * If an explicit trailing newline is present in a [class@Gtk.TextBuffer], [class@Gtk.TextView]
* shows it as an empty line. This is generally not what the user expects.
*
* If @implicit_trailing_newline is %TRUE (the default value):
- * - when a #GtkSourceFileLoader loads the content of a file into the @buffer,
+ * - when a [class@FileLoader] loads the content of a file into the @buffer,
* the trailing newline (if present in the file) is not inserted into the
* @buffer.
- * - when a #GtkSourceFileSaver saves the content of the @buffer into a file, a
+ * - when a [class@FileSaver] saves the content of the @buffer into a file, a
* trailing newline is added to the file.
*
* On the other hand, if @implicit_trailing_newline is %FALSE, the file's
@@ -2968,23 +2982,23 @@ gtk_source_buffer_get_implicit_trailing_newline (GtkSourceBuffer *buffer)
* @first_property_name: (nullable): name of first property to set, or %NULL
* @...: %NULL-terminated list of property names and values
*
- * In short, this is the same function as gtk_text_buffer_create_tag(), but
- * instead of creating a #GtkTextTag, this function creates a #GtkSourceTag.
+ * In short, this is the same function as [method@Gtk.TextBuffer.create_tag] but
+ * instead of creating a [class@Gtk.TextTag], this function creates a [class@Tag].
*
- * This function creates a #GtkSourceTag and adds it to the tag table for
- * @buffer. Equivalent to calling gtk_text_tag_new() and then adding the tag to
+ * This function creates a [class@Tag] and adds it to the tag table for
+ * `buffer`. Equivalent to calling [ctor Gtk TextTag new] and then adding the tag to
* the buffer’s tag table. The returned tag is owned by the buffer’s tag table,
* so the ref count will be equal to one.
*
- * If @tag_name is %NULL, the tag is anonymous.
+ * If `tag_name` is %NULL, the tag is anonymous.
*
- * If @tag_name is non-%NULL, a tag called @tag_name must not already
+ * If `tag_name` is non-%NULL, a tag called `tag_name` must not already
* exist in the tag table for this buffer.
*
- * The @first_property_name argument and subsequent arguments are a list
- * of properties to set on the tag, as with g_object_set().
+ * The `first_property_name` argument and subsequent arguments are a list
+ * of properties to set on the tag, as with [method GObject Object set].
*
- * Returns: (transfer none): a new #GtkSourceTag.
+ * Returns: (transfer none): a new [class@Tag].
*/
GtkTextTag *
gtk_source_buffer_create_source_tag (GtkSourceBuffer *buffer,
diff --git a/gtksourceview/gtksourcecompletion.c b/gtksourceview/gtksourcecompletion.c
index 3427f3af..1eb04b80 100644
--- a/gtksourceview/gtksourcecompletion.c
+++ b/gtksourceview/gtksourcecompletion.c
@@ -46,11 +46,11 @@
* documentation), that is displayed when the "Details" button is
* clicked.
*
- * Proposals are created via a #GtkSourceCompletionProvider. There can
- * be for example a provider to complete words (see
- * #GtkSourceCompletionWords), another provider for the completion of
+ * Proposals are created via a [iface@CompletionProvider]. There can
+ * be for example a provider to complete words (see [class@CompletionWords]),
+ * another provider for the completion of
* function names, etc. To add a provider, call
- * gtk_source_completion_add_provider().
+ * [method@Completion.add_provider].
*
* When several providers match, they are all shown in the completion
* window, but one can switch between providers: see the
@@ -58,20 +58,20 @@
* activate the first proposals with key bindings, see the
* #GtkSourceCompletion:accelerators property.
*
- * The #GtkSourceCompletionProposal interface represents a proposal.
+ * The [iface@CompletionProposal] interface represents a proposal.
*
* If a proposal contains extra information (see
* %GTK_SOURCE_COMPLETION_COLUMN_DETAILS), it will be
* displayed in a supplemental details window, which appears when
* the "Details" button is clicked.
*
- * Each #GtkSourceView object is associated with a #GtkSourceCompletion
+ * Each [class@View] object is associated with a [class@Completion]
* instance. This instance can be obtained with
- * gtk_source_view_get_completion(). The #GtkSourceView class contains also the
- * #GtkSourceView::show-completion signal.
+ * [method@View.get_completion]. The [class@View] class contains also the
+ * [signal@View::show-completion] signal.
*
- * A same #GtkSourceCompletionProvider object can be used for several
- * #GtkSourceCompletion's.
+ * A same [iface@CompletionProvider] object can be used for several
+ * `GtkSourceCompletion`'s.
*/
#define DEFAULT_PAGE_SIZE 5
@@ -1069,7 +1069,7 @@ gtk_source_completion_class_init (GtkSourceCompletionClass *klass)
/**
* GtkSourceCompletion::provider-added:
* @self: an #ideCompletion
- * @provider: an #GtkSourceCompletionProvider
+ * @provider: a #GtkSourceCompletionProvider
*
* The "provided-added" signal is emitted when a new provider is
* added to the completion.
@@ -1088,7 +1088,7 @@ gtk_source_completion_class_init (GtkSourceCompletionClass *klass)
/**
* GtkSourceCompletion::provider-removed:
* @self: an #ideCompletion
- * @provider: an #GtkSourceCompletionProvider
+ * @provider: a #GtkSourceCompletionProvider
*
* The "provided-removed" signal is emitted when a provider has
* been removed from the completion.
@@ -1106,7 +1106,7 @@ gtk_source_completion_class_init (GtkSourceCompletionClass *klass)
/**
* GtkSourceCompletion::hide:
- * @self: an #GtkSourceCompletion
+ * @self: a #GtkSourceCompletion
*
* The "hide" signal is emitted when the completion window should
* be hidden.
@@ -1125,7 +1125,7 @@ gtk_source_completion_class_init (GtkSourceCompletionClass *klass)
/**
* GtkSourceCompletion::show:
- * @self: an #GtkSourceCompletion
+ * @self: a #GtkSourceCompletion
*
* The "show" signal is emitted when the completion window should
* be shown.
@@ -1216,7 +1216,7 @@ gtk_source_completion_init (GtkSourceCompletion *self)
* gtk_source_completion_get_view:
* @self: a #GtkSourceCompletion
*
- * Gets the #GtkSourceView that owns the #GtkSourceCompletion.
+ * Gets the [class@View] that owns the [class@Completion].
*
* Returns: (transfer none): A #GtkSourceView
*/
@@ -1232,7 +1232,7 @@ gtk_source_completion_get_view (GtkSourceCompletion *self)
* gtk_source_completion_get_buffer:
* @self: a #GtkSourceCompletion
*
- * Gets the connected #GtkSourceView's #GtkSourceBuffer
+ * Gets the connected [class@View]'s [class@Buffer]
*
* Returns: (transfer none): A #GtkSourceBuffer
*/
@@ -1246,10 +1246,10 @@ gtk_source_completion_get_buffer (GtkSourceCompletion *self)
/**
* gtk_source_completion_add_provider:
- * @self: an #GtkSourceCompletion
- * @provider: an #GtkSourceCompletionProvider
+ * @self: a #GtkSourceCompletion
+ * @provider: a #GtkSourceCompletionProvider
*
- * Adds an #GtkSourceCompletionProvider to the list of providers to be queried
+ * Adds a [iface@CompletionProvider] to the list of providers to be queried
* for completion results.
*/
void
@@ -1265,11 +1265,11 @@ gtk_source_completion_add_provider (GtkSourceCompletion *self,
/**
* gtk_source_completion_remove_provider:
- * @self: an #GtkSourceCompletion
- * @provider: an #GtkSourceCompletionProvider
+ * @self: a #GtkSourceCompletion
+ * @provider: a #GtkSourceCompletionProvider
*
- * Removes an #GtkSourceCompletionProvider previously added with
- * gtk_source_completion_add_provider().
+ * Removes a [iface@CompletionProvider] previously added with
+ * [method@Completion.add_provider].
*/
void
gtk_source_completion_remove_provider (GtkSourceCompletion *self,
@@ -1292,7 +1292,7 @@ gtk_source_completion_remove_provider (GtkSourceCompletion *self,
/**
* gtk_source_completion_show:
- * @self: an #GtkSourceCompletion
+ * @self: a #GtkSourceCompletion
*
* Emits the "show" signal.
*
@@ -1315,7 +1315,7 @@ gtk_source_completion_show (GtkSourceCompletion *self)
/**
* gtk_source_completion_hide:
- * @self: an #GtkSourceCompletion
+ * @self: a #GtkSourceCompletion
*
* Emits the "hide" signal.
*
@@ -1424,7 +1424,9 @@ _gtk_source_completion_get_display (GtkSourceCompletion *self)
* @priority: (out) (allow-none): An optional location for the score of the match
*
* This helper function can do a fuzzy match for you giving a haystack and
- * casefolded needle. Casefold your needle using g_utf8_casefold() before
+ * casefolded needle.
+ *
+ * Casefold your needle using [func@GLib.utf8_casefold] before
* running the query.
*
* Score will be set with the score of the match upon success. Otherwise,
@@ -1528,7 +1530,7 @@ add_attributes (PangoAttrList **attrs,
* @haystack: the string to be highlighted
* @casefold_query: the typed-text used to highlight @haystack
*
- * This will add <b> tags around matched characters in @haystack
+ * This will add `<b>` tags around matched characters in @haystack
* based on @casefold_query.
*
* Returns: (transfer full) (nullable): a #PangoAttrList or %NULL
diff --git a/gtksourceview/gtksourcecompletioncell.c b/gtksourceview/gtksourcecompletioncell.c
index cad05cfe..f3dc8f5f 100644
--- a/gtksourceview/gtksourcecompletioncell.c
+++ b/gtksourceview/gtksourcecompletioncell.c
@@ -29,7 +29,7 @@
*
* Widget for single cell of completion proposal.
*
- * The #GtkSourceCompletionCell widget provides a container to display various
+ * The `GtkSourceCompletionCell` widget provides a container to display various
* types of information with the completion display.
*
* Each proposal may consist of multiple cells depending on the complexity of
@@ -38,10 +38,10 @@
* function name and "parameters". They may also optionally set an icon to
* signify the kind of result.
*
- * A #GtkSourceCompletionProvider should implement the
- * #GtkSourceCompletionProviderInterface.display virtual function to control
- * how to convert data from their #GtkSourceCompletionProposal to content for
- * the #GtkSourceCompletionCell.
+ * A [iface@CompletionProvider] should implement the
+ * [vfunc@CompletionProvider.display] virtual function to control
+ * how to convert data from their [iface@CompletionProposal] to content for
+ * the `GtkSourceCompletionCell`.
*/
struct _GtkSourceCompletionCell
diff --git a/gtksourceview/gtksourcecompletioncontext.c b/gtksourceview/gtksourcecompletioncontext.c
index f6fe6df1..86adb9a1 100644
--- a/gtksourceview/gtksourcecompletioncontext.c
+++ b/gtksourceview/gtksourcecompletioncontext.c
@@ -36,19 +36,19 @@
*
* The context of a completion.
*
- * #GtkSourceCompletionContext contains information about an attept to display
- * completion proposals to the user based on typed text in the #GtkSourceView.
+ * `GtkSourceCompletionContext` contains information about an attept to display
+ * completion proposals to the user based on typed text in the [class@View].
*
- * When typing, #GtkSourceCompletion may use registered
- * #GtkSourceCompletionProvider to determine if there may be results which
- * could be displayed. If so, a #GtkSourceCompletionContext is created with
- * information that is provided to the #GtkSourceCompletionProvider to populate
+ * When typing, [class@Completion] may use registered
+ * [iface@CompletionProvider] to determine if there may be results which
+ * could be displayed. If so, a `GtkSourceCompletionContext` is created with
+ * information that is provided to the [iface@CompletionProvider] to populate
* results which might be useful to the user.
*
- * #GtkSourceCompletionProvider are expected to provide #GListModel with
- * #GtkSourceCompletionProposal which may be joined together in a list of
+ * [iface@CompletionProvider] are expected to provide [iface@Gio.ListModel] with
+ * [class@CompletionProposal] which may be joined together in a list of
* results for the user. They are also responsible for how the contents are
- * displayed using #GtkSourceCompletionCell which allows for some level of
+ * displayed using [class@CompletionCell] which allows for some level of
* customization.
*/
@@ -596,8 +596,9 @@ gtk_source_completion_context_items_changed_cb (GtkSourceCompletionContext *self
* @results: (nullable): a #GListModel or %NULL
*
* This function allows providers to update their results for a context
- * outside of a call to gtk_source_completion_provider_populate_async(). This
- * can be used to immediately return results for a provider while it does
+ * outside of a call to [method@CompletionProvider.populate_async].
+ *
+ * This can be used to immediately return results for a provider while it does
* additional asynchronous work. Doing so will allow the completions to
* update while the operation is in progress.
*/
diff --git a/gtksourceview/gtksourcecompletionproposal.c b/gtksourceview/gtksourcecompletionproposal.c
index ef5d18f0..63be5065 100644
--- a/gtksourceview/gtksourcecompletionproposal.c
+++ b/gtksourceview/gtksourcecompletionproposal.c
@@ -29,11 +29,11 @@
* Interface for completion proposals.
*
* This interface is used to denote that an object is capable of being
- * a completion proposal for #GtkSourceCompletion.
+ * a completion proposal for [class@Completion].
*
* Currently, no method or functions are required but additional methods
* may be added in the future. Proposals created by
- * #GtkSourceCompletionProvider can use %G_IMPLEMENT_INTERFACE to
+ * #GtkSourceCompletionProvider can use [func@GObject.IMPLEMENT_INTERFACE] to
* implement this with %NULL for the interface init function.
*/
diff --git a/gtksourceview/gtksourcecompletionprovider.c b/gtksourceview/gtksourcecompletionprovider.c
index 07eeb4bc..a9ce67da 100644
--- a/gtksourceview/gtksourcecompletionprovider.c
+++ b/gtksourceview/gtksourcecompletionprovider.c
@@ -31,10 +31,10 @@
*
* Completion provider interface.
*
- * You must implement this interface to provide proposals to #GtkSourceCompletion
+ * You must implement this interface to provide proposals to [class@Completion].
*
* In most cases, implementations of this interface will want to use
- * #GtkSourceCompletion.populate_async to asynchronously populate the results
+ * [vfunc@CompletionProvider.populate_async] to asynchronously populate the results
* to avoid blocking the main loop.
*/
@@ -201,7 +201,7 @@ gtk_source_completion_provider_is_trigger (GtkSourceCompletionProvider *self,
* @self: a #GtkSourceCompletionProvider
* @context: a #GtkSourceCompletionContext
* @proposal: a #GtkSourceCompletionProposal
- * @keyval: a keyval such as %GDK_KEY_period
+ * @keyval: a keyval such as [const@Gdk.KEY_period]
* @state: a #GdkModifierType or 0
*
* This function is used to determine if a key typed by the user should
@@ -239,9 +239,9 @@ gtk_source_completion_provider_key_activates (GtkSourceCompletionProvider *self,
* Asynchronously requests that the provider populates the completion
* results for @context.
*
- * For providers that would like to populate a #GListModel while those
+ * For providers that would like to populate a [iface@Gio.ListModel] while those
* results are displayed to the user,
- * gtk_source_completion_context_set_proposals_for_provider() may be used
+ * [method@CompletionContext.set_proposals_for_provider] may be used
* to reduce latency until the user sees results.
*/
void
@@ -285,11 +285,11 @@ gtk_source_completion_provider_populate_finish (GtkSourceCompletionProvider *se
* @model: a #GListModel
*
* This function can be used to filter results previously provided to
- * the #GtkSourceCompletionContext by the #GtkSourceCompletionProvider.
+ * the [class@CompletionContext] by the #GtkSourceCompletionProvider.
*
- * This can happen as the user types additionl text onto the word so
+ * This can happen as the user types additional text onto the word so
* that previously matched items may be removed from the list instead of
- * generating new #GListModel of results.
+ * generating new [iface@Gio.ListModel] of results.
*/
void
gtk_source_completion_provider_refilter (GtkSourceCompletionProvider *self,
@@ -312,8 +312,9 @@ gtk_source_completion_provider_refilter (GtkSourceCompletionProvider *self,
* @cell: a #GtkSourceCompletionCell
*
* This function requests that the #GtkSourceCompletionProvider prepares
- * @cell to display the contents of @proposal. Based on @cells column
- * type, you may want to display different information.
+ * @cell to display the contents of @proposal.
+ *
+ * Based on @cells column type, you may want to display different information.
*
* This allows for columns of information among completion proposals
* resulting in better alignment of similar content (icons, return types,
@@ -347,7 +348,7 @@ gtk_source_completion_provider_display (GtkSourceCompletionProvider *self,
* provider. Many providers may choose to insert a #GtkSourceSnippet with
* edit points the user may cycle through.
*
- * See also: #GtkSourceSnippet, #GtkSourceSnippetChunk, gtk_source_view_push_snippet()
+ * See also: [class@Snippet], [class@SnippetChunk], [method@View.push_snippet]
*/
void
gtk_source_completion_provider_activate (GtkSourceCompletionProvider *self,
@@ -369,9 +370,10 @@ gtk_source_completion_provider_activate (GtkSourceCompletionProvider *self,
* @proposal: a #GtkSourceCompletionProposal
*
* Providers should return a list of alternates to @proposal or %NULL if
- * there are no alternates available. This can be used by the completion
- * view to allow the user to move laterally through similar proposals, such
- * as overrides of methods by the same name.
+ * there are no alternates available.
+ *
+ * This can be used by the completion view to allow the user to move laterally
+ * through similar proposals, such as overrides of methods by the same name.
*
* Returns: (nullable) (transfer full) (element-type GtkSourceCompletionProposal):
* a #GPtrArray of #GtkSourceCompletionProposal or %NULL.
diff --git a/gtksourceview/gtksourceencoding-private.h b/gtksourceview/gtksourceencoding-private.h
index d48bab94..ceacedd6 100644
--- a/gtksourceview/gtksourceencoding-private.h
+++ b/gtksourceview/gtksourceencoding-private.h
@@ -30,7 +30,7 @@ G_BEGIN_DECLS
* @GTK_SOURCE_ENCODING_DUPLICATES_KEEP_LAST: Keep the last occurrence.
*
* Specifies which encoding occurrence to keep when removing duplicated
- * encodings in a list with gtk_source_encoding_remove_duplicates().
+ * encodings in a list with [method@Encoding.remove_duplicates].
*/
typedef enum _GtkSourceEncodingDuplicates
{
diff --git a/gtksourceview/gtksourceencoding.c b/gtksourceview/gtksourceencoding.c
index 8b53b2f6..41cbc728 100644
--- a/gtksourceview/gtksourceencoding.c
+++ b/gtksourceview/gtksourceencoding.c
@@ -377,7 +377,9 @@ gtk_source_encoding_get_utf8 (void)
/**
* gtk_source_encoding_get_current:
*
- * Gets the #GtkSourceEncoding for the current locale. See also g_get_charset().
+ * Gets the #GtkSourceEncoding for the current locale.
+ *
+ * See also [func@GLib.get_charset].
*
* Returns: the current locale encoding.
*/
@@ -588,8 +590,9 @@ _gtk_source_encoding_remove_duplicates (GSList *list,
/**
* gtk_source_encoding_get_default_candidates:
*
- * Gets the list of default candidate encodings to try when loading a file. See
- * gtk_source_file_loader_set_candidate_encodings().
+ * Gets the list of default candidate encodings to try when loading a file.
+ *
+ * See [method@FileLoader.set_candidate_encodings].
*
* This function returns a different list depending on the current locale (i.e.
* language, country and default encoding). The UTF-8 encoding and the current
diff --git a/gtksourceview/gtksourcefile.c b/gtksourceview/gtksourcefile.c
index 2cbd7bb6..e3dd6101 100644
--- a/gtksourceview/gtksourcefile.c
+++ b/gtksourceview/gtksourcefile.c
@@ -26,14 +26,14 @@
/**
* GtkSourceFile:
*
- * On-disk representation of a GtkSourceBuffer.
+ * On-disk representation of a [class@Buffer].
*
- * A #GtkSourceFile object is the on-disk representation of a #GtkSourceBuffer.
- * With a #GtkSourceFile, you can create and configure a #GtkSourceFileLoader
- * and #GtkSourceFileSaver which take by default the values of the
- * #GtkSourceFile properties (except for the file loader which auto-detect some
- * properties). On a successful load or save operation, the #GtkSourceFile
- * properties are updated. If an operation fails, the #GtkSourceFile properties
+ * A `GtkSourceFile` object is the on-disk representation of a [class@Buffer].
+ * With a `GtkSourceFile`, you can create and configure a [class@FileLoader]
+ * and [class@FileSaver] which take by default the values of the
+ * `GtkSourceFile` properties (except for the file loader which auto-detect some
+ * properties). On a successful load or save operation, the `GtkSourceFile`
+ * properties are updated. If an operation fails, the `GtkSourceFile` properties
* have still the previous valid values.
*/
@@ -401,11 +401,12 @@ gtk_source_file_get_compression_type (GtkSourceFile *file)
* @notify: (nullable): function to call on @user_data when the @callback is no
* longer needed, or %NULL.
*
- * Sets a #GtkSourceMountOperationFactory function that will be called when a
- * #GMountOperation must be created. This is useful for creating a
- * #GtkMountOperation with the parent #GtkWindow.
+ * Sets a [callback@MountOperationFactory] function that will be called when a
+ * [class@Gio.MountOperation] must be created.
*
- * If a mount operation factory isn't set, g_mount_operation_new() will be
+ * This is useful for creating a [class@Gtk.MountOperation] with the parent [class@Gtk.Window].
+ *
+ * If a mount operation factory isn't set, [ctor Gio MountOperation new] will be
* called.
*/
void
@@ -480,7 +481,7 @@ _gtk_source_file_set_modification_time (GtkSourceFile *file,
* gtk_source_file_is_local:
* @file: a #GtkSourceFile.
*
- * Returns whether the file is local. If the #GtkSourceFile:location is %NULL,
+ * Returns whether the file is local. If the [property@File:location] is %NULL,
* returns %FALSE.
*
* Returns: whether the file is local.
@@ -507,12 +508,12 @@ gtk_source_file_is_local (GtkSourceFile *file)
* Checks synchronously the file on disk, to know whether the file is externally
* modified, or has been deleted, and whether the file is read-only.
*
- * #GtkSourceFile doesn't create a #GFileMonitor to track those properties, so
- * this function needs to be called instead. Creating lots of #GFileMonitor's
+ * #GtkSourceFile doesn't create a [class@Gio.FileMonitor] to track those properties, so
+ * this function needs to be called instead. Creating lots of [class@Gio.FileMonitor]'s
* would take lots of resources.
*
* Since this function is synchronous, it is advised to call it only on local
- * files. See gtk_source_file_is_local().
+ * files. See [method@File.is_local].
*/
void
gtk_source_file_check_file_on_disk (GtkSourceFile *file)
@@ -586,10 +587,10 @@ _gtk_source_file_set_externally_modified (GtkSourceFile *file,
* @file: a #GtkSourceFile.
*
* Returns whether the file is externally modified. If the
- * #GtkSourceFile:location is %NULL, returns %FALSE.
+ * [property@File:location] is %NULL, returns %FALSE.
*
* To have an up-to-date value, you must first call
- * gtk_source_file_check_file_on_disk().
+ * [method@File.check_file_on_disk].
*
* Returns: whether the file is externally modified.
*/
@@ -619,10 +620,10 @@ _gtk_source_file_set_deleted (GtkSourceFile *file,
* @file: a #GtkSourceFile.
*
* Returns whether the file has been deleted. If the
- * #GtkSourceFile:location is %NULL, returns %FALSE.
+ * [property@File:location] is %NULL, returns %FALSE.
*
* To have an up-to-date value, you must first call
- * gtk_source_file_check_file_on_disk().
+ * [method@File.check_file_on_disk].
*
* Returns: whether the file has been deleted.
*/
@@ -658,10 +659,10 @@ _gtk_source_file_set_readonly (GtkSourceFile *file,
* @file: a #GtkSourceFile.
*
* Returns whether the file is read-only. If the
- * #GtkSourceFile:location is %NULL, returns %FALSE.
+ * [property@File:location] is %NULL, returns %FALSE.
*
* To have an up-to-date value, you must first call
- * gtk_source_file_check_file_on_disk().
+ * [method@File.check_file_on_disk].
*
* Returns: whether the file is read-only.
*/
diff --git a/gtksourceview/gtksourcefile.h b/gtksourceview/gtksourcefile.h
index 1ab7097d..96f53a27 100644
--- a/gtksourceview/gtksourcefile.h
+++ b/gtksourceview/gtksourcefile.h
@@ -73,7 +73,7 @@ typedef enum _GtkSourceCompressionType
* @userdata: user data
*
* Type definition for a function that will be called to create a
- * #GMountOperation. This is useful for creating a #GtkMountOperation.
+ * [class@Gio.MountOperation]. This is useful for creating a [class@Gtk.MountOperation].
*/
typedef GMountOperation *(*GtkSourceMountOperationFactory) (GtkSourceFile *file,
gpointer userdata);
diff --git a/gtksourceview/gtksourcefileloader.c b/gtksourceview/gtksourcefileloader.c
index 0ab38aa4..97fc4607 100644
--- a/gtksourceview/gtksourcefileloader.c
+++ b/gtksourceview/gtksourcefileloader.c
@@ -37,24 +37,22 @@
*
* Load a file into a GtkSourceBuffer.
*
- * A #GtkSourceFileLoader object permits to load the contents of a #GFile or a
- * #GInputStream into a #GtkSourceBuffer.
+ * A `GtkSourceFileLoader` object permits to load the contents of a [class Gio File] or a
+ * [class@Gio.InputStream] into a [class@Buffer].
*
* A file loader should be used only for one load operation, including errors
* handling. If an error occurs, you can reconfigure the loader and relaunch the
- * operation with gtk_source_file_loader_load_async().
+ * operation with [method@FileLoader.load_async].
*
- * Running a #GtkSourceFileLoader is an undoable action for the
- * #GtkSourceBuffer. That is, gtk_source_buffer_begin_not_undoable_action() and
- * gtk_source_buffer_end_not_undoable_action() are called, which delete the
- * undo/redo history.
+ * Running a `GtkSourceFileLoader` is an undoable action for the
+ * [class@Buffer].
*
* After a file loading, the buffer is reset to the contents provided by the
- * #GFile or #GInputStream, so the buffer is set as “unmodified”, that is,
- * gtk_text_buffer_set_modified() is called with %FALSE. If the contents isn't
+ * [class Gio File] or [class@Gio.InputStream], so the buffer is set as “unmodified”, that is,
+ * [method@Gtk.TextBuffer.set_modified] is called with %FALSE. If the contents isn't
* saved somewhere (for example if you load from stdin), then you should
- * probably call gtk_text_buffer_set_modified() with %TRUE after calling
- * gtk_source_file_loader_load_finish().
+ * probably call [method@Gtk.TextBuffer.set_modified] with %TRUE after calling
+ * [method@FileLoader.load_finish].
*/
#if 0
@@ -902,10 +900,11 @@ gtk_source_file_loader_error_quark (void)
* @buffer: the #GtkSourceBuffer to load the contents into.
* @file: the #GtkSourceFile.
*
- * Creates a new #GtkSourceFileLoader object. The contents is read from the
- * #GtkSourceFile's location. If not already done, call
- * gtk_source_file_set_location() before calling this constructor. The previous
- * location is anyway not needed, because as soon as the file loading begins,
+ * Creates a new `GtkSourceFileLoader` object. The contents is read from the
+ * [class@File]'s location.
+ *
+ * If not already done, call [method@File.set_location] before calling this constructor.
+ * The previous location is anyway not needed, because as soon as the file loading begins,
* the @buffer is emptied.
*
* Returns: a new #GtkSourceFileLoader object.
@@ -955,17 +954,17 @@ gtk_source_file_loader_new_from_stream (GtkSourceBuffer *buffer,
* @candidate_encodings: (element-type GtkSourceEncoding): a list of
* #GtkSourceEncoding<!-- -->s.
*
- * Sets the candidate encodings for the file loading. The encodings are tried in
- * the same order as the list.
+ * Sets the candidate encodings for the file loading.
+ *
+ * The encodings are tried in the same order as the list.
*
* For convenience, @candidate_encodings can contain duplicates. Only the first
* occurrence of a duplicated encoding is kept in the list.
*
* By default the candidate encodings are (in that order in the list):
- * 1. If set, the #GtkSourceFile's encoding as returned by
- * gtk_source_file_get_encoding().
- * 2. The default candidates as returned by
- * gtk_source_encoding_get_default_candidates().
+ *
+ * 1. If set, the [class@File]'s encoding as returned by [method@File.get_encoding].
+ * 2. The default candidates as returned by [func@Encoding.get_default_candidates].
*/
void
gtk_source_file_loader_set_candidate_encodings (GtkSourceFileLoader *loader,
@@ -1057,8 +1056,9 @@ gtk_source_file_loader_get_input_stream (GtkSourceFileLoader *loader)
* satisfied.
* @user_data: user data to pass to @callback.
*
- * Loads asynchronously the file or input stream contents into the
- * #GtkSourceBuffer. See the #GAsyncResult documentation to know how to use this
+ * Loads asynchronously the file or input stream contents into the [class@Buffer].
+ *
+ * See the [iface@Gio.AsyncResult] documentation to know how to use this
* function.
*/
@@ -1153,9 +1153,9 @@ gtk_source_file_loader_load_async (GtkSourceFileLoader *loader,
* @result: a #GAsyncResult.
* @error: a #GError, or %NULL.
*
- * Finishes a file loading started with gtk_source_file_loader_load_async().
+ * Finishes a file loading started with [method@FileLoader.load_async].
*
- * If the contents has been loaded, the following #GtkSourceFile properties will
+ * If the contents has been loaded, the following [class@File] properties will
* be updated: the location, the encoding, the newline type and the compression
* type.
*
diff --git a/gtksourceview/gtksourcefilesaver.c b/gtksourceview/gtksourcefilesaver.c
index 88adc532..f78e6bb4 100644
--- a/gtksourceview/gtksourcefilesaver.c
+++ b/gtksourceview/gtksourcefilesaver.c
@@ -35,14 +35,14 @@
/**
* GtkSourceFileSaver:
*
- * Save a GtkSourceBuffer into a file.
+ * Save a [class@Buffer] into a file.
*
- * A #GtkSourceFileSaver object permits to save a #GtkSourceBuffer into a
- * #GFile.
+ * A `GtkSourceFileSaver` object permits to save a [class@Buffer] into a
+ * [class Gio File].
*
* A file saver should be used only for one save operation, including errors
* handling. If an error occurs, you can reconfigure the saver and relaunch the
- * operation with gtk_source_file_saver_save_async().
+ * operation with [method@FileSaver.save_async].
*/
/* The code has been written initially in gedit (GeditDocumentSaver).
@@ -1075,10 +1075,10 @@ gtk_source_file_saver_error_quark (void)
* @file: the #GtkSourceFile.
*
* Creates a new #GtkSourceFileSaver object. The @buffer will be saved to the
- * #GtkSourceFile's location.
+ * [class@File]'s location.
*
* This constructor is suitable for a simple "save" operation, when the @file
- * already contains a non-%NULL #GtkSourceFile:location.
+ * already contains a non-%NULL [property@File:location].
*
* Returns: a new #GtkSourceFileSaver object.
*/
@@ -1101,10 +1101,11 @@ gtk_source_file_saver_new (GtkSourceBuffer *buffer,
* @file: the #GtkSourceFile.
* @target_location: the #GFile where to save the buffer to.
*
- * Creates a new #GtkSourceFileSaver object with a target location. When the
- * file saving is finished successfully, @target_location is set to the @file's
- * #GtkSourceFile:location property. If an error occurs, the previous valid
- * location is still available in #GtkSourceFile.
+ * Creates a new #GtkSourceFileSaver object with a target location.
+ *
+ * When the file saving is finished successfully, @target_location is set to the @file's
+ * [property@File:location] property. If an error occurs, the previous valid
+ * location is still available in [class@File].
*
* This constructor is suitable for a "save as" operation, or for saving a new
* buffer for the first time.
@@ -1175,6 +1176,7 @@ gtk_source_file_saver_get_location (GtkSourceFileSaver *saver)
* @encoding: (nullable): the new encoding, or %NULL for UTF-8.
*
* Sets the encoding. If @encoding is %NULL, the UTF-8 encoding will be set.
+ *
* By default the encoding is taken from the #GtkSourceFile.
*/
void
@@ -1335,8 +1337,9 @@ gtk_source_file_saver_get_flags (GtkSourceFileSaver *saver)
* satisfied.
* @user_data: user data to pass to @callback.
*
- * Saves asynchronously the buffer into the file. See the #GAsyncResult
- * documentation to know how to use this function.
+ * Saves asynchronously the buffer into the file.
+ *
+ * See the [iface@Gio.AsyncResult] documentation to know how to use this function.
*/
/* The GDestroyNotify is needed, currently the following bug is not fixed:
@@ -1412,13 +1415,13 @@ gtk_source_file_saver_save_async (GtkSourceFileSaver *saver,
* @result: a #GAsyncResult.
* @error: a #GError, or %NULL.
*
- * Finishes a file saving started with gtk_source_file_saver_save_async().
+ * Finishes a file saving started with [method@FileSaver.save_async].
*
- * If the file has been saved successfully, the following #GtkSourceFile
+ * If the file has been saved successfully, the following [class@File]
* properties will be updated: the location, the encoding, the newline type and
* the compression type.
*
- * Since the 3.20 version, gtk_text_buffer_set_modified() is called with %FALSE
+ * Since the 3.20 version, [method@Gtk.TextBuffer.set_modified] is called with %FALSE
* if the file has been saved successfully.
*
* Returns: whether the file was saved successfully.
diff --git a/gtksourceview/gtksourcefilesaver.h b/gtksourceview/gtksourcefilesaver.h
index a5f8a56e..26d2404e 100644
--- a/gtksourceview/gtksourcefilesaver.h
+++ b/gtksourceview/gtksourcefilesaver.h
@@ -58,7 +58,7 @@ typedef enum _GtkSourceFileSaverError
* @GTK_SOURCE_FILE_SAVER_FLAGS_IGNORE_MODIFICATION_TIME: Save file despite external modifications.
* @GTK_SOURCE_FILE_SAVER_FLAGS_CREATE_BACKUP: Create a backup before saving the file.
*
- * Flags to define the behavior of a #GtkSourceFileSaver.
+ * Flags to define the behavior of a [flags@FileSaverFlags].
*/
typedef enum _GtkSourceFileSaverFlags
{
diff --git a/gtksourceview/gtksourcegutter.c b/gtksourceview/gtksourcegutter.c
index e88a27d8..48a38a3c 100644
--- a/gtksourceview/gtksourcegutter.c
+++ b/gtksourceview/gtksourcegutter.c
@@ -33,21 +33,21 @@
/**
* GtkSourceGutter:
*
- * Gutter object for GtkSourceView.
+ * Gutter object for [class@View].
*
- * The #GtkSourceGutter object represents the left or right gutter of the text
- * view. It is used by #GtkSourceView to draw the line numbers and
- * #GtkSourceMark<!-- -->s that might be present on a line. By packing
- * additional #GtkSourceGutterRenderer objects in the gutter, you can extend the
+ * The `GtkSourceGutter` object represents the left or right gutter of the text
+ * view. It is used by [class@View] to draw the line numbers and
+ * [class@Mark]s that might be present on a line. By packing
+ * additional [class@GutterRenderer] objects in the gutter, you can extend the
* gutter with your own custom drawings.
*
- * To get a #GtkSourceGutter, use the gtk_source_view_get_gutter() function.
+ * To get a `GtkSourceGutter`, use the [method@View.get_gutter] function.
*
- * The gutter works very much the same way as cells rendered in a #GtkTreeView.
+ * The gutter works very much the same way as cells rendered in a [class@Gtk.TreeView].
* The concept is similar, with the exception that the gutter does not have an
- * underlying #GtkTreeModel. The builtin line number renderer is at position
- * #GTK_SOURCE_VIEW_GUTTER_POSITION_LINES (-30) and the marks renderer is at
- * #GTK_SOURCE_VIEW_GUTTER_POSITION_MARKS (-20). The gutter sorts the renderers
+ * underlying [class@Gtk.TreeModel]. The builtin line number renderer is at position
+ * %GTK_SOURCE_VIEW_GUTTER_POSITION_LINES (-30) and the marks renderer is at
+ * %GTK_SOURCE_VIEW_GUTTER_POSITION_MARKS (-20). The gutter sorts the renderers
* in ascending order, from left to right. So the marks are displayed on the
* right of the line numbers.
*/
diff --git a/gtksourceview/gtksourcegutterlines.c b/gtksourceview/gtksourcegutterlines.c
index 5a805377..d4e2328b 100644
--- a/gtksourceview/gtksourcegutterlines.c
+++ b/gtksourceview/gtksourcegutterlines.c
@@ -29,10 +29,10 @@
*
* Collected information about visible lines.
*
- * The #GtkSourceGutterLines object is used to collect information about
+ * The `GtkSourceGutterLines` object is used to collect information about
* visible lines.
*
- * Use this from your #GtkSourceGutterRenderer::query-data to collect the
+ * Use this from your [signal@GutterRenderer::query-data] to collect the
* necessary information on visible lines. Doing so reduces the number of
* passes through the text btree allowing GtkSourceView to reach more
* frames-per-second while performing kinetic scrolling.
@@ -273,10 +273,10 @@ _gtk_source_gutter_lines_new (GtkTextView *text_view,
* Adds the class denoted by @qname to @line.
*
* You may check if a line has @qname by calling
- * gtk_source_gutter_lines_has_qclass().
+ * [method@GutterLines.has_qclass].
*
* You can remove @qname by calling
- * gtk_source_gutter_lines_remove_qclass().
+ * [method@GutterLines.remove_qclass].
*/
void
gtk_source_gutter_lines_add_qclass (GtkSourceGutterLines *lines,
@@ -303,9 +303,9 @@ gtk_source_gutter_lines_add_qclass (GtkSourceGutterLines *lines,
*
* Adds the class @name to @line.
*
- * @name will be converted to a #GQuark as part of this process. A
+ * @name will be converted to a [class@GLib.Quark] as part of this process. A
* faster version of this function is available via
- * gtk_source_gutter_lines_add_qclass() for situations where the #GQuark is
+ * [method@GutterLines.add_qclass] for situations where the [class@GLib.Quark] is
* known ahead of time.
*/
void
@@ -329,7 +329,7 @@ gtk_source_gutter_lines_add_class (GtkSourceGutterLines *lines,
* Removes the class matching @name from @line.
*
* A faster version of this function is available via
- * gtk_source_gutter_lines_remove_qclass() for situations where the
+ * [method@GutterLines.remove_qclass] for situations where the
* #GQuark is known ahead of time.
*/
void
@@ -355,8 +355,8 @@ gtk_source_gutter_lines_remove_class (GtkSourceGutterLines *lines,
* @line: a line number starting from zero
* @qname: a #GQuark to remove from @line
*
- * Reverses a call to gtk_source_gutter_lines_add_qclass() by removing
- * the #GQuark matching @qname.
+ * Reverses a call to [method@GutterLines.add_qclass] by removing
+ * the [class@GLib.Quark] matching @qname.
*/
void
gtk_source_gutter_lines_remove_qclass (GtkSourceGutterLines *lines,
@@ -381,11 +381,11 @@ gtk_source_gutter_lines_remove_qclass (GtkSourceGutterLines *lines,
* @line: a line number starting from zero
* @name: a class name that may be converted, to a #GQuark
*
- * Checks to see if gtk_source_gutter_lines_add_class() was called with
+ * Checks to see if [method@GutterLines.add_class] was called with
* the @name for @line.
*
* A faster version of this function is provided via
- * gtk_source_gutter_lines_has_qclass() for situations where the quark
+ * [method@GutterLines.has_qclass] for situations where the quark
* is known ahead of time.
*
* Returns: %TRUE if @line contains @name
@@ -415,7 +415,7 @@ gtk_source_gutter_lines_has_class (GtkSourceGutterLines *lines,
* @line: a line number starting from zero
* @qname: a #GQuark containing the class name
*
- * Checks to see if gtk_source_gutter_lines_add_qclass() was called with
+ * Checks to see if [method@GutterLines.add_qclass] was called with
* the quark denoted by @qname for @line.
*
* Returns: %TRUE if @line contains @qname
@@ -549,7 +549,7 @@ gtk_source_gutter_lines_get_iter_at_line (GtkSourceGutterLines *lines,
* gtk_source_gutter_lines_get_view:
* @lines: a #GtkSourceGutterLines
*
- * Gets the #GtkTextView that the #GtkSourceGutterLines represents.
+ * Gets the [class@Gtk.TextView] that the `GtkSourceGutterLines` represents.
*
* Returns: (transfer none) (not nullable): a #GtkTextView
*/
@@ -565,7 +565,7 @@ gtk_source_gutter_lines_get_view (GtkSourceGutterLines *lines)
* gtk_source_gutter_lines_get_buffer:
* @lines: a #GtkSourceGutterLines
*
- * Gets the #GtkTextBuffer that the #GtkSourceGutterLines represents.
+ * Gets the [class@Gtk.TextBuffer] that the `GtkSourceGutterLines` represents.
*
* Returns: (transfer none) (not nullable): a #GtkTextBuffer
*/
diff --git a/gtksourceview/gtksourcegutterrenderer.c b/gtksourceview/gtksourcegutterrenderer.c
index eb92e171..a7a253f0 100644
--- a/gtksourceview/gtksourcegutterrenderer.c
+++ b/gtksourceview/gtksourcegutterrenderer.c
@@ -35,13 +35,13 @@
*
* Gutter cell renderer.
*
- * A #GtkSourceGutterRenderer represents a column in a #GtkSourceGutter. The
- * column contains one cell for each visible line of the #GtkTextBuffer. Due to
- * text wrapping, a cell can thus span multiple lines of the #GtkTextView. In
- * this case, #GtkSourceGutterRendererAlignmentMode controls the alignment of
+ * A `GtkSourceGutterRenderer` represents a column in a [class@Gutter]. The
+ * column contains one cell for each visible line of the [class@Gtk.TextBuffer]. Due to
+ * text wrapping, a cell can thus span multiple lines of the [class@Gtk.TextView]. In
+ * this case, [enum@GutterRendererAlignmentMode] controls the alignment of
* the cell.
*
- * The gutter renderer is a #GtkWidget and is measured using the normal widget
+ * The gutter renderer is a [class@Gtk.Widget] and is measured using the normal widget
* measurement facilities. The width of the gutter will be determined by the
* measurements of the gutter renderers.
*
@@ -51,19 +51,19 @@
* be printed, even if only the first 20 lines are shown. Another strategy is to
* take into account only the visible lines. In this case, only two digits are
* necessary to display the line numbers of the first 20 lines. To take another
- * example, the gutter renderer for #GtkSourceMark<!-- -->s doesn't need to take
+ * example, the gutter renderer for [class@Mark]s doesn't need to take
* into account the text buffer to announce its width. It only depends on the
* icons size displayed in the gutter column.
*
* When the available size to render a cell is greater than the required size to
* render the cell contents, the cell contents can be aligned horizontally and
- * vertically with gtk_source_gutter_renderer_set_alignment().
+ * vertically with [method@GutterRenderer.set_alignment_mode].
*
- * The cells rendering occurs using gtk_widget_snapshot(). Implementations
- * should use gtk_source_gutter_renderer_get_lines() to retrieve information
+ * The cells rendering occurs using [vfunc@Gtk.Widget.snapshot]. Implementations
+ * should use `gtk_source_gutter_renderer_get_lines()` to retrieve information
* about the lines to be rendered. To help with aligning content which takes
* into account the padding and alignment of a cell, implementations may call
- * gtk_source_gutter_renderer_align_cell() for a given line number with the
+ * [method@GutterRenderer.align_cell] for a given line number with the
* width and height measurement of the content they width to render.
*/
@@ -368,9 +368,9 @@ gtk_source_gutter_renderer_class_init (GtkSourceGutterRendererClass *klass)
/**
* GtkSourceGutterRenderer:lines:
*
- * The "lines" property contains information about the lines to be
- * rendered. It should be used by #GtkSourceGutterRenderer
- * implementations from gtk_widget_snapshot().
+ * Contains information about the lines to be rendered.
+ *
+ * It should be used by #GtkSourceGutterRenderer implementations from [vfunc@Gtk.Widget.snapshot].
*/
properties[PROP_LINES] =
g_param_spec_object ("lines",
@@ -410,8 +410,9 @@ gtk_source_gutter_renderer_class_init (GtkSourceGutterRendererClass *klass)
/**
* GtkSourceGutterRenderer:xalign:
*
- * The horizontal alignment of the renderer. Set to 0 for a left
- * alignment. 1 for a right alignment. And 0.5 for centering the cells.
+ * The horizontal alignment of the renderer.
+ *
+ * Set to 0 for a left alignment. 1 for a right alignment. And 0.5 for centering the cells.
* A value lower than 0 doesn't modify the alignment.
*/
properties[PROP_XALIGN] =
@@ -426,8 +427,9 @@ gtk_source_gutter_renderer_class_init (GtkSourceGutterRendererClass *klass)
/**
* GtkSourceGutterRenderer:yalign:
*
- * The vertical alignment of the renderer. Set to 0 for a top
- * alignment. 1 for a bottom alignment. And 0.5 for centering the cells.
+ * The vertical alignment of the renderer.
+ *
+ * Set to 0 for a top alignment. 1 for a bottom alignment. And 0.5 for centering the cells.
* A value lower than 0 doesn't modify the alignment.
*/
properties[PROP_YALIGN] =
@@ -455,11 +457,10 @@ gtk_source_gutter_renderer_class_init (GtkSourceGutterRendererClass *klass)
/**
* GtkSourceGutterRenderer:alignment-mode:
*
- * The alignment mode of the renderer. This can be used to indicate
- * that in the case a cell spans multiple lines (due to text wrapping)
- * the alignment should work on either the full cell, the first line
- * or the last line.
- *
+ * The alignment mode of the renderer.
+ *
+ * This can be used to indicate that in the case a cell spans multiple lines (due to text wrapping)
+ * the alignment should work on either the full cell, the first line or the last line.
**/
properties[PROP_ALIGNMENT_MODE] =
g_param_spec_enum ("alignment-mode",
@@ -480,7 +481,7 @@ gtk_source_gutter_renderer_class_init (GtkSourceGutterRendererClass *klass)
* @state: a #GdkModifierType of state
* @n_presses: the number of button presses
*
- * The ::activate signal is emitted when the renderer is activated.
+ * The signal is emitted when the renderer is activated.
*/
signals[ACTIVATE] =
g_signal_new ("activate",
@@ -507,8 +508,7 @@ gtk_source_gutter_renderer_class_init (GtkSourceGutterRendererClass *klass)
* @area: a #GdkRectangle
* @event: the #GdkEvent that is causing the activatable query
*
- * The ::query-activatable signal is emitted when the renderer
- * can possibly be activated.
+ * The signal is emitted when the renderer can possibly be activated.
*/
signals[QUERY_ACTIVATABLE] =
g_signal_new ("query-activatable",
@@ -556,7 +556,7 @@ gtk_source_gutter_renderer_init (GtkSourceGutterRenderer *self)
* @area: a #GdkRectangle of the cell area to be activated
*
* Get whether the renderer is activatable at the location provided. This is
- * called from #GtkSourceGutter to determine whether a renderer is activatable
+ * called from [class@Gutter] to determine whether a renderer is activatable
* using the mouse pointer.
*
* Returns: %TRUE if the renderer can be activated, %FALSE otherwise
@@ -594,8 +594,8 @@ gtk_source_gutter_renderer_query_activatable (GtkSourceGutterRenderer *renderer,
* @state: a #GdkModifierType
* @n_presses: the number of button presses
*
- * Emits the #GtkSourceGutterRenderer::activate signal of the renderer. This is
- * called from #GtkSourceGutter and should never have to be called manually.
+ * Emits the [signal@GutterRenderer::activate] signal of the renderer. This is
+ * called from [class@Gutter] and should never have to be called manually.
*/
void
gtk_source_gutter_renderer_activate (GtkSourceGutterRenderer *renderer,
@@ -618,8 +618,8 @@ gtk_source_gutter_renderer_activate (GtkSourceGutterRenderer *renderer,
* @mode: a #GtkSourceGutterRendererAlignmentMode
*
* Set the alignment mode. The alignment mode describes the manner in which the
- * renderer is aligned (see #GtkSourceGutterRenderer:xalign and
- * #GtkSourceGutterRenderer:yalign).
+ * renderer is aligned (see [property@GutterRenderer:xalign] and
+ * [property@GutterRenderer:yalign]).
**/
void
gtk_source_gutter_renderer_set_alignment_mode (GtkSourceGutterRenderer *renderer,
@@ -645,8 +645,11 @@ gtk_source_gutter_renderer_set_alignment_mode (GtkSourceGutterRenderer
* gtk_source_gutter_renderer_get_alignment_mode:
* @renderer: a #GtkSourceGutterRenderer
*
- * Get the alignment mode. The alignment mode describes the manner in which the
- * renderer is aligned (see :xalign and :yalign).
+ * Get the alignment mode.
+ *
+ * The alignment mode describes the manner in which the
+ * renderer is aligned (see [property@GutterRenderer:xalign] and
+ * [property@GutterRenderer:yalign]).
*
* Returns: a #GtkSourceGutterRendererAlignmentMode
**/
@@ -785,8 +788,9 @@ gtk_source_gutter_renderer_align_cell (GtkSourceGutterRenderer *renderer,
* gtk_source_gutter_renderer_get_xpad:
* @renderer: a #GtkSourceGutterRenderer
*
- * Gets the "xpad" property of the #GtkSourceGutterRenderer. This may be used
- * to adjust the cell rectangle that the renderer will use to draw.
+ * Gets the `xpad` property.
+ *
+ * This may be used to adjust the cell rectangle that the renderer will use to draw.
*/
gint
gtk_source_gutter_renderer_get_xpad (GtkSourceGutterRenderer *renderer)
@@ -803,8 +807,9 @@ gtk_source_gutter_renderer_get_xpad (GtkSourceGutterRenderer *renderer)
* @renderer: a #GtkSourceGutterRenderer
* @xpad: the Y padding for the drawing cell
*
- * Adjusts the "xpad" property of the #GtkSourceGutterRenderer. This may be
- * used to adjust the cell rectangle that the renderer will use to draw.
+ * Adjusts the `xpad` property.
+ *
+ * This may be used to adjust the cell rectangle that the renderer will use to draw.
*/
void
gtk_source_gutter_renderer_set_xpad (GtkSourceGutterRenderer *renderer,
@@ -828,8 +833,9 @@ gtk_source_gutter_renderer_set_xpad (GtkSourceGutterRenderer *renderer,
* gtk_source_gutter_renderer_get_ypad:
* @renderer: a #GtkSourceGutterRenderer
*
- * Gets the "ypad" property of the #GtkSourceGutterRenderer. This may be used
- * to adjust the cell rectangle that the renderer will use to draw.
+ * Gets the `ypad` property.
+ *
+ * This may be used to adjust the cell rectangle that the renderer will use to draw.
*/
gint
gtk_source_gutter_renderer_get_ypad (GtkSourceGutterRenderer *renderer)
@@ -846,8 +852,9 @@ gtk_source_gutter_renderer_get_ypad (GtkSourceGutterRenderer *renderer)
* @renderer: a #GtkSourceGutterRenderer
* @ypad: the Y padding for the drawing cell
*
- * Adjusts the "ypad" property of the #GtkSourceGutterRenderer. This may be
- * used to adjust the cell rectangle that the renderer will use to draw.
+ * Adjusts the `ypad` property.
+ *
+ * This may be used to adjust the cell rectangle that the renderer will use to draw.
*/
void
gtk_source_gutter_renderer_set_ypad (GtkSourceGutterRenderer *renderer,
@@ -871,8 +878,9 @@ gtk_source_gutter_renderer_set_ypad (GtkSourceGutterRenderer *renderer,
* gtk_source_gutter_renderer_get_xalign:
* @renderer: a #GtkSourceGutterRenderer
*
- * Gets the "xalign" property of the #GtkSourceGutterRenderer. This may be used
- * to adjust where within the cell rectangle the renderer will draw.
+ * Gets the `xalign` property.
+ *
+ * This may be used to adjust where within the cell rectangle the renderer will draw.
*/
gfloat
gtk_source_gutter_renderer_get_xalign (GtkSourceGutterRenderer *renderer)
@@ -889,8 +897,9 @@ gtk_source_gutter_renderer_get_xalign (GtkSourceGutterRenderer *renderer)
* @renderer: a #GtkSourceGutterRenderer
* @xalign: the Y padding for the drawing cell
*
- * Adjusts the "xalign" property of the #GtkSourceGutterRenderer. This may be
- * used to adjust where within the cell rectangle the renderer will draw.
+ * Adjusts the `xalign` property.
+ *
+ * This may be used to adjust where within the cell rectangle the renderer will draw.
*/
void
gtk_source_gutter_renderer_set_xalign (GtkSourceGutterRenderer *renderer,
@@ -914,8 +923,9 @@ gtk_source_gutter_renderer_set_xalign (GtkSourceGutterRenderer *renderer,
* gtk_source_gutter_renderer_get_yalign:
* @renderer: a #GtkSourceGutterRenderer
*
- * Gets the "yalign" property of the #GtkSourceGutterRenderer. This may be used
- * to adjust where within the cell rectangle the renderer will draw.
+ * Gets the `yalign` property.
+ *
+ * This may be used to adjust where within the cell rectangle the renderer will draw.
*/
gfloat
gtk_source_gutter_renderer_get_yalign (GtkSourceGutterRenderer *renderer)
@@ -932,8 +942,9 @@ gtk_source_gutter_renderer_get_yalign (GtkSourceGutterRenderer *renderer)
* @renderer: a #GtkSourceGutterRenderer
* @yalign: the Y padding for the drawing cell
*
- * Adjusts the "yalign" property of the #GtkSourceGutterRenderer. This may be
- * used to adjust where within the cell rectangle the renderer will draw.
+ * Adjusts the `yalign` property.
+ *
+ * This may be used to adjust where within the cell rectangle the renderer will draw.
*/
void
gtk_source_gutter_renderer_set_yalign (GtkSourceGutterRenderer *renderer,
@@ -957,7 +968,7 @@ gtk_source_gutter_renderer_set_yalign (GtkSourceGutterRenderer *renderer,
* gtk_source_gutter_renderer_get_buffer:
* @renderer: a #GtkSourceGutterRenderer
*
- * Gets the #GtkSourceBuffer for which the gutter renderer is drawing.
+ * Gets the [class@Buffer] for which the gutter renderer is drawing.
*
* Returns: (transfer none) (nullable): a #GtkTextBuffer or %NULL
*/
diff --git a/gtksourceview/gtksourcegutterrendererpixbuf.c b/gtksourceview/gtksourcegutterrendererpixbuf.c
index 8a6fba88..8fab4665 100644
--- a/gtksourceview/gtksourcegutterrendererpixbuf.c
+++ b/gtksourceview/gtksourcegutterrendererpixbuf.c
@@ -27,8 +27,8 @@
*
* Renders a pixbuf in the gutter.
*
- * A #GtkSourceGutterRendererPixbuf can be used to render an image in a cell of
- * #GtkSourceGutter.
+ * A `GtkSourceGutterRendererPixbuf` can be used to render an image in a cell of
+ * [class@Gutter].
*/
typedef struct
@@ -412,8 +412,8 @@ gtk_source_gutter_renderer_pixbuf_set_paintable (GtkSourceGutterRendererPixbuf *
* gtk_source_gutter_renderer_pixbuf_get_paintable:
* @renderer: a #GtkSourceGutterRendererPixbuf
*
- * Gets a #GdkPaintable that was set with
- * gtk_source_gutter_renderer_pixbuf_set_paintable()
+ * Gets a [class@Gdk.Paintable] that was set with
+ * [method@GutterRendererPixbuf.set_paintable]
*
* Returns: (transfer none) (nullable): a #GdkPaintable or %NULL
*/
diff --git a/gtksourceview/gtksourcegutterrenderertext.c b/gtksourceview/gtksourcegutterrenderertext.c
index d0052014..1329e91c 100644
--- a/gtksourceview/gtksourcegutterrenderertext.c
+++ b/gtksourceview/gtksourcegutterrenderertext.c
@@ -26,8 +26,8 @@
*
* Renders text in the gutter.
*
- * A #GtkSourceGutterRendererText can be used to render text in a cell of
- * #GtkSourceGutter.
+ * A `GtkSourceGutterRendererText` can be used to render text in a cell of
+ * [class@Gutter].
*/
typedef struct
diff --git a/gtksourceview/gtksourcehover.c b/gtksourceview/gtksourcehover.c
index 237f4e00..8b219307 100644
--- a/gtksourceview/gtksourcehover.c
+++ b/gtksourceview/gtksourcehover.c
@@ -37,17 +37,17 @@
*
* Interactive tooltips.
*
- * #GtkSourceHover allows a #GtkSourceView to provide contextual information.
+ * `GtkSourceHover` allows a [class@View] to provide contextual information.
* When enabled, if the user hovers over a word in the text editor, a series
- * of registered #GtkSourceHoverProvider can populate a #GtkSourceHoverDisplay
+ * of registered [iface@HoverProvider] can populate a [class@HoverDisplay]
* with useful information.
*
- * To enable call gtk_source_view_get_hover() and add #GtkSourceHoverProvider
- * using gtk_source_hover_add_provider(). To disable, remove all registered
- * providers with gtk_source_hover_remove_provider().
+ * To enable call [method@View.get_hover] and add [iface@HoverProvider]
+ * using [method@Hover.add_provider]. To disable, remove all registered
+ * providers with [method@Hover.remove_provider].
*
* You can change how long to wait to display the interactive tooltip by
- * setting the #GtkSourceHover:hover-delay property in milliseconds.
+ * setting the [property@Hover:hover-delay] property in milliseconds.
*/
struct _GtkSourceHover
@@ -308,8 +308,7 @@ gtk_source_hover_class_init (GtkSourceHoverClass *klass)
/**
* GtkSourceHover:hover-delay:
*
- * The "hover-delay" property contains the number of milliseconds to
- * delay before showing the hover assistant.
+ * Contains the number of milliseconds to delay before showing the hover assistant.
*/
properties [PROP_HOVER_DELAY] =
g_param_spec_uint ("hover-delay",
diff --git a/gtksourceview/gtksourcehovercontext.c b/gtksourceview/gtksourcehovercontext.c
index 2fb98ade..73fc237e 100644
--- a/gtksourceview/gtksourcehovercontext.c
+++ b/gtksourceview/gtksourcehovercontext.c
@@ -30,16 +30,16 @@
/**
* GtkSourceHoverContext:
*
- * Context for populating #GtkSourceHoverDisplay contents.
+ * Context for populating [class@HoverDisplay] contents.
*
- * #GtkSourceHoverContext contains information about the request to populate
- * contents for a #GtkSourceHoverDisplay.
+ * `GtkSourceHoverContext` contains information about the request to populate
+ * contents for a [class@HoverDisplay].
*
- * It can be used to retrieve the #GtkSourceView, #GtkSourceBuffer, and
- * #GtkTextIter for the regions of text which are being displayed.
+ * It can be used to retrieve the [class@View], [class@Buffer], and
+ * [class@Gtk.TextIter] for the regions of text which are being displayed.
*
- * Use gtk_source_hover_context_get_bounds() to get the word that was
- * requested. gtk_source_hover_contents_get_iter() will get you the location
+ * Use [method@HoverContext.get_bounds] to get the word that was
+ * requested. [method@HoverContext.get_iter] will get you the location
* of the pointer when the request was made.
*/
diff --git a/gtksourceview/gtksourcehoverdisplay.c b/gtksourceview/gtksourcehoverdisplay.c
index 7f704338..4422c012 100644
--- a/gtksourceview/gtksourcehoverdisplay.c
+++ b/gtksourceview/gtksourcehoverdisplay.c
@@ -28,12 +28,12 @@
*
* Display for interactive tooltips.
*
- * #GtkSourceHoverDisplay is a #GtkWidget that may be populated with widgets
+ * `GtkSourceHoverDisplay` is a [class@Gtk.Widget] that may be populated with widgets
* to be displayed to the user in interactive tooltips. The children widgets
- * are packed vertically using a #GtkBox.
+ * are packed vertically using a [class Gtk Box].
*
- * Implement the #GtkSourceHoverProvider interface to be notified of when
- * to populate a #GtkSourceHoverDisplay on behalf of the user.
+ * Implement the [iface@HoverProvider] interface to be notified of when
+ * to populate a `GtkSourceHoverDisplay` on behalf of the user.
*/
struct _GtkSourceHoverDisplay
diff --git a/gtksourceview/gtksourcehoverprovider.c b/gtksourceview/gtksourcehoverprovider.c
index e22e9ed4..2d408ee4 100644
--- a/gtksourceview/gtksourcehoverprovider.c
+++ b/gtksourceview/gtksourcehoverprovider.c
@@ -30,13 +30,13 @@
*
* Interface to populate interactive tooltips.
*
- * #GtkSourceHoverProvider is an interface that should be implemented to extend
- * the contents of a #GtkSourceHoverDisplay. This is typical in editors that
+ * `GtkSourceHoverProvider` is an interface that should be implemented to extend
+ * the contents of a [class@HoverDisplay]. This is typical in editors that
* interact external tooling such as those utilizing Language Server Protocol.
*
- * If you can populate the #GtkSourceHoverDisplay synchronously, use
- * #GtkSourceHoverProvider.populate. Otherwise, interface implementations that
- * may take additional time should use #GtkSourceHoverProvider.populate_async
+ * If you can populate the [class@HoverDisplay] synchronously, use
+ * [vfunc@HoverProvider.populate]. Otherwise, interface implementations that
+ * may take additional time should use [vfunc@HoverProvider.populate_async]
* to avoid blocking the main loop.
*/
diff --git a/gtksourceview/gtksourceindenter.c b/gtksourceview/gtksourceindenter.c
index ffefa7e7..bc5440f3 100644
--- a/gtksourceview/gtksourceindenter.c
+++ b/gtksourceview/gtksourceindenter.c
@@ -29,29 +29,28 @@
*
* Auto-indentation interface.
*
- * By default, #GtkSourceView can auto-indent as you type when
- * #GtkSourceView:auto-indent is enabled. The indentation simply copies the
+ * By default, [class@View] can auto-indent as you type when
+ * [property@View:auto-indent] is enabled. The indentation simply copies the
* previous lines indentation.
*
- * This can be changed by implementing #GtkSourceIndenter and setting the
- * #GtkSourceView:indenter property.
+ * This can be changed by implementing `GtkSourceIndenter` and setting the
+ * [property@View:indenter] property.
*
* Implementors of this interface should implement both
- * #GtkSourceIndenterInterface.is_trigger and
- * #GtkSourceIndenterInterface.indent.
+ * [vfunc@Indenter.is_trigger] and [vfunc@Indenter.indent].
*
- * #GtkSourceIndenterInterface.is_trigger is called upon key-press to
+ * [vfunc@Indenter.is_trigger] is called upon key-press to
* determine of the key press should trigger an indentation. The default
* implementation of the interface checks to see if the key was
- * %GDK_KEY_Return or %GDK_KEY_KP_Enter without %GDK_SHIFT_MASK set.
+ * [const@Gdk.KEY_Return] or [const@Gdk.KEY_KP_Enter] without %GDK_SHIFT_MASK set.
*
- * #GtkSourceIndenterInterface.indent is called after text has been
- * inserted into #GtkSourceBuffer when
- * #GtkSourceIndenterInterface.is_trigger returned %TRUE. The #GtkTextIter
+ * [vfunc@Indenter.indent] is called after text has been
+ * inserted into [class@Buffer] when
+ * [vfunc@Indenter.is_trigger] returned %TRUE. The [class@Gtk.TextIter]
* is placed directly after the inserted character or characters.
*
* It may be beneficial to move the insertion mark using
- * gtk_text_buffer_select_range() depending on how the indenter changes
+ * [method@Gtk.TextBuffer.select_range] depending on how the indenter changes
* the indentation.
*
* All changes are encapsulated within a single user action so that the
@@ -168,13 +167,13 @@ gtk_source_indenter_default_init (GtkSourceIndenterInterface *iface)
* @view: a #GtkSourceView
* @location: the location where @ch is to be inserted
* @state: modifier state for the insertion
- * @keyval: the keyval pressed such as %GDK_KEY_Return
+ * @keyval: the keyval pressed such as [const@Gdk.KEY_Return]
*
* This function is used to determine if a key pressed should cause the
* indenter to automatically indent.
*
* The default implementation of this virtual method will check to see
- * if @keyval is %GDK_KEY_Return or %GDK_KEY_KP_Enter and @state does
+ * if @keyval is [const@Gdk.KEY_Return] or [const@Gdk.KEY_KP_Enter] and @state does
* not have %GDK_SHIFT_MASK set. This is to allow the user to avoid
* indentation when Shift+Return is pressed. Other indenters may want
* to copy this behavior to provide a consistent experience to users.
@@ -203,14 +202,15 @@ gtk_source_indenter_is_trigger (GtkSourceIndenter *self,
* @iter: (inout): the location of the indentation request
*
* This function should be implemented to alter the indentation of text
- * within the view. @view is provided so that the indenter may retrieve
- * settings such as indentation and tab widths.
+ * within the view.
+ *
+ * @view is provided so that the indenter may retrieve settings such as indentation and tab widths.
*
* @iter is the location where the indentation was requested. This typically
* is after having just inserted a newline (\n) character but can be other
* situations such as a manually requested indentation or reformatting.
*
- * See gtk_source_indenter_is_trigger() for how to trigger indentation on
+ * See [iface@Indenter.is_trigger] for how to trigger indentation on
* various characters inserted into the buffer.
*
* The implementor of this function is expected to keep @iter valid across
diff --git a/gtksourceview/gtksourcelanguage.c b/gtksourceview/gtksourcelanguage.c
index 999474ca..d0dbd816 100644
--- a/gtksourceview/gtksourcelanguage.c
+++ b/gtksourceview/gtksourcelanguage.c
@@ -42,11 +42,11 @@
*
* Represents a syntax highlighted language.
*
- * A #GtkSourceLanguage represents a programming or markup language, affecting
+ * A `GtkSourceLanguage` represents a programming or markup language, affecting
* syntax highlighting and [context classes][context-classes].
*
- * Use #GtkSourceLanguageManager to obtain a #GtkSourceLanguage instance, and
- * gtk_source_buffer_set_language() to apply it to a #GtkSourceBuffer.
+ * Use [class@LanguageManager] to obtain a `GtkSourceLanguage` instance, and
+ * [method@Buffer.set_language] to apply it to a [class@Buffer].
*/
#define DEFAULT_SECTION _("Others")
@@ -505,9 +505,10 @@ _gtk_source_language_translate_string (GtkSourceLanguage *language,
* gtk_source_language_get_id:
* @language: a #GtkSourceLanguage.
*
- * Returns the ID of the language. The ID is not locale-dependent.
- * The returned string is owned by @language and should not be freed
- * or modified.
+ * Returns the ID of the language.
+ *
+ * The ID is not locale-dependent.The returned string is owned by @language
+ * and should not be freed or modified.
*
* Returns: the ID of @language.
**/
@@ -525,6 +526,7 @@ gtk_source_language_get_id (GtkSourceLanguage *language)
* @language: a #GtkSourceLanguage.
*
* Returns the localized name of the language.
+ *
* The returned string is owned by @language and should not be freed
* or modified.
*
@@ -544,6 +546,7 @@ gtk_source_language_get_name (GtkSourceLanguage *language)
* @language: a #GtkSourceLanguage.
*
* Returns the localized section of the language.
+ *
* Each language belong to a section (ex. HTML belongs to the
* Markup section).
* The returned string is owned by @language and should not be freed
@@ -601,8 +604,9 @@ gtk_source_language_get_metadata (GtkSourceLanguage *language,
* gtk_source_language_get_mime_types:
* @language: a #GtkSourceLanguage.
*
- * Returns the mime types associated to this language. This is just
- * an utility wrapper around gtk_source_language_get_metadata() to
+ * Returns the mime types associated to this language.
+ *
+ * This is just an utility wrapper around [method@Language.get_metadata] to
* retrieve the "mimetypes" metadata property and split it into an
* array.
*
@@ -629,8 +633,9 @@ gtk_source_language_get_mime_types (GtkSourceLanguage *language)
* gtk_source_language_get_globs:
* @language: a #GtkSourceLanguage.
*
- * Returns the globs associated to this language. This is just
- * an utility wrapper around gtk_source_language_get_metadata() to
+ * Returns the globs associated to this language.
+ *
+ * This is just an utility wrapper around [method@Language.get_metadata] to
* retrieve the "globs" metadata property and split it into an array.
*
* Returns: (nullable) (array zero-terminated=1) (transfer full):
diff --git a/gtksourceview/gtksourcelanguagemanager.c b/gtksourceview/gtksourcelanguagemanager.c
index 81557b63..84b3c8d0 100644
--- a/gtksourceview/gtksourcelanguagemanager.c
+++ b/gtksourceview/gtksourcelanguagemanager.c
@@ -30,14 +30,15 @@
/**
* GtkSourceLanguageManager:
*
- * Provides access to GtkSourceLanguages.
+ * Provides access to [class@Language]s.
*
- * #GtkSourceLanguageManager is an object which processes language description
- * files and creates and stores #GtkSourceLanguage objects, and provides API to
+ * `GtkSourceLanguageManager` is an object which processes language description
+ * files and creates and stores [class@Language] objects, and provides API to
* access them.
- * Use gtk_source_language_manager_get_default() to retrieve the default
- * instance of #GtkSourceLanguageManager, and
- * gtk_source_language_manager_guess_language() to get a #GtkSourceLanguage for
+ *
+ * Use [func@LanguageManager.get_default] to retrieve the default
+ * instance of `GtkSourceLanguageManager`, and
+ * [method@LanguageManager.guess_language] to get a [class@Language] for
* given file name and content type.
*/
@@ -179,9 +180,10 @@ gtk_source_language_manager_init (GtkSourceLanguageManager *lm)
/**
* gtk_source_language_manager_new:
*
- * Creates a new language manager. If you do not need more than one language
- * manager or a private language manager instance then use
- * gtk_source_language_manager_get_default() instead.
+ * Creates a new language manager.
+ *
+ * If you do not need more than one language manager or a private language manager
+ * instance then use [func@LanguageManager.get_default] instead.
*
* Returns: a new #GtkSourceLanguageManager.
*/
@@ -233,16 +235,13 @@ notify_search_path (GtkSourceLanguageManager *mgr)
*
* Sets the list of directories where the @lm looks for
* language files.
+ *
* If @dirs is %NULL, the search path is reset to default.
*
- * <note>
- * <para>
- * At the moment this function can be called only before the
- * language files are loaded for the first time. In practice
- * to set a custom search path for a #GtkSourceLanguageManager,
- * you have to call this function right after creating it.
- * </para>
- * </note>
+ * At the moment this function can be called only before the
+ * language files are loaded for the first time. In practice
+ * to set a custom search path for a `GtkSourceLanguageManager`,
+ * you have to call this function right after creating it.
*/
void
gtk_source_language_manager_set_search_path (GtkSourceLanguageManager *lm,
@@ -438,7 +437,7 @@ gtk_source_language_manager_get_language_ids (GtkSourceLanguageManager *lm)
* @lm: a #GtkSourceLanguageManager.
* @id: a language id.
*
- * Gets the #GtkSourceLanguage identified by the given @id in the language
+ * Gets the [class@Language] identified by the given @id in the language
* manager.
*
* Returns: (nullable) (transfer none): a #GtkSourceLanguage, or %NULL
@@ -608,37 +607,38 @@ pick_lang_for_mime_type (GtkSourceLanguageManager *lm,
* @filename: (nullable): a filename in Glib filename encoding, or %NULL.
* @content_type: (nullable): a content type (as in GIO API), or %NULL.
*
- * Picks a #GtkSourceLanguage for given file name and content type,
- * according to the information in lang files. Either @filename or
- * @content_type may be %NULL. This function can be used as follows:
+ * Picks a [class@Language] for given file name and content type,
+ * according to the information in lang files.
+ *
+ * Either @filename or @content_type may be %NULL. This function can be used as follows:
*
- * <informalexample><programlisting>
- * GtkSourceLanguage *lang;
- * lang = gtk_source_language_manager_guess_language (filename, NULL);
- * gtk_source_buffer_set_language (buffer, lang);
- * </programlisting></informalexample>
+ * ```c
+ * GtkSourceLanguage *lang;
+ * lang = gtk_source_language_manager_guess_language (filename, NULL);
+ * gtk_source_buffer_set_language (buffer, lang);
+ * ```
*
* or
*
- * <informalexample><programlisting>
- * GtkSourceLanguage *lang = NULL;
- * gboolean result_uncertain;
- * gchar *content_type;
+ * ```c
+ * GtkSourceLanguage *lang = NULL;
+ * gboolean result_uncertain;
+ * gchar *content_type;
*
- * content_type = g_content_type_guess (filename, NULL, 0, &result_uncertain);
- * if (result_uncertain)
- * {
- * g_free (content_type);
- * content_type = NULL;
- * }
+ * content_type = g_content_type_guess (filename, NULL, 0, &result_uncertain);
+ * if (result_uncertain)
+ * {
+ * g_free (content_type);
+ * content_type = NULL;
+ * }
*
- * lang = gtk_source_language_manager_guess_language (manager, filename, content_type);
- * gtk_source_buffer_set_language (buffer, lang);
+ * lang = gtk_source_language_manager_guess_language (manager, filename, content_type);
+ * gtk_source_buffer_set_language (buffer, lang);
*
- * g_free (content_type);
- * </programlisting></informalexample>
+ * g_free (content_type);
+ * ```
*
- * etc. Use gtk_source_language_get_mime_types() and gtk_source_language_get_globs()
+ * etc. Use [method@Language.get_mime_types] and [method@Language.get_globs]
* if you need full control over file -> language mapping.
*
* Returns: (nullable) (transfer none): a #GtkSourceLanguage, or %NULL if there
diff --git a/gtksourceview/gtksourcemap.c b/gtksourceview/gtksourcemap.c
index 2c619208..4505e675 100644
--- a/gtksourceview/gtksourcemap.c
+++ b/gtksourceview/gtksourcemap.c
@@ -41,28 +41,28 @@
/**
* GtkSourceMap:
*
- * Widget that displays a map for a specific #GtkSourceView.
+ * Widget that displays a map for a specific [class@View].
*
- * #GtkSourceMap is a widget that maps the content of a #GtkSourceView into
+ * `GtkSourceMap` is a widget that maps the content of a [class@View] into
* a smaller view so the user can have a quick overview of the whole document.
*
- * This works by connecting a #GtkSourceView to to the #GtkSourceMap using
- * the #GtkSourceMap:view property or gtk_source_map_set_view().
+ * This works by connecting a [class@View] to to the `GtkSourceMap` using
+ * the [property@Map:view] property or [method@Map.set_view].
*
- * #GtkSourceMap is a #GtkSourceView object. This means that you can add a
- * #GtkSourceGutterRenderer to a gutter in the same way you would for a
- * #GtkSourceView. One example might be a #GtkSourceGutterRenderer that shows
+ * `GtkSourceMap` is a [class@View] object. This means that you can add a
+ * [class@GutterRenderer] to a gutter in the same way you would for a
+ * [class@View]. One example might be a [class@GutterRenderer] that shows
* which lines have changed in the document.
*
- * Additionally, it is desirable to match the font of the #GtkSourceMap and
- * the #GtkSourceView used for editing. Therefore, #GtkSourceMap:font-desc
+ * Additionally, it is desirable to match the font of the `GtkSourceMap` and
+ * the [class@View] used for editing. Therefore, [property@Map:font-desc]
* should be used to set the target font. You will need to adjust this to the
* desired font size for the map. A 1pt font generally seems to be an
* appropriate font size. "Monospace 1" is the default. See
- * pango_font_description_set_size() for how to alter the size of an existing
- * #PangoFontDescription.
+ * [method@Pango.FontDescription.set_size] for how to alter the size of an existing
+ * [class@Pango.FontDescription].
*
- * When FontConfig is available, #GtkSourceMap will try to use a bundled
+ * When FontConfig is available, `GtkSourceMap` will try to use a bundled
* "block" font to make the map more legible.
*/
@@ -1316,7 +1316,7 @@ gtk_source_map_init (GtkSourceMap *map)
/**
* gtk_source_map_new:
*
- * Creates a new #GtkSourceMap.
+ * Creates a new `GtkSourceMap`.
*
* Returns: a new #GtkSourceMap.
*/
@@ -1366,7 +1366,7 @@ gtk_source_map_set_view (GtkSourceMap *map,
* gtk_source_map_get_view:
* @map: a #GtkSourceMap.
*
- * Gets the #GtkSourceMap:view property, which is the view this widget is mapping.
+ * Gets the [property@Map:view] property, which is the view this widget is mapping.
*
* Returns: (transfer none) (nullable): a #GtkSourceView or %NULL.
*/
diff --git a/gtksourceview/gtksourcemark.c b/gtksourceview/gtksourcemark.c
index 9b82ef1a..3afcdd2e 100644
--- a/gtksourceview/gtksourcemark.c
+++ b/gtksourceview/gtksourcemark.c
@@ -26,17 +26,17 @@
/**
* GtkSourceMark:
*
- * Mark object for GtkSourceBuffer.
+ * Mark object for [class@Buffer].
*
- * A #GtkSourceMark marks a position in the text where you want to display
- * additional info. It is based on #GtkTextMark and thus is still valid after
+ * A `GtkSourceMark` marks a position in the text where you want to display
+ * additional info. It is based on [class@Gtk.TextMark] and thus is still valid after
* the text has changed though its position may change.
*
- * #GtkSourceMark<!-- -->s are organised in categories which you have to set
+ * `GtkSourceMark`s are organized in categories which you have to set
* when you create the mark. Each category can have a priority, a pixbuf and
- * other associated attributes. See gtk_source_view_set_mark_attributes().
+ * other associated attributes. See [method@View.set_mark_attributes].
* The pixbuf will be displayed in the margin at the line where the mark
- * residents if the #GtkSourceView:show-line-marks property is set to %TRUE. If
+ * residents if the [property@View:show-line-marks] property is set to %TRUE. If
* there are multiple marks in the same line, the pixbufs will be drawn on top
* of each other. The mark with the highest priority will be drawn on top.
*/
@@ -123,7 +123,7 @@ gtk_source_mark_class_init (GtkSourceMarkClass *klass)
/**
* GtkSourceMark:category:
*
- * The category of the #GtkSourceMark, classifies the mark and controls
+ * The category of the `GtkSourceMark`, classifies the mark and controls
* which pixbuf is used and with which priority it is drawn.
*/
g_object_class_install_property (object_class,
@@ -150,13 +150,15 @@ gtk_source_mark_init (GtkSourceMark *mark)
* category, or all the marks representing a compilation error could belong
* to "error" category).
*
- * Creates a text mark. Add it to a buffer using gtk_text_buffer_add_mark().
+ * Creates a text mark.
+ *
+ * Add it to a buffer using [method@Gtk.TextBuffer.add_mark].
* If name is NULL, the mark is anonymous; otherwise, the mark can be retrieved
- * by name using gtk_text_buffer_get_mark().
+ * by name using [method@Gtk.TextBuffer.get_mark].
* Normally marks are created using the utility function
- * gtk_source_buffer_create_source_mark().
+ * [method@Buffer.create_source_mark].
*
- * Returns: a new #GtkSourceMark that can be added using gtk_text_buffer_add_mark().
+ * Returns: a new #GtkSourceMark that can be added using [method@Gtk.TextBuffer.add_mark].
*/
GtkSourceMark *
gtk_source_mark_new (const gchar *name,
@@ -194,8 +196,10 @@ gtk_source_mark_get_category (GtkSourceMark *mark)
* @mark: a #GtkSourceMark.
* @category: (nullable): a string specifying the mark category, or %NULL.
*
- * Returns the next #GtkSourceMark in the buffer or %NULL if the mark
- * was not added to a buffer. If there is no next mark, %NULL will be returned.
+ * Returns the next `GtkSourceMark` in the buffer or %NULL if the mark
+ * was not added to a buffer.
+ *
+ * If there is no next mark, %NULL will be returned.
*
* If @category is %NULL, looks for marks of any category.
*
@@ -226,8 +230,10 @@ gtk_source_mark_next (GtkSourceMark *mark,
* @mark: a #GtkSourceMark.
* @category: a string specifying the mark category, or %NULL.
*
- * Returns the previous #GtkSourceMark in the buffer or %NULL if the mark
- * was not added to a buffer. If there is no previous mark, %NULL is returned.
+ * Returns the previous `GtkSourceMark` in the buffer or %NULL if the mark
+ * was not added to a buffer.
+ *
+ * If there is no previous mark, %NULL is returned.
*
* If @category is %NULL, looks for marks of any category
*
diff --git a/gtksourceview/gtksourcemarkattributes.c b/gtksourceview/gtksourcemarkattributes.c
index fe75a963..a0230d62 100644
--- a/gtksourceview/gtksourcemarkattributes.c
+++ b/gtksourceview/gtksourcemarkattributes.c
@@ -27,48 +27,37 @@
/**
* GtkSourceMarkAttributes:
+ *
* The source mark attributes object.
*
- * #GtkSourceMarkAttributes is an object specifying attributes used by
- * a #GtkSourceView to visually show lines marked with #GtkSourceMark<!-- -->s
+ * `GtkSourceMarkAttributes` is an object specifying attributes used by
+ * a [class@View] to visually show lines marked with [class@Mark]s
* of a specific category. It allows you to define a background color of a line,
* an icon shown in gutter and tooltips.
*
* The background color is used as a background of a line where a mark is placed
- * and it can be set with gtk_source_mark_attributes_set_background(). To check
+ * and it can be set with [method@MarkAttributes.set_background]. To check
* if any custom background color was defined and what color it is, use
- * gtk_source_mark_attributes_get_background().
+ * [method@MarkAttributes.get_background].
*
* An icon is a graphic element which is shown in the gutter of a view. An
* example use is showing a red filled circle in a debugger to show that a
* breakpoint was set in certain line. To get an icon that will be placed in
* a gutter, first a base for it must be specified and then
- * gtk_source_mark_attributes_render_icon() must be called.
+ * [method@MarkAttributes.render_icon] must be called.
* There are several ways to specify a base for an icon:
- * <itemizedlist>
- * <listitem>
- * <para>
- * gtk_source_mark_attributes_set_icon_name()
- * </para>
- * </listitem>
- * <listitem>
- * <para>
- * gtk_source_mark_attributes_set_gicon()
- * </para>
- * </listitem>
- * <listitem>
- * <para>
- * gtk_source_mark_attributes_set_pixbuf()
- * </para>
- * </listitem>
- * </itemizedlist>
+ *
+ * - [method@MarkAttributes.set_icon_name]
+ * - [method@MarkAttributes.set_gicon]
+ * - [method@MarkAttributes.set_pixbuf]
+ *
* Using any of the above functions overrides the one used earlier. But note
* that a getter counterpart of earlier used function can still return some
* value, but it is just not used when rendering the proper icon.
*
* To provide meaningful tooltips for a given mark of a category, you should
- * connect to #GtkSourceMarkAttributes::query-tooltip-text or
- * #GtkSourceMarkAttributes::query-tooltip-markup where the latter
+ * connect to [signal@MarkAttributes::query-tooltip-text] or
+ * [signal@MarkAttributes::query-tooltip-markup] where the latter
* takes precedence.
*/
@@ -441,8 +430,9 @@ gtk_source_mark_attributes_set_icon_name (GtkSourceMarkAttributes *attributes,
* gtk_source_mark_attributes_get_icon_name:
* @attributes: a #GtkSourceMarkAttributes.
*
- * Gets a name of an icon to be used as a base for rendered icon. Note that the
- * icon name can be %NULL if it wasn't set earlier.
+ * Gets a name of an icon to be used as a base for rendered icon.
+ *
+ * Note that the icon name can be %NULL if it wasn't set earlier.
*
* Returns: (transfer none): An icon name. The string belongs to @attributes and
* should not be freed.
@@ -475,8 +465,9 @@ gtk_source_mark_attributes_set_gicon (GtkSourceMarkAttributes *attributes,
* gtk_source_mark_attributes_get_gicon:
* @attributes: a #GtkSourceMarkAttributes.
*
- * Gets a #GIcon to be used as a base for rendered icon. Note that the icon can
- * be %NULL if it wasn't set earlier.
+ * Gets a [class Gio Icon] to be used as a base for rendered icon.
+ *
+ * Note that the icon can be %NULL if it wasn't set earlier.
*
* Returns: (transfer none): An icon. The icon belongs to @attributes and should
* not be unreffed.
@@ -509,8 +500,9 @@ gtk_source_mark_attributes_set_pixbuf (GtkSourceMarkAttributes *attributes,
* gtk_source_mark_attributes_get_pixbuf:
* @attributes: a #GtkSourceMarkAttributes.
*
- * Gets a #GdkPixbuf to be used as a base for rendered icon. Note that the
- * pixbuf can be %NULL if it wasn't set earlier.
+ * Gets a [class@GdkPixbuf.Pixbuf] to be used as a base for rendered icon.
+ *
+ * Note that the pixbuf can be %NULL if it wasn't set earlier.
*
* Returns: (transfer none): A pixbuf. The pixbuf belongs to @attributes and
* should not be unreffed.
@@ -529,10 +521,15 @@ gtk_source_mark_attributes_get_pixbuf (GtkSourceMarkAttributes *attributes)
* @widget: widget of which style settings may be used.
* @size: size of the rendered icon.
*
- * Renders an icon of given size. The base of the icon is set by the last call
- * to one of: gtk_source_mark_attributes_set_pixbuf(),
- * gtk_source_mark_attributes_set_gicon() or
- * gtk_source_mark_attributes_set_icon_name(). @size cannot be lower than 1.
+ * Renders an icon of given size.
+ *
+ * The base of the icon is set by the last call to one of:
+ *
+ * - [method@MarkAttributes.set_pixbuf]
+ * - [method@MarkAttributes.set_gicon]
+ * - [method@MarkAttributes.set_icon_name]
+ *
+ * @size cannot be lower than 1.
*
* Returns: (transfer none): A #GdkPaintable. The paintable belongs to @attributes
* and should not be unreffed.
@@ -562,9 +559,9 @@ gtk_source_mark_attributes_render_icon (GtkSourceMarkAttributes *attributes,
* @attributes: a #GtkSourceMarkAttributes.
* @mark: a #GtkSourceMark.
*
- * Queries for a tooltip by emitting
- * a #GtkSourceMarkAttributes::query-tooltip-text signal. The tooltip is a plain
- * text.
+ * Queries for a tooltip by emitting a [signal@MarkAttributes::query-tooltip-text] signal.
+ *
+ * The tooltip is a plain text.
*
* Returns: (transfer full): A tooltip. The returned string should be freed by
* using g_free() when done with it.
@@ -589,9 +586,9 @@ gtk_source_mark_attributes_get_tooltip_text (GtkSourceMarkAttributes *attributes
* @attributes: a #GtkSourceMarkAttributes.
* @mark: a #GtkSourceMark.
*
- * Queries for a tooltip by emitting
- * a #GtkSourceMarkAttributes::query-tooltip-markup signal. The tooltip may contain
- * a markup.
+ * Queries for a tooltip by emitting a [signal@MarkAttributes::query-tooltip-markup] signal.
+ *
+ * The tooltip may contain a markup.
*
* Returns: (transfer full): A tooltip. The returned string should be freed by
* using g_free() when done with it.
diff --git a/gtksourceview/gtksourceprintcompositor.c b/gtksourceview/gtksourceprintcompositor.c
index 85b05bbe..5a087070 100644
--- a/gtksourceview/gtksourceprintcompositor.c
+++ b/gtksourceview/gtksourceprintcompositor.c
@@ -35,19 +35,19 @@
/**
* GtkSourcePrintCompositor:
*
- * Compose a GtkSourceBuffer for printing.
+ * Compose a [class@Buffer] for printing.
*
- * The #GtkSourcePrintCompositor object is used to compose a #GtkSourceBuffer
+ * The `GtkSourcePrintCompositor` object is used to compose a [class@Buffer]
* for printing. You can set various configuration options to customize the
- * printed output. #GtkSourcePrintCompositor is designed to be used with the
- * high-level printing API of gtk+, i.e. #GtkPrintOperation.
+ * printed output. `GtkSourcePrintCompositor` is designed to be used with the
+ * high-level printing API of gtk+, i.e. [class@Gtk.PrintOperation].
*
* The margins specified in this object are the layout margins: they define the
* blank space bordering the printed area of the pages. They must not be
* confused with the "print margins", i.e. the parts of the page that the
- * printer cannot print on, defined in the #GtkPageSetup objects. If the
+ * printer cannot print on, defined in the [class@Gtk.PageSetup] objects. If the
* specified layout margins are smaller than the "print margins", the latter
- * ones are used as a fallback by the #GtkSourcePrintCompositor object, so that
+ * ones are used as a fallback by the `GtkSourcePrintCompositor` object, so that
* the printed area is not clipped.
*/
@@ -432,7 +432,7 @@ gtk_source_print_compositor_class_init (GtkSourcePrintCompositorClass *klass)
/**
* GtkSourcePrintCompositor:buffer:
*
- * The GtkSourceBuffer object to print.
+ * The [class@Buffer] object to print.
*/
properties[PROP_BUFFER] =
g_param_spec_object ("buffer",
@@ -449,7 +449,7 @@ gtk_source_print_compositor_class_init (GtkSourcePrintCompositorClass *klass)
* Width of a tab character expressed in spaces.
*
* The value of this property cannot be changed anymore after the first
- * call to the gtk_source_print_compositor_paginate() function.
+ * call to the [method@PrintCompositor.paginate] function.
*/
properties [PROP_TAB_WIDTH] =
g_param_spec_uint ("tab-width",
@@ -469,7 +469,7 @@ gtk_source_print_compositor_class_init (GtkSourcePrintCompositorClass *klass)
* Whether to wrap lines never, at word boundaries, or at character boundaries.
*
* The value of this property cannot be changed anymore after the first
- * call to the gtk_source_print_compositor_paginate() function.
+ * call to the [method@PrintCompositor.paginate] function.
*/
properties [PROP_WRAP_MODE] =
g_param_spec_enum ("wrap-mode",
@@ -487,7 +487,7 @@ gtk_source_print_compositor_class_init (GtkSourcePrintCompositorClass *klass)
* Whether to print the document with highlighted syntax.
*
* The value of this property cannot be changed anymore after the first
- * call to the gtk_source_print_compositor_paginate() function.
+ * call to the [method@PrintCompositor.paginate] function.
*/
properties [PROP_HIGHLIGHT_SYNTAX] =
g_param_spec_boolean ("highlight-syntax",
@@ -501,12 +501,14 @@ gtk_source_print_compositor_class_init (GtkSourcePrintCompositorClass *klass)
/**
* GtkSourcePrintCompositor:print-line-numbers:
*
- * Interval of printed line numbers. If this property is set to 0 no
- * numbers will be printed. If greater than 0, a number will be
- * printed every "print-line-numbers" lines (i.e. 1 will print all line numbers).
+ * Interval of printed line numbers.
+ *
+ * If this property is set to 0 no numbers will be printed.
+ * If greater than 0, a number will be printed every "print-line-numbers"
+ * lines (i.e. 1 will print all line numbers).
*
* The value of this property cannot be changed anymore after the first
- * call to the gtk_source_print_compositor_paginate() function.
+ * call to the [method@PrintCompositor.paginate] function.
*/
properties [PROP_PRINT_LINE_NUMBERS] =
g_param_spec_uint ("print-line-numbers",
@@ -527,7 +529,7 @@ gtk_source_print_compositor_class_init (GtkSourcePrintCompositorClass *klass)
* this property.
*
* The value of this property cannot be changed anymore after the first
- * call to the gtk_source_print_compositor_paginate() function.
+ * call to the [method@PrintCompositor.paginate] function.
*/
properties [PROP_PRINT_HEADER] =
g_param_spec_boolean ("print-header",
@@ -548,7 +550,7 @@ gtk_source_print_compositor_class_init (GtkSourcePrintCompositorClass *klass)
* this property.
*
* The value of this property cannot be changed anymore after the first
- * call to the gtk_source_print_compositor_paginate() function.
+ * call to the [method@PrintCompositor.paginate] function.
*/
properties [PROP_PRINT_FOOTER] =
g_param_spec_boolean ("print-footer",
@@ -565,11 +567,11 @@ gtk_source_print_compositor_class_init (GtkSourcePrintCompositorClass *klass)
* Name of the font used for the text body.
*
* Accepted values are strings representing a font description Pango can understand.
- * (e.g. "Monospace 10"). See pango_font_description_from_string()
+ * (e.g. "Monospace 10"). See [func@Pango.FontDescription.from_string]
* for a description of the format of the string representation.
*
* The value of this property cannot be changed anymore after the first
- * call to the gtk_source_print_compositor_paginate() function.
+ * call to the [method@PrintCompositor.paginate] function.
*/
properties [PROP_BODY_FONT_NAME] =
g_param_spec_string ("body-font-name",
@@ -587,11 +589,11 @@ gtk_source_print_compositor_class_init (GtkSourcePrintCompositorClass *klass)
* If this property is unspecified, the text body font is used.
*
* Accepted values are strings representing a font description Pango can understand.
- * (e.g. "Monospace 10"). See pango_font_description_from_string()
+ * (e.g. "Monospace 10"). See [func@Pango.FontDescription.from_string]
* for a description of the format of the string representation.
*
* The value of this property cannot be changed anymore after the first
- * call to the gtk_source_print_compositor_paginate() function.
+ * call to the [method@PrintCompositor.paginate] function.
*/
properties [PROP_LINE_NUMBERS_FONT_NAME] =
g_param_spec_string ("line-numbers-font-name",
@@ -609,11 +611,11 @@ gtk_source_print_compositor_class_init (GtkSourcePrintCompositorClass *klass)
* If this property is unspecified, the text body font is used.
*
* Accepted values are strings representing a font description Pango can understand.
- * (e.g. "Monospace 10"). See pango_font_description_from_string()
+ * (e.g. "Monospace 10"). See [func@Pango.FontDescription.from_string]
* for a description of the format of the string representation.
*
* The value of this property cannot be changed anymore after the first
- * call to the gtk_source_print_compositor_paginate() function.
+ * call to the [method@PrintCompositor.paginate] function.
*/
properties [PROP_HEADER_FONT_NAME] =
g_param_spec_string ("header-font-name",
@@ -631,11 +633,11 @@ gtk_source_print_compositor_class_init (GtkSourcePrintCompositorClass *klass)
* If this property is unspecified, the text body font is used.
*
* Accepted values are strings representing a font description Pango can understand.
- * (e.g. "Monospace 10"). See pango_font_description_from_string()
+ * (e.g. "Monospace 10"). See [func@Pango.FontDescription.from_string]
* for a description of the format of the string representation.
*
* The value of this property cannot be changed anymore after the first
- * call to the gtk_source_print_compositor_paginate() function.
+ * call to the [method@PrintCompositor.paginate] function.
*/
properties [PROP_FOOTER_FONT_NAME] =
g_param_spec_string ("footer-font-name",
@@ -746,11 +748,12 @@ gtk_source_print_compositor_new (GtkSourceBuffer *buffer)
*
* Creates a new print compositor that can be used to print the buffer
* associated with @view.
+ *
* This constructor sets some configuration properties to make the
* printed output match @view as much as possible. The properties set are
- * #GtkSourcePrintCompositor:tab-width, #GtkSourcePrintCompositor:highlight-syntax,
- * #GtkSourcePrintCompositor:wrap-mode, #GtkSourcePrintCompositor:body-font-name and
- * #GtkSourcePrintCompositor:print-line-numbers.
+ * [property@PrintCompositor:tab-width], [property@PrintCompositor:highlight-syntax],
+ * [property@PrintCompositor:wrap-mode], [property@PrintCompositor:body-font-name] and
+ * [property@PrintCompositor:print-line-numbers].
*
* Return value: a new print compositor object.
**/
@@ -792,8 +795,9 @@ gtk_source_print_compositor_new_from_view (GtkSourceView *view)
* gtk_source_print_compositor_get_buffer:
* @compositor: a #GtkSourcePrintCompositor.
*
- * Gets the #GtkSourceBuffer associated with the compositor. The returned
- * object reference is owned by the compositor object and
+ * Gets the [class@Buffer] associated with the compositor.
+ *
+ * The returned object reference is owned by the compositor object and
* should not be unreferenced.
*
* Return value: (transfer none): the #GtkSourceBuffer associated with the compositor.
@@ -816,7 +820,7 @@ gtk_source_print_compositor_get_buffer (GtkSourcePrintCompositor *compositor)
* Sets the width of tabulation in characters for printed text.
*
* This function cannot be called anymore after the first call to the
- * gtk_source_print_compositor_paginate() function.
+ * [method@PrintCompositor.paginate] function.
*/
void
gtk_source_print_compositor_set_tab_width (GtkSourcePrintCompositor *compositor,
@@ -863,7 +867,7 @@ gtk_source_print_compositor_get_tab_width (GtkSourcePrintCompositor *compositor)
* Sets the line wrapping mode for the printed text.
*
* This function cannot be called anymore after the first call to the
- * gtk_source_print_compositor_paginate() function.
+ * [method@PrintCompositor.paginate] function.
*/
void
gtk_source_print_compositor_set_wrap_mode (GtkSourcePrintCompositor *compositor,
@@ -910,7 +914,7 @@ gtk_source_print_compositor_get_wrap_mode (GtkSourcePrintCompositor *compositor)
* buffer rules. Both color and font style are applied.
*
* This function cannot be called anymore after the first call to the
- * gtk_source_print_compositor_paginate() function.
+ * [method@PrintCompositor.paginate] function.
**/
void
gtk_source_print_compositor_set_highlight_syntax (GtkSourcePrintCompositor *compositor,
@@ -937,8 +941,9 @@ gtk_source_print_compositor_set_highlight_syntax (GtkSourcePrintCompositor *comp
* @compositor: a #GtkSourcePrintCompositor.
*
* Determines whether the printed text will be highlighted according to the
- * buffer rules. Note that highlighting will happen
- * only if the buffer to print has highlighting activated.
+ * buffer rules.
+ *
+ * Note that highlighting will happen only if the buffer to print has highlighting activated.
*
* Return value: %TRUE if the printed output will be highlighted.
**/
@@ -957,14 +962,15 @@ gtk_source_print_compositor_get_highlight_syntax (GtkSourcePrintCompositor *comp
* @compositor: a #GtkSourcePrintCompositor.
* @interval: interval for printed line numbers.
*
- * Sets the interval for printed line numbers. If @interval is 0 no
- * numbers will be printed. If greater than 0, a number will be
+ * Sets the interval for printed line numbers.
+ *
+ * If @interval is 0 no numbers will be printed. If greater than 0, a number will be
* printed every @interval lines (i.e. 1 will print all line numbers).
*
* Maximum accepted value for @interval is 100.
*
* This function cannot be called anymore after the first call to the
- * gtk_source_print_compositor_paginate() function.
+ * [method@PrintCompositor.paginate] function.
**/
void
gtk_source_print_compositor_set_print_line_numbers (GtkSourcePrintCompositor *compositor,
@@ -990,16 +996,16 @@ gtk_source_print_compositor_set_print_line_numbers (GtkSourcePrintCompositor *co
* @compositor: a #GtkSourcePrintCompositor.
* @print: %TRUE if you want the header to be printed.
*
- * Sets whether you want to print a header in each page. The
- * header consists of three pieces of text and an optional line
- * separator, configurable with
- * gtk_source_print_compositor_set_header_format().
+ * Sets whether you want to print a header in each page.
+ *
+ * The header consists of three pieces of text and an optional line
+ * separator, configurable with [method@PrintCompositor.set_header_format].
*
* Note that by default the header format is unspecified, and if it's
* empty it will not be printed, regardless of this setting.
*
* This function cannot be called anymore after the first call to the
- * gtk_source_print_compositor_paginate() function.
+ * [method@PrintCompositor.paginate] function.
**/
void
gtk_source_print_compositor_set_print_header (GtkSourcePrintCompositor *compositor,
@@ -1025,10 +1031,11 @@ gtk_source_print_compositor_set_print_header (GtkSourcePrintCompositor *composit
* gtk_source_print_compositor_get_print_header:
* @compositor: a #GtkSourcePrintCompositor.
*
- * Determines if a header is set to be printed for each page. A
- * header will be printed if this function returns %TRUE
- * <emphasis>and</emphasis> some format strings have been specified
- * with gtk_source_print_compositor_set_header_format().
+ * Determines if a header is set to be printed for each page.
+ *
+ * A header will be printed if this function returns %TRUE
+ * **and** some format strings have been specified
+ * with [method@PrintCompositor.set_header_format].
*
* Return value: %TRUE if the header is set to be printed.
**/
@@ -1047,16 +1054,17 @@ gtk_source_print_compositor_get_print_header (GtkSourcePrintCompositor *composit
* @compositor: a #GtkSourcePrintCompositor.
* @print: %TRUE if you want the footer to be printed.
*
- * Sets whether you want to print a footer in each page. The
- * footer consists of three pieces of text and an optional line
+ * Sets whether you want to print a footer in each page.
+ *
+ * The footer consists of three pieces of text and an optional line
* separator, configurable with
- * gtk_source_print_compositor_set_footer_format().
+ * [method@PrintCompositor.set_footer_format].
*
* Note that by default the footer format is unspecified, and if it's
* empty it will not be printed, regardless of this setting.
*
* This function cannot be called anymore after the first call to the
- * gtk_source_print_compositor_paginate() function.
+ * [method@PrintCompositor.paginate] function.
**/
void
gtk_source_print_compositor_set_print_footer (GtkSourcePrintCompositor *compositor,
@@ -1082,10 +1090,11 @@ gtk_source_print_compositor_set_print_footer (GtkSourcePrintCompositor *composit
* gtk_source_print_compositor_get_print_footer:
* @compositor: a #GtkSourcePrintCompositor.
*
- * Determines if a footer is set to be printed for each page. A
- * footer will be printed if this function returns %TRUE
- * <emphasis>and</emphasis> some format strings have been specified
- * with gtk_source_print_compositor_set_footer_format().
+ * Determines if a footer is set to be printed for each page.
+ *
+ * A footer will be printed if this function returns %TRUE
+ * **and** some format strings have been specified
+ * with [method@PrintCompositor.set_footer_format].
*
* Return value: %TRUE if the footer is set to be printed.
**/
@@ -1108,11 +1117,13 @@ gtk_source_print_compositor_get_print_footer (GtkSourcePrintCompositor *composit
* @right: (nullable): a format string to print on the right of the header.
*
* Sets strftime like header format strings, to be printed on the
- * left, center and right of the top of each page. The strings may
- * include strftime(3) codes which will be expanded at print time.
- * A subset of strftime() codes are accepted, see g_date_time_format()
+ * left, center and right of the top of each page.
+ *
+ * The strings may include strftime(3) codes which will be expanded at print time.
+ * A subset of strftime() codes are accepted, see [method@GLib.DateTime.format]
* for more details on the accepted format specifiers.
* Additionally the following format specifiers are accepted:
+ *
* - #N: the page number
* - #Q: the page count.
*
@@ -1124,10 +1135,10 @@ gtk_source_print_compositor_get_print_footer (GtkSourcePrintCompositor *composit
*
* For the header to be printed, in
* addition to specifying format strings, you need to enable header
- * printing with gtk_source_print_compositor_set_print_header().
+ * printing with [method@PrintCompositor.set_print_header].
*
* This function cannot be called anymore after the first call to the
- * gtk_source_print_compositor_paginate() function.
+ * [method@PrintCompositor.paginate] function.
**/
void
gtk_source_print_compositor_set_header_format (GtkSourcePrintCompositor *compositor,
@@ -1161,7 +1172,7 @@ gtk_source_print_compositor_set_header_format (GtkSourcePrintCompositor *composi
* @center: (nullable): a format string to print on the center of the footer.
* @right: (nullable): a format string to print on the right of the footer.
*
- * See gtk_source_print_compositor_set_header_format() for more information
+ * See [method@PrintCompositor.set_header_format] for more information
* about the parameters.
**/
void
@@ -1192,8 +1203,9 @@ gtk_source_print_compositor_set_footer_format (GtkSourcePrintCompositor *composi
* gtk_source_print_compositor_get_print_line_numbers:
* @compositor: a #GtkSourcePrintCompositor.
*
- * Returns the interval used for line number printing. If the
- * value is 0, no line numbers will be printed. The default value is
+ * Returns the interval used for line number printing.
+ *
+ * If the value is 0, no line numbers will be printed. The default value is
* 1 (i.e. numbers printed in all lines).
*
* Return value: the interval of printed line numbers.
@@ -1249,11 +1261,11 @@ set_font_description_from_name (GtkSourcePrintCompositor *compositor,
*
* @font_name should be a
* string representation of a font description Pango can understand.
- * (e.g. "Monospace 10"). See pango_font_description_from_string()
+ * (e.g. "Monospace 10"). See [func@Pango.FontDescription.from_string]
* for a description of the format of the string representation.
*
* This function cannot be called anymore after the first call to the
- * gtk_source_print_compositor_paginate() function.
+ * [method@PrintCompositor.paginate] function.
*/
void
gtk_source_print_compositor_set_body_font_name (GtkSourcePrintCompositor *compositor,
@@ -1278,8 +1290,9 @@ gtk_source_print_compositor_set_body_font_name (GtkSourcePrintCompositor *compos
* gtk_source_print_compositor_get_body_font_name:
* @compositor: a #GtkSourcePrintCompositor.
*
- * Returns the name of the font used to print the text body. The returned string
- * must be freed with g_free().
+ * Returns the name of the font used to print the text body.
+ *
+ * The returned string must be freed with g_free().
*
* Return value: a new string containing the name of the font used to print the
* text body.
@@ -1299,17 +1312,18 @@ gtk_source_print_compositor_get_body_font_name (GtkSourcePrintCompositor *compos
* @compositor: a #GtkSourcePrintCompositor.
* @font_name: (nullable): the name of the font for line numbers, or %NULL.
*
- * Sets the font for printing line numbers on the left margin. If
- * %NULL is supplied, the default font (i.e. the one being used for the
+ * Sets the font for printing line numbers on the left margin.
+ *
+ * If %NULL is supplied, the default font (i.e. the one being used for the
* text) will be used instead.
*
* @font_name should be a
* string representation of a font description Pango can understand.
- * (e.g. "Monospace 10"). See pango_font_description_from_string()
+ * (e.g. "Monospace 10"). See [func@Pango.FontDescription.from_string]
* for a description of the format of the string representation.
*
* This function cannot be called anymore after the first call to the
- * gtk_source_print_compositor_paginate() function.
+ * [method@PrintCompositor.paginate] function.
*/
void
gtk_source_print_compositor_set_line_numbers_font_name (GtkSourcePrintCompositor *compositor,
@@ -1335,6 +1349,7 @@ gtk_source_print_compositor_set_line_numbers_font_name (GtkSourcePrintCompositor
* @compositor: a #GtkSourcePrintCompositor.
*
* Returns the name of the font used to print line numbers on the left margin.
+ *
* The returned string must be freed with g_free().
*
* Return value: a new string containing the name of the font used to print
@@ -1361,17 +1376,18 @@ gtk_source_print_compositor_get_line_numbers_font_name (GtkSourcePrintCompositor
* @compositor: a #GtkSourcePrintCompositor.
* @font_name: (nullable): the name of the font for header text, or %NULL.
*
- * Sets the font for printing the page header. If
- * %NULL is supplied, the default font (i.e. the one being used for the
+ * Sets the font for printing the page header.
+ *
+ * If %NULL is supplied, the default font (i.e. the one being used for the
* text) will be used instead.
*
* @font_name should be a
* string representation of a font description Pango can understand.
- * (e.g. "Monospace 10"). See pango_font_description_from_string()
+ * (e.g. "Monospace 10"). See [func@Pango.FontDescription.from_string]
* for a description of the format of the string representation.
*
* This function cannot be called anymore after the first call to the
- * gtk_source_print_compositor_paginate() function.
+ * [method@PrintCompositor.paginate] function.
*/
void
gtk_source_print_compositor_set_header_font_name (GtkSourcePrintCompositor *compositor,
@@ -1398,6 +1414,7 @@ gtk_source_print_compositor_set_header_font_name (GtkSourcePrintCompositor *comp
* @compositor: a #GtkSourcePrintCompositor.
*
* Returns the name of the font used to print the page header.
+ *
* The returned string must be freed with g_free().
*
* Return value: a new string containing the name of the font used to print
@@ -1424,17 +1441,18 @@ gtk_source_print_compositor_get_header_font_name (GtkSourcePrintCompositor *comp
* @compositor: a #GtkSourcePrintCompositor.
* @font_name: (nullable): the name of the font for the footer text, or %NULL.
*
- * Sets the font for printing the page footer. If
- * %NULL is supplied, the default font (i.e. the one being used for the
+ * Sets the font for printing the page footer.
+ *
+ * If %NULL is supplied, the default font (i.e. the one being used for the
* text) will be used instead.
*
* @font_name should be a
* string representation of a font description Pango can understand.
- * (e.g. "Monospace 10"). See pango_font_description_from_string()
+ * (e.g. "Monospace 10"). See [func@Pango.FontDescription.from_string]
* for a description of the format of the string representation.
*
* This function cannot be called anymore after the first call to the
- * gtk_source_print_compositor_paginate() function.
+ * [method@PrintCompositor.paginate] function.
*/
void
gtk_source_print_compositor_set_footer_font_name (GtkSourcePrintCompositor *compositor,
@@ -1461,6 +1479,7 @@ gtk_source_print_compositor_set_footer_font_name (GtkSourcePrintCompositor *comp
* @compositor: a #GtkSourcePrintCompositor.
*
* Returns the name of the font used to print the page footer.
+ *
* The returned string must be freed with g_free().
*
* Return value: a new string containing the name of the font used to print
@@ -2407,15 +2426,15 @@ set_pango_layouts_width (GtkSourcePrintCompositor *compositor)
* Paginate the document associated with the @compositor.
*
* In order to support non-blocking pagination, document is paginated in small chunks.
- * Each time gtk_source_print_compositor_paginate() is invoked, a chunk of the document
- * is paginated. To paginate the entire document, gtk_source_print_compositor_paginate()
+ * Each time [method@PrintCompositor.paginate] is invoked, a chunk of the document
+ * is paginated. To paginate the entire document, [method@PrintCompositor.paginate]
* must be invoked multiple times.
* It returns %TRUE if the document has been completely paginated, otherwise it returns %FALSE.
*
- * This method has been designed to be invoked in the handler of the #GtkPrintOperation::paginate signal,
+ * This method has been designed to be invoked in the handler of the [signal@Gtk.PrintOperation::paginate]
signal,
* as shown in the following example:
*
- * <informalexample><programlisting>
+ * ```c
* // Signal handler for the GtkPrintOperation::paginate signal
*
* static gboolean
@@ -2439,13 +2458,13 @@ set_pango_layouts_width (GtkSourcePrintCompositor *compositor)
*
* return FALSE;
* }
- * </programlisting></informalexample>
+ * ```
*
* If you don't need to do pagination in chunks, you can simply do it all in the
- * #GtkPrintOperation::begin-print handler, and set the number of pages from there, like
+ * [signal@Gtk.PrintOperation::begin-print] handler, and set the number of pages from there, like
* in the following example:
*
- * <informalexample><programlisting>
+ * ```c
* // Signal handler for the GtkPrintOperation::begin-print signal
*
* static void
@@ -2463,7 +2482,7 @@ set_pango_layouts_width (GtkSourcePrintCompositor *compositor)
* n_pages = gtk_source_print_compositor_get_n_pages (compositor);
* gtk_print_operation_set_n_pages (operation, n_pages);
* }
- * </programlisting></informalexample>
+ * ```
*
* Return value: %TRUE if the document has been completely paginated, %FALSE otherwise.
*/
@@ -3002,10 +3021,10 @@ print_footer (GtkSourcePrintCompositor *compositor,
*
* Draw page @page_nr for printing on the the Cairo context encapsuled in @context.
*
- * This method has been designed to be called in the handler of the #GtkPrintOperation::draw_page signal
+ * This method has been designed to be called in the handler of the [signal@Gtk.PrintOperation::draw_page]
signal
* as shown in the following example:
*
- * <informalexample><programlisting>
+ * ```c
* // Signal handler for the GtkPrintOperation::draw_page signal
*
* static void
@@ -3022,7 +3041,7 @@ print_footer (GtkSourcePrintCompositor *compositor,
* context,
* page_nr);
* }
- * </programlisting></informalexample>
+ * ```
*/
void
gtk_source_print_compositor_draw_page (GtkSourcePrintCompositor *compositor,
diff --git a/gtksourceview/gtksourceregion.c b/gtksourceview/gtksourceregion.c
index 91fc6af4..b9a6ba3d 100644
--- a/gtksourceview/gtksourceregion.c
+++ b/gtksourceview/gtksourceregion.c
@@ -27,24 +27,24 @@
*
* Region utility.
*
- * A #GtkSourceRegion permits to store a group of subregions of a
- * #GtkTextBuffer. #GtkSourceRegion stores the subregions with pairs of
- * #GtkTextMark's, so the region is still valid after insertions and deletions
- * in the #GtkTextBuffer.
+ * A `GtkSourceRegion` permits to store a group of subregions of a
+ * [class@Gtk.TextBuffer]. `GtkSourceRegion` stores the subregions with pairs of
+ * [class@Gtk.TextMark]'s, so the region is still valid after insertions and deletions
+ * in the [class@Gtk.TextBuffer].
*
- * The #GtkTextMark for the start of a subregion has a left gravity, while the
- * #GtkTextMark for the end of a subregion has a right gravity.
+ * The [class@Gtk.TextMark] for the start of a subregion has a left gravity, while the
+ * [class@Gtk.TextMark] for the end of a subregion has a right gravity.
*
- * The typical use-case of #GtkSourceRegion is to scan a #GtkTextBuffer chunk by
+ * The typical use-case of `GtkSourceRegion` is to scan a [class@Gtk.TextBuffer] chunk by
* chunk, not the whole buffer at once to not block the user interface. The
- * #GtkSourceRegion represents in that case the remaining region to scan. You
- * can listen to the #GtkTextBuffer::insert-text and
- * #GtkTextBuffer::delete-range signals to update the #GtkSourceRegion
+ * `GtkSourceRegion` represents in that case the remaining region to scan. You
+ * can listen to the [signal@Gtk.TextBuffer::insert-text] and
+ * [signal@Gtk.TextBuffer::delete-range] signals to update the `GtkSourceRegion`
* accordingly.
*
- * To iterate through the subregions, you need to use a #GtkSourceRegionIter,
+ * To iterate through the subregions, you need to use a [struct@RegionIter],
* for example:
- * |[
+ * ```c
* GtkSourceRegion *region;
* GtkSourceRegionIter region_iter;
*
@@ -66,7 +66,7 @@
*
* gtk_source_region_iter_next (®ion_iter);
* }
- * ]|
+ * ```
*/
/* With the gravities of the GtkTextMarks, it is possible for subregions to
@@ -298,8 +298,8 @@ gtk_source_region_class_init (GtkSourceRegionClass *klass)
/**
* GtkSourceRegion:buffer:
*
- * The #GtkTextBuffer. The #GtkSourceRegion has a weak reference to the
- * buffer.2
+ * The [class@Gtk.TextBuffer]. The #GtkSourceRegion has a weak reference to the
+ * buffer.
*/
properties[PROP_BUFFER] =
g_param_spec_object ("buffer",
@@ -518,7 +518,9 @@ gtk_source_region_add_subregion (GtkSourceRegion *region,
* @region: a #GtkSourceRegion.
* @region_to_add: (nullable): the #GtkSourceRegion to add to @region, or %NULL.
*
- * Adds @region_to_add to @region. @region_to_add is not modified.
+ * Adds @region_to_add to @region.
+ *
+ * @region_to_add is not modified.
*/
void
gtk_source_region_add_region (GtkSourceRegion *region,
@@ -745,8 +747,9 @@ gtk_source_region_subtract_subregion (GtkSourceRegion *region,
* @region_to_subtract: (nullable): the #GtkSourceRegion to subtract from
* @region, or %NULL.
*
- * Subtracts @region_to_subtract from @region. @region_to_subtract is not
- * modified.
+ * Subtracts @region_to_subtract from @region.
+ *
+ * @region_to_subtract is not modified.
*/
void
gtk_source_region_subtract_region (GtkSourceRegion *region,
@@ -794,7 +797,9 @@ gtk_source_region_subtract_region (GtkSourceRegion *region,
* gtk_source_region_is_empty:
* @region: (nullable): a #GtkSourceRegion, or %NULL.
*
- * Returns whether the @region is empty. A %NULL @region is considered empty.
+ * Returns whether the @region is empty.
+ *
+ * A %NULL @region is considered empty.
*
* Returns: whether the @region is empty.
*/
@@ -895,7 +900,9 @@ gtk_source_region_get_bounds (GtkSourceRegion *region,
* @_end: the end of the subregion.
*
* Returns the intersection between @region and the subregion delimited by
- * @_start and @_end. @region is not modified.
+ * @_start and @_end.
+ *
+ * @region is not modified.
*
* Returns: (transfer full) (nullable): the intersection as a new
* #GtkSourceRegion.
@@ -1065,8 +1072,9 @@ gtk_source_region_intersect_subregion (GtkSourceRegion *region,
* @region1: (nullable): a #GtkSourceRegion, or %NULL.
* @region2: (nullable): a #GtkSourceRegion, or %NULL.
*
- * Returns the intersection between @region1 and @region2. @region1 and
- * @region2 are not modified.
+ * Returns the intersection between @region1 and @region2.
+ *
+ * @region1 and @region2 are not modified.
*
* Returns: (transfer full) (nullable): the intersection as a #GtkSourceRegion
* object.
@@ -1170,8 +1178,9 @@ invalid:
* @region: a #GtkSourceRegion.
* @iter: (out): iterator to initialize to the first subregion.
*
- * Initializes a #GtkSourceRegionIter to the first subregion of @region. If
- * @region is empty, @iter will be initialized to the end iterator.
+ * Initializes a [struct@RegionIter] to the first subregion of @region.
+ *
+ * If @region is empty, @iter will be initialized to the end iterator.
*/
void
gtk_source_region_get_start_region_iter (GtkSourceRegion *region,
diff --git a/gtksourceview/gtksourceregion.h b/gtksourceview/gtksourceregion.h
index d28e24f7..c230ba4d 100644
--- a/gtksourceview/gtksourceregion.h
+++ b/gtksourceview/gtksourceregion.h
@@ -46,8 +46,9 @@ struct _GtkSourceRegionClass
/**
* GtkSourceRegionIter:
*
- * #GtkSourceRegionIter is an opaque datatype; ignore all its fields.
- * Initialize the iter with gtk_source_region_get_start_region_iter().
+ * An opaque datatype.
+ *
+ * Ignore all its fields and initialize the iter with [method@Region.get_start_region_iter].
*/
typedef struct _GtkSourceRegionIter GtkSourceRegionIter;
struct _GtkSourceRegionIter
diff --git a/gtksourceview/gtksourcescheduler.c b/gtksourceview/gtksourcescheduler.c
index c2ad5eb7..c9713c00 100644
--- a/gtksourceview/gtksourcescheduler.c
+++ b/gtksourceview/gtksourcescheduler.c
@@ -234,7 +234,7 @@ get_scheduler (void)
* @callback: (scope async): the callback to execute
* @user_data: user data for @callback
*
- * Simplified version of gtk_source_scheduler_add_full().
+ * Simplified version of [func@scheduler_add_full].
*
* Since: 5.2
*/
@@ -257,9 +257,9 @@ gtk_source_scheduler_add (GtkSourceSchedulerCallback callback,
* it incrementally.
*
* @callback will be provided a deadline that it should complete it's work by
- * (or near) and can be checked using g_get_monotonic_time() for comparison.
+ * (or near) and can be checked using [func@GLib.get_monotonic_time] for comparison.
*
- * Use gtk_source_scheduler_remove() to remove the handler.
+ * Use [func@scheduler_remove] to remove the handler.
*
* Since: 5.2
*/
@@ -289,7 +289,7 @@ gtk_source_scheduler_add_full (GtkSourceSchedulerCallback callback,
* @handler_id: the handler id
*
* Removes a scheduler callback previously registered with
- * gtk_source_scheduler_add() or gtk_source_scheduler_add_full().
+ * [func@scheduler_add] or [func@scheduler_add_full].
*
* Since: 5.2
*/
diff --git a/gtksourceview/gtksourcescheduler.h b/gtksourceview/gtksourcescheduler.h
index ad026608..2545a482 100644
--- a/gtksourceview/gtksourcescheduler.h
+++ b/gtksourceview/gtksourcescheduler.h
@@ -37,7 +37,7 @@ G_BEGIN_DECLS
* @user_data: closure data provided when registering callback
*
* This function is called incrementally to process additional background work.
- * A deadline is provided which can be checked using g_get_monotonic_time() so
+ * A deadline is provided which can be checked using [func@GLib.get_monotonic_time] so
* that additional work can be processed each frame.
*
* This is useful for situations where you are incrementally performing
diff --git a/gtksourceview/gtksourcesearchcontext.c b/gtksourceview/gtksourcesearchcontext.c
index 9a2448d9..1914747f 100644
--- a/gtksourceview/gtksourcesearchcontext.c
+++ b/gtksourceview/gtksourcesearchcontext.c
@@ -40,40 +40,40 @@
*
* Search context.
*
- * A #GtkSourceSearchContext is used for the search and replace in a
- * #GtkSourceBuffer. The search settings are represented by a
- * #GtkSourceSearchSettings object. There can be a many-to-many relationship
+ * A `GtkSourceSearchContext` is used for the search and replace in a
+ * [class@Buffer]. The search settings are represented by a
+ * [class@SearchSettings] object. There can be a many-to-many relationship
* between buffers and search settings, with the search contexts in-between: a
* search settings object can be shared between several search contexts; and a
* buffer can contain several search contexts at the same time.
*
* The total number of search occurrences can be retrieved with
- * gtk_source_search_context_get_occurrences_count(). To know the position of a
- * certain match, use gtk_source_search_context_get_occurrence_position().
+ * [method@SearchContext.get_occurrences_count]. To know the position of a
+ * certain match, use [method@SearchContext.get_occurrence_position].
*
* The buffer is scanned asynchronously, so it doesn't block the user interface.
* For each search, the buffer is scanned at most once. After that, navigating
* through the occurrences doesn't require to re-scan the buffer entirely.
*
- * To search forward, use gtk_source_search_context_forward() or
- * gtk_source_search_context_forward_async() for the asynchronous version.
+ * To search forward, use [method@SearchContext.forward] or
+ * [method@SearchContext.forward_async] for the asynchronous version.
* The backward search is done similarly. To replace a search match, or all
- * matches, use gtk_source_search_context_replace() and
- * gtk_source_search_context_replace_all().
+ * matches, use [method@SearchContext.replace] and
+ * [method@SearchContext.replace_all].
*
* The search occurrences are highlighted by default. To disable it, use
- * gtk_source_search_context_set_highlight(). You can enable the search
- * highlighting for several #GtkSourceSearchContext<!-- -->s attached to the
- * same buffer. Moreover, each of those #GtkSourceSearchContext<!-- -->s can
+ * [method@SearchContext.set_highlight]. You can enable the search
+ * highlighting for several `GtkSourceSearchContext`s attached to the
+ * same buffer. Moreover, each of those `GtkSourceSearchContext`s can
* have a different text style associated. Use
- * gtk_source_search_context_set_match_style() to specify the #GtkSourceStyle
+ * [method@SearchContext.set_match_style] to specify the [class@Style]
* to apply on search matches.
*
- * Note that the #GtkSourceSearchContext:highlight and
- * #GtkSourceSearchContext:match-style properties are in the
- * #GtkSourceSearchContext class, not #GtkSourceSearchSettings. Appearance
+ * Note that the [property@SearchContext:highlight] and
+ * [property@SearchContext:match-style] properties are in the
+ * `GtkSourceSearchContext` class, not [class@SearchSettings]. Appearance
* settings should be tied to one, and only one buffer, as different buffers can
- * have different style scheme associated (a #GtkSourceSearchSettings object
+ * have different style scheme associated (a [class@SearchSettings] object
* can be bound indirectly to several buffers).
*
* The concept of "current match" doesn't exist yet. A way to highlight
@@ -2781,7 +2781,7 @@ gtk_source_search_context_class_init (GtkSourceSearchContextClass *klass)
/**
* GtkSourceSearchContext:buffer:
*
- * The #GtkSourceBuffer associated to the search context.
+ * The [class@Buffer] associated to the search context.
*/
properties [PROP_BUFFER] =
g_param_spec_object ("buffer",
@@ -2795,7 +2795,7 @@ gtk_source_search_context_class_init (GtkSourceSearchContextClass *klass)
/**
* GtkSourceSearchContext:settings:
*
- * The #GtkSourceSearchSettings associated to the search context.
+ * The [class@SearchSettings] associated to the search context.
*
* This property is construct-only since version 4.0.
*/
@@ -2825,7 +2825,7 @@ gtk_source_search_context_class_init (GtkSourceSearchContextClass *klass)
/**
* GtkSourceSearchContext:match-style:
*
- * A #GtkSourceStyle, or %NULL for theme's scheme default style.
+ * A [class@Style], or %NULL for theme's scheme default style.
*/
properties [PROP_MATCH_STYLE] =
g_param_spec_object ("match-style",
@@ -2860,7 +2860,7 @@ gtk_source_search_context_class_init (GtkSourceSearchContextClass *klass)
* #GError property will be set. If the pattern is valid, the value is
* %NULL.
*
- * Free with g_error_free().
+ * Free with [method GLib Error free].
*/
properties [PROP_REGEX_ERROR] =
g_param_spec_boxed ("regex-error",
@@ -2885,9 +2885,10 @@ gtk_source_search_context_init (GtkSourceSearchContext *search)
* @settings: (nullable): a #GtkSourceSearchSettings, or %NULL.
*
* Creates a new search context, associated with @buffer, and customized with
- * @settings. If @settings is %NULL, a new #GtkSourceSearchSettings object will
- * be created, that you can retrieve with
- * gtk_source_search_context_get_settings().
+ * @settings.
+ *
+ * If @settings is %NULL, a new [class@SearchSettings] object will
+ * be created, that you can retrieve with [method@SearchContext.get_settings].
*
* Returns: a new search context.
*/
@@ -2989,10 +2990,10 @@ gtk_source_search_context_get_match_style (GtkSourceSearchContext *search)
* @search: a #GtkSourceSearchContext.
* @match_style: (nullable): a #GtkSourceStyle, or %NULL.
*
- * Set the style to apply on search matches. If @match_style is %NULL, default
- * theme's scheme 'match-style' will be used.
- * To enable or disable the search highlighting, use
- * gtk_source_search_context_set_highlight().
+ * Set the style to apply on search matches.
+ *
+ * If @match_style is %NULL, default theme's scheme 'match-style' will be used.
+ * To enable or disable the search highlighting, use [method@SearchContext.set_highlight].
*/
void
gtk_source_search_context_set_match_style (GtkSourceSearchContext *search,
@@ -3026,10 +3027,12 @@ gtk_source_search_context_set_match_style (GtkSourceSearchContext *search,
* @search: a #GtkSourceSearchContext.
*
* Regular expression patterns must follow certain rules. If
- * #GtkSourceSearchSettings:search-text breaks a rule, the error can be
- * retrieved with this function. The error domain is #G_REGEX_ERROR.
+ * [property@SearchSettings:search-text] breaks a rule, the error can be
+ * retrieved with this function.
+ *
+ * The error domain is [error@GLib.RegexError].
*
- * Free the return value with g_error_free().
+ * Free the return value with [method GLib Error free].
*
* Returns: (transfer full) (nullable): the #GError, or %NULL if the
* pattern is valid.
@@ -3051,9 +3054,10 @@ gtk_source_search_context_get_regex_error (GtkSourceSearchContext *search)
* gtk_source_search_context_get_occurrences_count:
* @search: a #GtkSourceSearchContext.
*
- * Gets the total number of search occurrences. If the buffer is not already
- * fully scanned, the total number of occurrences is unknown, and -1 is
- * returned.
+ * Gets the total number of search occurrences.
+ *
+ * If the buffer is not already fully scanned, the total number of occurrences is
+ * unknown, and -1 is returned.
*
* Returns: the total number of search occurrences, or -1 if unknown.
*/
@@ -3076,10 +3080,11 @@ gtk_source_search_context_get_occurrences_count (GtkSourceSearchContext *search)
* @match_start: the start of the occurrence.
* @match_end: the end of the occurrence.
*
- * Gets the position of a search occurrence. If the buffer is not already fully
- * scanned, the position may be unknown, and -1 is returned. If 0 is returned,
- * it means that this part of the buffer has already been scanned, and that
- * @match_start and @match_end don't delimit an occurrence.
+ * Gets the position of a search occurrence.
+ *
+ * If the buffer is not already fully scanned, the position may be unknown,
+ * and -1 is returned. If 0 is returned, it means that this part of the buffer
+ * has already been scanned, and that @match_start and @match_end don't delimit an occurrence.
*
* Returns: the position of the search occurrence. The first occurrence has the
* position 1 (not 0). Returns 0 if @match_start and @match_end don't delimit
@@ -3182,16 +3187,17 @@ gtk_source_search_context_get_occurrence_position (GtkSourceSearchContext *searc
* @has_wrapped_around: (out) (optional): return location to know whether the
* search has wrapped around, or %NULL.
*
- * Synchronous forward search. It is recommended to use the asynchronous
- * functions instead, to not block the user interface. However, if you are sure
- * that the @buffer is small, this function is more convenient to use.
+ * Synchronous forward search.
+ *
+ * It is recommended to use the asynchronous functions instead, to not block the user interface.
+ * However, if you are sure that the @buffer is small, this function is more convenient to use.
*
- * If the #GtkSourceSearchSettings:wrap-around property is %FALSE, this function
+ * If the [property@SearchSettings:wrap-around] property is %FALSE, this function
* doesn't try to wrap around.
*
* The @has_wrapped_around out parameter is set independently of whether a match
* is found. So if this function returns %FALSE, @has_wrapped_around will have
- * the same value as the #GtkSourceSearchSettings:wrap-around property.
+ * the same value as the [property@SearchSettings:wrap-around] property.
*
* Returns: whether a match was found.
*/
@@ -3255,15 +3261,12 @@ gtk_source_search_context_forward (GtkSourceSearchContext *search,
* @callback: a #GAsyncReadyCallback to call when the operation is finished.
* @user_data: the data to pass to the @callback function.
*
- * The asynchronous version of gtk_source_search_context_forward().
+ * The asynchronous version of [method@SearchContext.forward].
*
- * See the documentation of gtk_source_search_context_forward() for more
- * details.
- *
- * See the #GAsyncResult documentation to know how to use this function.
+ * See the [iface@Gio.AsyncResult] documentation to know how to use this function.
*
* If the operation is cancelled, the @callback will only be called if
- * @cancellable was not %NULL. gtk_source_search_context_forward_async() takes
+ * @cancellable was not %NULL. The method takes
* ownership of @cancellable, so you can unref it after calling this function.
*/
void
@@ -3297,10 +3300,9 @@ gtk_source_search_context_forward_async (GtkSourceSearchContext *search,
* search has wrapped around, or %NULL.
* @error: a #GError, or %NULL.
*
- * Finishes a forward search started with
- * gtk_source_search_context_forward_async().
+ * Finishes a forward search started with [method@SearchContext.forward_async].
*
- * See the documentation of gtk_source_search_context_forward() for more
+ * See the documentation of [method@SearchContext.forward] for more
* details.
*
* Returns: whether a match was found.
@@ -3374,16 +3376,17 @@ gtk_source_search_context_forward_finish (GtkSourceSearchContext *search,
* @has_wrapped_around: (out) (optional): return location to know whether the
* search has wrapped around, or %NULL.
*
- * Synchronous backward search. It is recommended to use the asynchronous
- * functions instead, to not block the user interface. However, if you are sure
- * that the @buffer is small, this function is more convenient to use.
+ * Synchronous backward search.
+ *
+ * It is recommended to use the asynchronous functions instead, to not block the user interface.
+ * However, if you are sure that the @buffer is small, this function is more convenient to use.
*
- * If the #GtkSourceSearchSettings:wrap-around property is %FALSE, this function
+ * If the [property@SearchSettings:wrap-around] property is %FALSE, this function
* doesn't try to wrap around.
*
* The @has_wrapped_around out parameter is set independently of whether a match
* is found. So if this function returns %FALSE, @has_wrapped_around will have
- * the same value as the #GtkSourceSearchSettings:wrap-around property.
+ * the same value as the [property@SearchSettings:wrap-around] property.
*
* Returns: whether a match was found.
*/
@@ -3448,15 +3451,12 @@ gtk_source_search_context_backward (GtkSourceSearchContext *search,
* @callback: a #GAsyncReadyCallback to call when the operation is finished.
* @user_data: the data to pass to the @callback function.
*
- * The asynchronous version of gtk_source_search_context_backward().
+ * The asynchronous version of [method@SearchContext.backward].
*
- * See the documentation of gtk_source_search_context_backward() for more
- * details.
- *
- * See the #GAsyncResult documentation to know how to use this function.
+ * See the [iface@Gio.AsyncResult] documentation to know how to use this function.
*
* If the operation is cancelled, the @callback will only be called if
- * @cancellable was not %NULL. gtk_source_search_context_backward_async() takes
+ * @cancellable was not %NULL. The method takes
* ownership of @cancellable, so you can unref it after calling this function.
*/
void
@@ -3491,9 +3491,9 @@ gtk_source_search_context_backward_async (GtkSourceSearchContext *search,
* @error: a #GError, or %NULL.
*
* Finishes a backward search started with
- * gtk_source_search_context_backward_async().
+ * [method@SearchContext.backward_async].
*
- * See the documentation of gtk_source_search_context_backward() for more
+ * See the documentation of [method@SearchContext.backward] for more
* details.
*
* Returns: whether a match was found.
@@ -3627,7 +3627,7 @@ end:
* text boundaries.
*
* For a regular expression replacement, you can check if @replace is valid by
- * calling g_regex_check_replacement(). The @replace text can contain
+ * calling [func@GLib.Regex.check_replacement]. The @replace text can contain
* backreferences.
*
* Returns: whether the match has been replaced.
@@ -3701,11 +3701,12 @@ gtk_source_search_context_replace (GtkSourceSearchContext *search,
* @replace_length: the length of @replace in bytes, or -1.
* @error: location to a #GError, or %NULL to ignore errors.
*
- * Replaces all search matches by another text. It is a synchronous function, so
- * it can block the user interface.
+ * Replaces all search matches by another text.
+ *
+ * It is a synchronous function, so it can block the user interface.
*
* For a regular expression replacement, you can check if @replace is valid by
- * calling g_regex_check_replacement(). The @replace text can contain
+ * calling [func@GLib.Regex.check_replacement]. The @replace text can contain
* backreferences.
*
* Returns: the number of replaced matches.
diff --git a/gtksourceview/gtksourcesearchsettings.c b/gtksourceview/gtksourcesearchsettings.c
index 8a5beb12..dc7b8a77 100644
--- a/gtksourceview/gtksourcesearchsettings.c
+++ b/gtksourceview/gtksourcesearchsettings.c
@@ -26,9 +26,9 @@
*
* Search settings.
*
- * A #GtkSourceSearchSettings object represents the settings of a search. The
+ * A `GtkSourceSearchSettings` object represents the settings of a search. The
* search settings can be associated with one or several
- * #GtkSourceSearchContext<!-- -->s.
+ * [class@SearchContext]s.
*/
enum
@@ -152,8 +152,9 @@ gtk_source_search_settings_class_init (GtkSourceSearchSettingsClass *klass)
/**
* GtkSourceSearchSettings:search-text:
*
- * A search string, or %NULL if the search is disabled. If the regular
- * expression search is enabled, #GtkSourceSearchSettings:search-text is
+ * A search string, or %NULL if the search is disabled.
+ *
+ * If the regular expression search is enabled, [property@SearchSettings:search-text] is
* the pattern.
*/
properties[PROP_SEARCH_TEXT] =
@@ -206,7 +207,7 @@ gtk_source_search_settings_class_init (GtkSourceSearchSettingsClass *klass)
* GtkSourceSearchSettings:regex-enabled:
*
* Search by regular expressions with
- * #GtkSourceSearchSettings:search-text as the pattern.
+ * [property@SearchSettings:search-text] as the pattern.
*/
properties[PROP_REGEX_ENABLED] =
g_param_spec_boolean ("regex-enabled",
@@ -241,11 +242,12 @@ gtk_source_search_settings_new (void)
* @settings: a #GtkSourceSearchSettings.
* @search_text: (nullable): the nul-terminated text to search, or %NULL to disable the search.
*
- * Sets the text to search. If @search_text is %NULL or is empty, the search
- * will be disabled. A copy of @search_text will be made, so you can safely free
- * @search_text after a call to this function.
+ * Sets the text to search.
+ *
+ * If @search_text is %NULL or is empty, the search will be disabled. A copy of @search_text
+ * will be made, so you can safely free @search_text after a call to this function.
*
- * You may be interested to call gtk_source_utils_unescape_search_text() before
+ * You may be interested to call [func@utils_unescape_search_text] before
* this function.
*/
void
@@ -282,9 +284,11 @@ gtk_source_search_settings_set_search_text (GtkSourceSearchSettings *settings,
* gtk_source_search_settings_get_search_text:
* @settings: a #GtkSourceSearchSettings.
*
- * Gets the text to search. The return value must not be freed.
+ * Gets the text to search.
+ *
+ * The return value must not be freed.
*
- * You may be interested to call gtk_source_utils_escape_search_text() after
+ * You may be interested to call [func@utils_escape_search_text] after
* this function.
*
* Returns: (nullable): the text to search, or %NULL if the search is disabled.
@@ -344,10 +348,11 @@ gtk_source_search_settings_get_case_sensitive (GtkSourceSearchSettings *settings
* @settings: a #GtkSourceSearchSettings.
* @at_word_boundaries: the setting.
*
- * Change whether the search is done at word boundaries. If @at_word_boundaries
- * is %TRUE, a search match must start and end a word. The match can span
- * multiple words. See also gtk_text_iter_starts_word() and
- * gtk_text_iter_ends_word().
+ * Change whether the search is done at word boundaries.
+ *
+ * If @at_word_boundaries is %TRUE, a search match must start and end a word.
+ * The match can span multiple words. See also [method@Gtk.TextIter.starts_word] and
+ * [method@Gtk.TextIter.ends_word].
*/
void
gtk_source_search_settings_set_at_word_boundaries (GtkSourceSearchSettings *settings,
@@ -387,9 +392,10 @@ gtk_source_search_settings_get_at_word_boundaries (GtkSourceSearchSettings *sett
* @settings: a #GtkSourceSearchSettings.
* @wrap_around: the setting.
*
- * Enables or disables the wrap around search. If @wrap_around is %TRUE, the
- * forward search continues at the beginning of the buffer if no search
- * occurrences are found. Similarly, the backward search continues to search at
+ * Enables or disables the wrap around search.
+ *
+ * If @wrap_around is %TRUE, the forward search continues at the beginning of the buffer
+ * if no search occurrences are found. Similarly, the backward search continues to search at
* the end of the buffer.
*/
void
@@ -431,10 +437,11 @@ gtk_source_search_settings_get_wrap_around (GtkSourceSearchSettings *settings)
* @regex_enabled: the setting.
*
* Enables or disables whether to search by regular expressions.
- * If enabled, the #GtkSourceSearchSettings:search-text property contains the
+ *
+ * If enabled, the [property@SearchSettings:search-text] property contains the
* pattern of the regular expression.
*
- * #GtkSourceSearchContext uses #GRegex when regex search is enabled. See the
+ * [class@SearchContext] uses #GRegex when regex search is enabled. See the
* [Regular expression syntax](https://developer.gnome.org/glib/stable/glib-regex-syntax.html)
* page in the GLib reference manual.
*/
diff --git a/gtksourceview/gtksourcesignalgroup.c b/gtksourceview/gtksourcesignalgroup.c
index 5c99d713..41578d4f 100644
--- a/gtksourceview/gtksourcesignalgroup.c
+++ b/gtksourceview/gtksourcesignalgroup.c
@@ -310,7 +310,7 @@ gtk_source_signal_group_check_target_type (GtkSourceSignalGroup *self,
*
* This blocked state will be kept across changes of the target instance.
*
- * See: g_signal_handler_block().
+ * See: [func@GObject.signal_handler_block].
*/
void
gtk_source_signal_group_block (GtkSourceSignalGroup *self)
@@ -351,7 +351,7 @@ gtk_source_signal_group_block (GtkSourceSignalGroup *self)
* again. Must be unblocked exactly the same number of times it
* has been blocked to become active again.
*
- * See: g_signal_handler_unblock().
+ * See: [func@GObject.signal_handler_unblock].
*/
void
gtk_source_signal_group_unblock (GtkSourceSignalGroup *self)
@@ -736,7 +736,7 @@ gtk_source_signal_group_connect_full (GtkSourceSignalGroup *self,
* by temporarily adding a reference count. When the @object is destroyed
* the signal handler will automatically be removed.
*
- * See: g_signal_connect_object().
+ * See: [func@GObject.signal_connect_object].
*/
void
gtk_source_signal_group_connect_object (GtkSourceSignalGroup *self,
@@ -763,7 +763,7 @@ gtk_source_signal_group_connect_object (GtkSourceSignalGroup *self,
* Connects @callback to the signal @detailed_signal
* on the target instance of @self.
*
- * See: g_signal_connect_data().
+ * See: [func@GObject.signal_connect_data].
*/
void
gtk_source_signal_group_connect_data (GtkSourceSignalGroup *self,
@@ -787,7 +787,7 @@ gtk_source_signal_group_connect_data (GtkSourceSignalGroup *self,
* Connects @callback to the signal @detailed_signal
* on the target instance of @self.
*
- * See: g_signal_connect().
+ * See: [func@GObject.signal_connect].
*/
void
gtk_source_signal_group_connect (GtkSourceSignalGroup *self,
@@ -811,7 +811,7 @@ gtk_source_signal_group_connect (GtkSourceSignalGroup *self,
*
* The @callback will be called after the default handler of the signal.
*
- * See: g_signal_connect_after().
+ * See: [func@GObject.signal_connect_after].
*/
void
gtk_source_signal_group_connect_after (GtkSourceSignalGroup *self,
@@ -836,7 +836,7 @@ gtk_source_signal_group_connect_after (GtkSourceSignalGroup *self,
* The instance on which the signal is emitted and @data
* will be swapped when calling @callback.
*
- * See: g_signal_connect_swapped().
+ * See: [func@GObject.signal_connect_swapped].
*/
void
gtk_source_signal_group_connect_swapped (GtkSourceSignalGroup *self,
diff --git a/gtksourceview/gtksourcesnippet.c b/gtksourceview/gtksourcesnippet.c
index fed47a62..02a53ca4 100644
--- a/gtksourceview/gtksourcesnippet.c
+++ b/gtksourceview/gtksourcesnippet.c
@@ -32,13 +32,13 @@
*
* Quick insertion code snippets.
*
- * The #GtkSourceSnippet represents a series of chunks that can quickly be
- * inserted into the #GtkSourceView.
+ * The `GtkSourceSnippet` represents a series of chunks that can quickly be
+ * inserted into the [class@View].
*
* Snippets are defined in XML files which are loaded by the
- * #GtkSourceSnippetManager. Alternatively, applications can create snippets
- * on demand and insert them into the #GtkSourceView using
- * gtk_source_view_push_snippet().
+ * [class@SnippetManager]. Alternatively, applications can create snippets
+ * on demand and insert them into the [class@View] using
+ * [method@View.push_snippet].
*
* Snippet chunks can reference other snippet chunks as well as post-process
* the values from other chunks such as capitalization.
@@ -165,8 +165,9 @@ gtk_source_snippet_copy (GtkSourceSnippet *snippet)
* gtk_source_snippet_get_focus_position:
* @snippet: a #GtkSourceSnippet
*
- * Gets the current focus for the snippet. This is changed
- * as the user tabs through focus locations.
+ * Gets the current focus for the snippet.
+ *
+ * This is changed as the user tabs through focus locations.
*
* Returns: The focus position, or -1 if unset.
*/
@@ -221,8 +222,9 @@ gtk_source_snippet_get_nth_chunk (GtkSourceSnippet *snippet,
* gtk_source_snippet_get_trigger:
* @snippet: a #GtkSourceSnippet
*
- * Gets the trigger for the source snippet. A trigger is
- * a word that can be expanded into the full snippet when
+ * Gets the trigger for the source snippet.
+ *
+ * A trigger is a word that can be expanded into the full snippet when
* the user presses Tab.
*
* Returns: (nullable): A string or %NULL
@@ -264,7 +266,7 @@ gtk_source_snippet_set_trigger (GtkSourceSnippet *snippet,
* Gets the language-id used for the source snippet.
*
* The language identifier should be one that matches a
- * source language #GtkSourceLanguage:id property.
+ * source language [property@Language:id] property.
*
* Returns: the language identifier
*/
@@ -283,7 +285,7 @@ gtk_source_snippet_get_language_id (GtkSourceSnippet *snippet)
*
* Sets the language identifier for the snippet.
*
- * This should match the #GtkSourceLanguage:id identifier.
+ * This should match the [property@Language:id] identifier.
*/
void
gtk_source_snippet_set_language_id (GtkSourceSnippet *snippet,
diff --git a/gtksourceview/gtksourcesnippetchunk.c b/gtksourceview/gtksourcesnippetchunk.c
index 911215ea..e3d239f2 100644
--- a/gtksourceview/gtksourcesnippetchunk.c
+++ b/gtksourceview/gtksourcesnippetchunk.c
@@ -27,10 +27,10 @@
*
* A chunk of text within the source snippet.
*
- * The #GtkSourceSnippetChunk represents a single chunk of text that
+ * The `GtkSourceSnippetChunk` represents a single chunk of text that
* may or may not be an edit point within the snippet. Chunks that are
* an edit point (also called a tab stop) have the
- * #GtkSourceSnippetChunk:focus-position property set.
+ * [property@SnippetChunk:focus-position] property set.
*/
G_DEFINE_TYPE (GtkSourceSnippetChunk, gtk_source_snippet_chunk, G_TYPE_INITIALLY_UNOWNED)
@@ -51,8 +51,8 @@ static GParamSpec *properties[N_PROPS];
/**
* gtk_source_snippet_chunk_new:
*
- * Create a new #GtkSourceSnippetChunk that can be added to
- * a #GtkSourceSnippet.
+ * Create a new `GtkSourceSnippetChunk` that can be added to
+ * a [class@Snippet].
*/
GtkSourceSnippetChunk *
gtk_source_snippet_chunk_new (void)
@@ -149,7 +149,7 @@ gtk_source_snippet_chunk_set_context (GtkSourceSnippetChunk *chunk,
*
* The specification is evaluated for variables when other chunks are edited
* within the snippet context. If the user has changed the text, the
- * #GtkSourceSnippetChunk:text and #GtkSourceSnippetChunk:text-set properties
+ * [property@SnippetChunk:text] and [property@SnippetChunk:text-set] properties
* are updated.
*
* Returns: (transfer none) (nullable): the specification, if any
@@ -171,7 +171,7 @@ gtk_source_snippet_chunk_get_spec (GtkSourceSnippetChunk *chunk)
*
* The specification is evaluated for variables when other chunks are edited
* within the snippet context. If the user has changed the text, the
- * #GtkSourceSnippetChunk:text and #GtkSourceSnippetChunk:text-set properties
+ * [property@SnippetChunk:text and] [property@SnippetChunk:text-set] properties
* are updated.
*/
void
@@ -193,7 +193,7 @@ gtk_source_snippet_chunk_set_spec (GtkSourceSnippetChunk *chunk,
* gtk_source_snippet_chunk_get_focus_position:
* @chunk: a #GtkSourceSnippetChunk
*
- * Gets the #GtkSourceSnippetChunk:focus-position.
+ * Gets the [property@SnippetChunk:focus-position].
*
* The focus-position is used to determine how many tabs it takes for the
* snippet to advanced to this chunk.
@@ -218,7 +218,7 @@ gtk_source_snippet_chunk_get_focus_position (GtkSourceSnippetChunk *chunk)
* @chunk: a #GtkSourceSnippetChunk
* @focus_position: the focus-position
*
- * Sets the #GtkSourceSnippetChunk:focus-position property.
+ * Sets the [property@SnippetChunk:focus-position] property.
*
* The focus-position is used to determine how many tabs it takes for the
* snippet to advanced to this chunk.
@@ -248,10 +248,10 @@ gtk_source_snippet_chunk_set_focus_position (GtkSourceSnippetChunk *chunk,
* gtk_source_snippet_chunk_get_text:
* @chunk: a #GtkSourceSnippetChunk
*
- * Gets the #GtkSourceSnippetChunk:text property.
+ * Gets the [property@SnippetChunk:text] property.
*
* The text property is updated when the user edits the text of the chunk.
- * If it has not been edited, the #GtkSourceSnippetChunk:spec property is
+ * If it has not been edited, the [property@SnippetChunk:spec] property is
* returned.
*
* Returns: (not nullable): the text of the chunk
@@ -294,7 +294,7 @@ gtk_source_snippet_chunk_set_text (GtkSourceSnippetChunk *chunk,
* gtk_source_snippet_chunk_get_text_set:
* @chunk: a #GtkSourceSnippetChunk
*
- * Gets the #GtkSourceSnippetChunk:text-set property.
+ * Gets the [property@SnippetChunk:text-set] property.
*
* This is typically set when the user has edited a snippet chunk.
*/
@@ -311,7 +311,7 @@ gtk_source_snippet_chunk_get_text_set (GtkSourceSnippetChunk *chunk)
* @chunk: a #GtkSourceSnippetChunk
* @text_set: the property value
*
- * Sets the #GtkSourceSnippetChunk:text-set property.
+ * Sets the [property@SnippetChunk:text-set] property.
*
* This is typically set when the user has edited a snippet chunk by the
* snippet engine.
diff --git a/gtksourceview/gtksourcesnippetcontext.c b/gtksourceview/gtksourcesnippetcontext.c
index 5c581a0b..7c5c71f8 100644
--- a/gtksourceview/gtksourcesnippetcontext.c
+++ b/gtksourceview/gtksourcesnippetcontext.c
@@ -28,14 +28,14 @@
/**
* GtkSourceSnippetContext:
*
- * Context for expanding #GtkSourceSnippetChunk.
+ * Context for expanding [class@SnippetChunk].
*
* This class is currently used primary as a hashtable. However, the longer
- * term goal is to have it hold onto a GjsContext as well as other languages
- * so that #GtkSourceSnippetChunk can expand themselves by executing
+ * term goal is to have it hold onto a `GjsContext` as well as other languages
+ * so that [class@SnippetChunk] can expand themselves by executing
* script within the context.
*
- * The #GtkSourceSnippet will build the context and then expand each of the
+ * The [class@Snippet] will build the context and then expand each of the
* chunks during the insertion/edit phase.
*/
@@ -125,8 +125,9 @@ gtk_source_snippet_context_set_variable (GtkSourceSnippetContext *self,
* @key: the constant name
* @value: the value of the constant
*
- * Sets a constatnt within the context. This is similar to
- * a variable set with gtk_source_snippet_context_set_variable()
+ * Sets a constatnt within the context.
+ *
+ * This is similar to a variable set with [method@SnippetContext.set_variable]
* but is expected to not change during use of the snippet.
*
* Examples would be the date or users name.
@@ -828,7 +829,7 @@ gtk_source_snippet_context_class_init (GtkSourceSnippetContextClass *klass)
/**
* GtkSourceSnippetContext::changed:
*
- * The "changed" signal is emitted when a change has been
+ * The signal is emitted when a change has been
* discovered in one of the chunks of the snippet which has
* caused a variable or other dynamic data within the context
* to have changed.
diff --git a/gtksourceview/gtksourcesnippetmanager.c b/gtksourceview/gtksourcesnippetmanager.c
index c5d81983..47fff4b3 100644
--- a/gtksourceview/gtksourcesnippetmanager.c
+++ b/gtksourceview/gtksourcesnippetmanager.c
@@ -27,15 +27,15 @@
/**
* GtkSourceSnippetManager:
*
- * Provides access to #GtkSourceSnippet.
+ * Provides access to [class@Snippet].
*
- * #GtkSourceSnippetManager is an object which processes snippet description
- * files and creates #GtkSourceSnippet objects.
+ * `GtkSourceSnippetManager` is an object which processes snippet description
+ * files and creates [class@Snippet] objects.
*
- * Use gtk_source_snippet_manager_get_default() to retrieve the default
- * instance of #GtkSourceSnippetManager.
+ * Use [func@SnippetManager.get_default] to retrieve the default
+ * instance of `GtkSourceSnippetManager`.
*
- * Use gtk_source_snippet_manager_get_snippets() to retrieve snippets for
+ * Use [method@SnippetManager.get_snippet] to retrieve snippets for
* a given snippets.
*/
@@ -158,8 +158,7 @@ gtk_source_snippet_manager_class_init (GtkSourceSnippetManagerClass *klass)
/**
* GtkSourceSnippetManager:search-path:
*
- * The "search-path" property contains a list of directories to search
- * for files containing snippets (*.snippets).
+ * Contains a list of directories to search for files containing snippets (*.snippets).
*/
properties[PROP_SEARCH_PATH] =
g_param_spec_boxed ("search-path",
@@ -231,17 +230,15 @@ _gtk_source_snippet_manager_intern (GtkSourceSnippetManager *self,
* @dirs: (nullable) (array zero-terminated=1): a %NULL-terminated array of
* strings or %NULL.
*
- * Sets the list of directories in which the #GtkSourceSnippetManagerlooks for
- * snippet files. If @dirs is %NULL, the search path is reset to default.
+ * Sets the list of directories in which the `GtkSourceSnippetManager` looks for
+ * snippet files.
*
- * <note>
- * <para>
- * At the moment this function can be called only before the
- * snippet files are loaded for the first time. In practice
- * to set a custom search path for a #GtkSourceSnippetManager,
- * you have to call this function right after creating it.
- * </para>
- * </note>
+ * If @dirs is %NULL, the search path is reset to default.
+ *
+ * At the moment this function can be called only before the
+ * snippet files are loaded for the first time. In practice
+ * to set a custom search path for a `GtkSourceSnippetManager`,
+ * you have to call this function right after creating it.
*/
void
gtk_source_snippet_manager_set_search_path (GtkSourceSnippetManager *self,
@@ -353,12 +350,13 @@ gtk_source_snippet_manager_list_groups (GtkSourceSnippetManager *self)
* @trigger_prefix: (nullable): a prefix for a trigger to activate
*
* Queries the known snippets for those matching @group, @language_id, and/or
- * @trigger_prefix. If any of these are %NULL, they will be ignored when
- * filtering the available snippets.
+ * @trigger_prefix.
+ *
+ * If any of these are %NULL, they will be ignored when filtering the available snippets.
*
- * The #GListModel only contains information about the available snippets until
- * g_list_model_get_item() is called for a specific snippet. This helps reduce
- * the number of #GObject's that are created at runtime to those needed by
+ * The [iface@Gio.ListModel] only contains information about the available snippets until
+ * [method@Gio.ListModel.get_item] is called for a specific snippet. This helps reduce
+ * the number of [class@GObject.Object]'s that are created at runtime to those needed by
* the calling application.
*
* Returns: (transfer full): a #GListModel of #GtkSourceSnippet.
@@ -384,7 +382,9 @@ gtk_source_snippet_manager_list_matching (GtkSourceSnippetManager *self,
* @trigger: the trigger for the snippet
*
* Queries the known snippets for the first matching @group, @language_id,
- * and/or @trigger. If @group or @language_id are %NULL, they will be ignored.
+ * and/or @trigger.
+ *
+ * If @group or @language_id are %NULL, they will be ignored.
*
* Returns: (transfer full) (nullable): a #GtkSourceSnippet or %NULL if no
* matching snippet was found.
diff --git a/gtksourceview/gtksourcespacedrawer.c b/gtksourceview/gtksourcespacedrawer.c
index f4eb83b5..5b598c3a 100644
--- a/gtksourceview/gtksourcespacedrawer.c
+++ b/gtksourceview/gtksourcespacedrawer.c
@@ -43,25 +43,25 @@
* #GtkSourceSpaceDrawer provides a way to visualize white spaces, by drawing
* symbols.
*
- * Call gtk_source_view_get_space_drawer() to get the #GtkSourceSpaceDrawer
- * instance of a certain #GtkSourceView.
+ * Call [method@View.get_space_drawer] to get the `GtkSourceSpaceDrawer`
+ * instance of a certain [class@View].
*
* By default, no white spaces are drawn because the
- * #GtkSourceSpaceDrawer:enable-matrix is %FALSE.
+ * [property@SpaceDrawer:enable-matrix] is %FALSE.
*
- * To draw white spaces, gtk_source_space_drawer_set_types_for_locations() can
- * be called to set the #GtkSourceSpaceDrawer:matrix property (by default all
+ * To draw white spaces, [method@SpaceDrawer.set_types_for_locations] can
+ * be called to set the [property@SpaceDrawer:matrix] property (by default all
* space types are enabled at all locations). Then call
- * gtk_source_space_drawer_set_enable_matrix().
+ * [method@SpaceDrawer.set_enable_matrix].
*
- * For a finer-grained method, there is also the GtkSourceTag's
- * #GtkSourceTag:draw-spaces property.
+ * For a finer-grained method, there is also the [class@Tag]'s
+ * [property@Tag:draw-spaces] property.
*
* # Example
*
* To draw non-breaking spaces everywhere and draw all types of trailing spaces
* except newlines:
- * |[
+ * ```c
* gtk_source_space_drawer_set_types_for_locations (space_drawer,
* GTK_SOURCE_SPACE_LOCATION_ALL,
* GTK_SOURCE_SPACE_TYPE_NBSP);
@@ -72,11 +72,12 @@
* ~GTK_SOURCE_SPACE_TYPE_NEWLINE);
*
* gtk_source_space_drawer_set_enable_matrix (space_drawer, TRUE);
- * ]|
+ * ```
*
* # Use-case: draw unwanted white spaces
*
* A possible use-case is to draw only unwanted white spaces. Examples:
+ *
* - Draw all trailing spaces.
* - If the indentation and alignment must be done with spaces, draw tabs.
*
@@ -354,7 +355,7 @@ gtk_source_space_drawer_class_init (GtkSourceSpaceDrawerClass *klass)
/**
* GtkSourceSpaceDrawer:enable-matrix:
*
- * Whether the #GtkSourceSpaceDrawer:matrix property is enabled.4
+ * Whether the [property@SpaceDrawer:matrix] property is enabled.
*/
properties[PROP_ENABLE_MATRIX] =
g_param_spec_boolean ("enable-matrix",
@@ -368,12 +369,12 @@ gtk_source_space_drawer_class_init (GtkSourceSpaceDrawerClass *klass)
/**
* GtkSourceSpaceDrawer:matrix:
*
- * The :matrix property is a #GVariant property to specify where and
+ * The property is a [class@GLib.Variant] property to specify where and
* what kind of white spaces to draw.
*
- * The #GVariant is of type `"au"`, an array of unsigned integers. Each
- * integer is a combination of #GtkSourceSpaceTypeFlags. There is one
- * integer for each #GtkSourceSpaceLocationFlags, in the same order as
+ * The [class@GLib.Variant] is of type `"au"`, an array of unsigned integers. Each
+ * integer is a combination of [flags@SpaceTypeFlags]. There is one
+ * integer for each [flags@SpaceLocationFlags], in the same order as
* they are defined in the enum (%GTK_SOURCE_SPACE_LOCATION_NONE and
* %GTK_SOURCE_SPACE_LOCATION_ALL are not taken into account).
*
@@ -404,8 +405,9 @@ gtk_source_space_drawer_init (GtkSourceSpaceDrawer *drawer)
/**
* gtk_source_space_drawer_new:
*
- * Creates a new #GtkSourceSpaceDrawer object. Useful for storing space drawing
- * settings independently of a #GtkSourceView.
+ * Creates a new #GtkSourceSpaceDrawer object.
+ *
+ * Useful for storing space drawing settings independently of a [class@View].
*
* Returns: a new #GtkSourceSpaceDrawer.
*/
@@ -421,8 +423,9 @@ gtk_source_space_drawer_new (void)
* @locations: one or several #GtkSourceSpaceLocationFlags.
*
* If only one location is specified, this function returns what kind of
- * white spaces are drawn at that location. The value is retrieved from the
- * #GtkSourceSpaceDrawer:matrix property.
+ * white spaces are drawn at that location.
+ *
+ * The value is retrieved from the [property@SpaceDrawer:matrix] property.
*
* If several locations are specified, this function returns the logical AND for
* those locations. Which means that if a certain kind of white space is present
@@ -446,7 +449,7 @@ gtk_source_space_drawer_get_types_for_locations (GtkSourceSpaceDrawer *dr
* @locations: one or several #GtkSourceSpaceLocationFlags.
* @types: a combination of #GtkSourceSpaceTypeFlags.
*
- * Modifies the #GtkSourceSpaceDrawer:matrix property at the specified
+ * Modifies the [property@SpaceDrawer:matrix] property at the specified
* @locations.
*/
void
@@ -486,10 +489,11 @@ gtk_source_space_drawer_set_types_for_locations (GtkSourceSpaceDrawer *dr
* gtk_source_space_drawer_get_matrix:
* @drawer: a #GtkSourceSpaceDrawer.
*
- * Gets the value of the #GtkSourceSpaceDrawer:matrix property, as a #GVariant.
+ * Gets the value of the [property@SpaceDrawer:matrix] property, as a [class@GLib.Variant].
+ *
* An empty array can be returned in case the matrix is a zero matrix.
*
- * The gtk_source_space_drawer_get_types_for_locations() function may be more
+ * The [method@SpaceDrawer.get_types_for_locations] function may be more
* convenient to use.
*
* Returns: the #GtkSourceSpaceDrawer:matrix value as a new floating #GVariant
@@ -530,12 +534,13 @@ gtk_source_space_drawer_get_matrix (GtkSourceSpaceDrawer *drawer)
* @drawer: a #GtkSourceSpaceDrawer.
* @matrix: (transfer floating) (nullable): the new matrix value, or %NULL.
*
- * Sets a new value to the #GtkSourceSpaceDrawer:matrix property, as a
- * #GVariant. If @matrix is %NULL, then an empty array is set.
+ * Sets a new value to the [property@SpaceDrawer:matrix] property, as a [class@GLib.Variant].
+ *
+ * If @matrix is %NULL, then an empty array is set.
*
* If @matrix is floating, it is consumed.
*
- * The gtk_source_space_drawer_set_types_for_locations() function may be more
+ * The [method@SpaceDrawer.set_types_for_locations] function may be more
* convenient to use.
*/
void
@@ -626,7 +631,7 @@ gtk_source_space_drawer_get_enable_matrix (GtkSourceSpaceDrawer *drawer)
* @drawer: a #GtkSourceSpaceDrawer.
* @enable_matrix: the new value.
*
- * Sets whether the #GtkSourceSpaceDrawer:matrix property is enabled.
+ * Sets whether the [property@SpaceDrawer:matrix] property is enabled.
*/
void
gtk_source_space_drawer_set_enable_matrix (GtkSourceSpaceDrawer *drawer,
@@ -667,13 +672,13 @@ matrix_set_mapping (const GValue *value,
* @key: the @settings key to bind.
* @flags: flags for the binding.
*
- * Binds the #GtkSourceSpaceDrawer:matrix property to a #GSettings key.
+ * Binds the [property@SpaceDrawer:matrix] property to a [class@Gio.Settings] key.
*
- * The #GSettings key must be of the same type as the
- * #GtkSourceSpaceDrawer:matrix property, that is, `"au"`.
+ * The [class@Gio.Settings] key must be of the same type as the
+ * [property@SpaceDrawer:matrix] property, that is, `"au"`.
*
- * The g_settings_bind() function cannot be used, because the default GIO
- * mapping functions don't support #GVariant properties (maybe it will be
+ * The [method Gio Settings bind] function cannot be used, because the default GIO
+ * mapping functions don't support [class@GLib.Variant] properties (maybe it will be
* supported by a future GIO version, in which case this function can be
* deprecated).
*/
diff --git a/gtksourceview/gtksourcestyle.c b/gtksourceview/gtksourcestyle.c
index ea8d2737..53cd902e 100644
--- a/gtksourceview/gtksourcestyle.c
+++ b/gtksourceview/gtksourcestyle.c
@@ -27,7 +27,7 @@
*
* Represents a style.
*
- * The #GtkSourceStyle structure is used to describe text attributes
+ * The `GtkSourceStyle` structure is used to describe text attributes
* which are set when given style is used.
*/
@@ -514,12 +514,12 @@ gtk_source_style_copy (const GtkSourceStyle *style)
* @style: (nullable): a #GtkSourceStyle to apply, or %NULL.
* @tag: a #GtkTextTag to apply styles to.
*
- * This function modifies the #GtkTextTag properties that are related to the
- * #GtkSourceStyle properties. Other #GtkTextTag properties are left untouched.
+ * This function modifies the [class@Gtk.TextTag] properties that are related to the
+ * #GtkSourceStyle properties. Other [class@Gtk.TextTag] properties are left untouched.
*
* If @style is non-%NULL, applies @style to @tag.
*
- * If @style is %NULL, the related *-set properties of #GtkTextTag are set to
+ * If @style is %NULL, the related *-set properties of [class@Gtk.TextTag] are set to
* %FALSE.
*/
void
diff --git a/gtksourceview/gtksourcestylescheme.c b/gtksourceview/gtksourcestylescheme.c
index 5c810e43..5870ee4d 100644
--- a/gtksourceview/gtksourcestylescheme.c
+++ b/gtksourceview/gtksourcestylescheme.c
@@ -34,10 +34,10 @@
/**
* GtkSourceStyleScheme:
*
- * Controls the appearance of GtkSourceView.
+ * Controls the appearance of [class@View].
*
* #GtkSourceStyleScheme contains all the text styles to be used in
- * #GtkSourceView and #GtkSourceBuffer. For instance, it contains text styles
+ * [class@View] and [class@Buffer]. For instance, it contains text styles
* for syntax highlighting, it may contain foreground and background color for
* non-highlighted text, color for the line numbers, current line highlighting,
* bracket matching, etc.
@@ -214,7 +214,7 @@ gtk_source_style_scheme_class_init (GtkSourceStyleSchemeClass *klass)
* GtkSourceStyleScheme:id:
*
* Style scheme id, a unique string used to identify the style scheme
- * in #GtkSourceStyleSchemeManager.
+ * in [class@StyleSchemeManager].
*/
g_object_class_install_property (object_class,
PROP_ID,
diff --git a/gtksourceview/gtksourcestyleschemechooser.c b/gtksourceview/gtksourcestyleschemechooser.c
index f98facd9..cae37bbc 100644
--- a/gtksourceview/gtksourcestyleschemechooser.c
+++ b/gtksourceview/gtksourcestyleschemechooser.c
@@ -27,11 +27,11 @@
*
* Interface implemented by widgets for choosing style schemes.
*
- * #GtkSourceStyleSchemeChooser is an interface that is implemented by widgets
+ * `GtkSourceStyleSchemeChooser` is an interface that is implemented by widgets
* for choosing style schemes.
*
* In GtkSourceView, the main widgets that implement this interface are
- * #GtkSourceStyleSchemeChooserWidget and #GtkSourceStyleSchemeChooserButton.
+ * [class@StyleSchemeChooserWidget] and [class@StyleSchemeChooserButton].
*/
G_DEFINE_INTERFACE (GtkSourceStyleSchemeChooser, gtk_source_style_scheme_chooser, G_TYPE_OBJECT);
@@ -42,9 +42,9 @@ gtk_source_style_scheme_chooser_default_init (GtkSourceStyleSchemeChooserInterfa
/**
* GtkSourceStyleSchemeChooser:style-scheme:
*
- * The :style-scheme property contains the currently selected style
- * scheme. The property can be set to change
- * the current selection programmatically.
+ * Contains the currently selected style scheme.
+ *
+ * The property can be set to change the current selection programmatically.
*/
g_object_interface_install_property (iface,
g_param_spec_object ("style-scheme",
diff --git a/gtksourceview/gtksourcestyleschemechooserbutton.c
b/gtksourceview/gtksourcestyleschemechooserbutton.c
index db6e64c5..81b4fa7a 100644
--- a/gtksourceview/gtksourcestyleschemechooserbutton.c
+++ b/gtksourceview/gtksourcestyleschemechooserbutton.c
@@ -32,12 +32,12 @@
*
* A button to launch a style scheme selection dialog.
*
- * The #GtkSourceStyleSchemeChooserButton is a button which displays
+ * The `GtkSourceStyleSchemeChooserButton` is a button which displays
* the currently selected style scheme and allows to open a style scheme
* selection dialog to change the style scheme.
* It is suitable widget for selecting a style scheme in a preference dialog.
*
- * In #GtkSourceStyleSchemeChooserButton, a #GtkSourceStyleSchemeChooserWidget
+ * In `GtkSourceStyleSchemeChooserButton`, a [class@StyleSchemeChooserWidget]
* is used to provide a dialog for selecting style schemes.
*/
diff --git a/gtksourceview/gtksourcestyleschemechooserwidget.c
b/gtksourceview/gtksourcestyleschemechooserwidget.c
index b8055809..95e4a545 100644
--- a/gtksourceview/gtksourcestyleschemechooserwidget.c
+++ b/gtksourceview/gtksourcestyleschemechooserwidget.c
@@ -35,14 +35,14 @@
*
* A widget for choosing style schemes.
*
- * The #GtkSourceStyleSchemeChooserWidget widget lets the user select a
+ * The `GtkSourceStyleSchemeChooserWidget` widget lets the user select a
* style scheme. By default, the chooser presents a predefined list
* of style schemes.
*
* To change the initially selected style scheme,
- * use gtk_source_style_scheme_chooser_set_style_scheme().
+ * use [method@StyleSchemeChooser.set_style_scheme].
* To get the selected style scheme
- * use gtk_source_style_scheme_chooser_get_style_scheme().
+ * use [method@StyleSchemeChooser.get_style_scheme].
*/
typedef struct
diff --git a/gtksourceview/gtksourcestyleschememanager.c b/gtksourceview/gtksourcestyleschememanager.c
index 6d8aef54..808dbd28 100644
--- a/gtksourceview/gtksourcestyleschememanager.c
+++ b/gtksourceview/gtksourcestyleschememanager.c
@@ -28,9 +28,7 @@
/**
* GtkSourceStyleSchemeManager:
*
- * Provides access to GtkSourceStyleSchemes.
- *
- * Object which provides access to #GtkSourceStyleScheme<!-- -->s.
+ * Provides access to [class@StyleScheme]s.
*/
#define SCHEME_FILE_SUFFIX ".xml"
@@ -176,8 +174,10 @@ gtk_source_style_scheme_manager_init (GtkSourceStyleSchemeManager *mgr)
/**
* gtk_source_style_scheme_manager_new:
*
- * Creates a new style manager. If you do not need more than one style
- * manager then use gtk_source_style_scheme_manager_get_default() instead.
+ * Creates a new style manager.
+ *
+ * If you do not need more than one style manager
+ * then use [func@StyleSchemeManager.get_default] instead.
*
* Returns: a new #GtkSourceStyleSchemeManager.
*/
@@ -438,7 +438,8 @@ gtk_source_style_scheme_manager_set_search_path (GtkSourceStyleSchemeManager *ma
*
* Appends @path to the list of directories where the @manager looks for
* style scheme files.
- * See gtk_source_style_scheme_manager_set_search_path() for details.
+ *
+ * See [method@StyleSchemeManager.set_search_path] for details.
*/
void
gtk_source_style_scheme_manager_append_search_path (GtkSourceStyleSchemeManager *manager,
@@ -473,7 +474,8 @@ gtk_source_style_scheme_manager_append_search_path (GtkSourceStyleSchemeManager
*
* Prepends @path to the list of directories where the @manager looks
* for style scheme files.
- * See gtk_source_style_scheme_manager_set_search_path() for details.
+ *
+ * See [method@StyleSchemeManager.set_search_path] for details.
*/
void
gtk_source_style_scheme_manager_prepend_search_path (GtkSourceStyleSchemeManager *manager,
@@ -507,7 +509,8 @@ gtk_source_style_scheme_manager_prepend_search_path (GtkSourceStyleSchemeManager
* @manager: a #GtkSourceStyleSchemeManager.
*
* Returns the current search path for the @manager.
- * See gtk_source_style_scheme_manager_set_search_path() for details.
+ *
+ * See [method@StyleSchemeManager.set_search_path] for details.
*
* Returns: (array zero-terminated=1) (transfer none): a %NULL-terminated array
* of string containing the search path.
@@ -528,9 +531,10 @@ gtk_source_style_scheme_manager_get_search_path (GtkSourceStyleSchemeManager *ma
* gtk_source_style_scheme_manager_force_rescan:
* @manager: a #GtkSourceStyleSchemeManager.
*
- * Mark any currently cached information about the available style scehems
- * as invalid. All the available style schemes will be reloaded next time
- * the @manager is accessed.
+ * Mark any currently cached information about the available style schems
+ * as invalid.
+ *
+ * All the available style schemes will be reloaded next time the @manager is accessed.
*/
void
gtk_source_style_scheme_manager_force_rescan (GtkSourceStyleSchemeManager *manager)
diff --git a/gtksourceview/gtksourcestyleschemepreview.c b/gtksourceview/gtksourcestyleschemepreview.c
index 1ec4cbcb..d90e0dc7 100644
--- a/gtksourceview/gtksourcestyleschemepreview.c
+++ b/gtksourceview/gtksourcestyleschemepreview.c
@@ -38,11 +38,11 @@
/**
* GtkSourceStyleSchemePreview:
*
- * A preview widget for #GtkSourceStyleScheme.
+ * A preview widget for [class@StyleScheme].
*
- * This widget provides a convenient #GtkWidget to preview a #GtkSourceStyleScheme.
+ * This widget provides a convenient [class@Gtk.Widget] to preview a [class@StyleScheme].
*
- * The #GtkSourceStyleSchemePreview:selected property can be used to manage
+ * The [property@StyleSchemePreview:selected] property can be used to manage
* the selection state of a single preview widget.
*
* Since: 5.4
diff --git a/gtksourceview/gtksourcetag.c b/gtksourceview/gtksourcetag.c
index 5f9fe955..a1298068 100644
--- a/gtksourceview/gtksourcetag.c
+++ b/gtksourceview/gtksourcetag.c
@@ -26,13 +26,13 @@
/**
* GtkSourceTag:
*
- * A tag that can be applied to text in a GtkSourceBuffer.
+ * A tag that can be applied to text in a [class@Buffer].
*
- * #GtkSourceTag is a subclass of #GtkTextTag that adds properties useful for
+ * `GtkSourceTag` is a subclass of [class@Gtk.TextTag] that adds properties useful for
* the GtkSourceView library.
*
- * If, for a certain tag, #GtkTextTag is sufficient, it's better that you create
- * a #GtkTextTag, not a #GtkSourceTag.
+ * If, for a certain tag, [class@Gtk.TextTag] is sufficient, it's better that you create
+ * a [class@Gtk.TextTag], not a [class@Tag].
*/
typedef struct
@@ -124,11 +124,12 @@ gtk_source_tag_class_init (GtkSourceTagClass *klass)
/**
* GtkSourceTag:draw-spaces:
*
- * Whether to draw white spaces. This property takes precedence over the value
- * defined by the GtkSourceSpaceDrawer's #GtkSourceSpaceDrawer:matrix property
- * (only where the tag is applied).
+ * Whether to draw white spaces.
+ *
+ * This property takes precedence over the value defined by the [class@SpaceDrawer]'s
+ * [property@SpaceDrawer:matrix] property (only where the tag is applied).
*
- * Setting this property also changes #GtkSourceTag:draw-spaces-set to
+ * Setting this property also changes [property@Tag:draw-spaces-set] to
* %TRUE.
*/
properties [PROP_DRAW_SPACES] =
@@ -143,7 +144,7 @@ gtk_source_tag_class_init (GtkSourceTagClass *klass)
/**
* GtkSourceTag:draw-spaces-set:
*
- * Whether the #GtkSourceTag:draw-spaces property is set and must be
+ * Whether the [property@Tag:draw-spaces] property is set and must be
* taken into account.
*/
properties [PROP_DRAW_SPACES_SET] =
@@ -167,13 +168,14 @@ gtk_source_tag_init (GtkSourceTag *tag)
* gtk_source_tag_new:
* @name: (nullable): tag name, or %NULL.
*
- * Creates a #GtkSourceTag. Configure the tag using object arguments,
- * i.e. using g_object_set().
+ * Creates a `GtkSourceTag`.
+ *
+ * Configure the tag using object arguments, i.e. using [method GObject Object set].
*
- * For usual cases, gtk_source_buffer_create_source_tag() is more convenient to
+ * For usual cases, [method@Buffer.create_source_tag] is more convenient to
* use.
*
- * Returns: a new #GtkSourceTag.
+ * Returns: a new `GtkSourceTag`.
*/
GtkTextTag *
gtk_source_tag_new (const gchar *name)
diff --git a/gtksourceview/gtksourceutils.c b/gtksourceview/gtksourceutils.c
index cbf1e72e..6c617cc4 100644
--- a/gtksourceview/gtksourceutils.c
+++ b/gtksourceview/gtksourceutils.c
@@ -41,14 +41,14 @@
* gtk_source_utils_unescape_search_text:
* @text: the text to unescape.
*
- * Use this function before gtk_source_search_settings_set_search_text(), to
+ * Use this function before [method@SearchSettings.set_search_text], to
* unescape the following sequences of characters: `\n`, `\r`, `\t` and `\\`.
* The purpose is to easily write those characters in a search entry.
*
* Note that unescaping the search text is not needed for regular expression
* searches.
*
- * See also: gtk_source_utils_escape_search_text().
+ * See also: [func@utils_escape_search_text].
*
* Returns: the unescaped @text.
*/
@@ -140,7 +140,7 @@ gtk_source_utils_unescape_search_text (const gchar *text)
* search entry. The selection can contain tabulations, newlines, etc. So it's
* better to escape those special characters to better fit in the search entry.
*
- * See also: gtk_source_utils_unescape_search_text().
+ * See also: [func@utils_unescape_search_text].
*
* <warning>
* Warning: the escape and unescape functions are not reciprocal! For example,
diff --git a/gtksourceview/gtksourceview.c b/gtksourceview/gtksourceview.c
index 3d55e573..5b73ef5e 100644
--- a/gtksourceview/gtksourceview.c
+++ b/gtksourceview/gtksourceview.c
@@ -59,12 +59,13 @@
/**
* GtkSourceView:
*
- * Subclass of #GtkTextView.
+ * Subclass of [class@Gtk.TextView].
*
- * #GtkSourceView is the main class of the GtkSourceView library.
- * Use a #GtkSourceBuffer to display text with a #GtkSourceView.
+ * `GtkSourceView` is the main class of the GtkSourceView library.
+ * Use a [class@Buffer] to display text with a `GtkSourceView`.
*
* This class provides:
+ *
* - Show the line numbers;
* - Show a right margin;
* - Highlight the current line;
@@ -78,43 +79,43 @@
*
* # GtkSourceView as GtkBuildable
*
- * The GtkSourceView implementation of the #GtkBuildable interface exposes the
- * #GtkSourceView:completion object with the internal-child "completion".
+ * The GtkSourceView implementation of the [iface@Gtk.Buildable] interface exposes the
+ * [property@View:completion] object with the internal-child "completion".
*
* An example of a UI definition fragment with GtkSourceView:
- * |[
+ * ```xml
* <object class="GtkSourceView" id="source_view">
- * <property name="tab_width">4</property>
- * <property name="auto_indent">True</property>
+ * <property name="tab-width">4</property>
+ * <property name="auto-indent">True</property>
* <child internal-child="completion">
* <object class="GtkSourceCompletion">
- * <property name="select_on_show">False</property>
+ * <property name="select-on-show">False</property>
* </object>
* </child>
* </object>
- * ]|
+ * ```
*
* # Changing the Font
*
- * Gtk CSS provides the best way to change the font for a #GtkSourceView in a
- * manner that allows for components like #GtkSourceMap to scale the desired
+ * Gtk CSS provides the best way to change the font for a `GtkSourceView` in a
+ * manner that allows for components like [class@Map] to scale the desired
* font.
*
- * |[
- * GtkCssProvider *provider = gtk_css_provider_new ();
- * gtk_css_provider_load_from_data (provider,
- * "textview { font-family: Monospace; font-size: 8pt; }",
- * -1,
- * NULL);
- * gtk_style_context_add_provider (gtk_widget_get_style_context (view),
- * GTK_STYLE_PROVIDER (provider),
- * GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);
- * g_object_unref (provider);
- * ]|
+ * ```c
+ * GtkCssProvider *provider = gtk_css_provider_new ();
+ * gtk_css_provider_load_from_data (provider,
+ * "textview { font-family: Monospace; font-size: 8pt; }",
+ * -1,
+ * NULL);
+ * gtk_style_context_add_provider (gtk_widget_get_style_context (view),
+ * GTK_STYLE_PROVIDER (provider),
+ * GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);
+ * g_object_unref (provider);
+ * ```
*
* If you need to adjust the font or size of font within a portion of the
- * document only, you should use a #GtkTextTag with the #GtkTextTag:family or
- * #GtkTextTag:scale set so that the font size may be scaled relative to
+ * document only, you should use a [class@Gtk.TextTag] with the [property@Gtk.TextTag:family] or
+ * [property@Gtk.TextTag:scale] set so that the font size may be scaled relative to
* the default font set in CSS.
*/
@@ -558,9 +559,9 @@ gtk_source_view_class_init (GtkSourceViewClass *klass)
/**
* GtkSourceView:enable-snippets:
*
- * The "enable-snippets" property denotes if snippets should be
+ * The property denotes if snippets should be
* expanded when the user presses Tab after having typed a word
- * matching the snippets found in #GtkSourceSnippetManager.
+ * matching the snippets found in [class@SnippetManager].
*
* The user may tab through focus-positions of the snippet if any
* are available by pressing Tab repeatedly until the desired focus
@@ -622,8 +623,8 @@ gtk_source_view_class_init (GtkSourceViewClass *klass)
/**
* GtkSourceView:indenter:
*
- * The "indenter" property is a #GtkSourceIndenter to use to indent
- * as the user types into the #GtkSourceView.
+ * The property is a [iface@Indenter] to use to indent
+ * as the user types into the [class@View].
*/
properties [PROP_INDENTER] =
g_param_spec_object ("indenter",
@@ -765,7 +766,7 @@ gtk_source_view_class_init (GtkSourceViewClass *klass)
/**
* GtkSourceView:space-drawer:
*
- * The #GtkSourceSpaceDrawer object associated with the view.4
+ * The [class@SpaceDrawer] object associated with the view.4
*/
properties [PROP_SPACE_DRAWER] =
g_param_spec_object ("space-drawer",
@@ -781,15 +782,15 @@ gtk_source_view_class_init (GtkSourceViewClass *klass)
* GtkSourceView::show-completion:
* @view: The #GtkSourceView who emits the signal
*
- * The ::show-completion signal is a key binding signal which gets
+ * The signal is a key binding signal which gets
* emitted when the user requests a completion, by pressing
* <keycombo><keycap>Control</keycap><keycap>space</keycap></keycombo>.
*
- * This will create a #GtkSourceCompletionContext with the activation
+ * This will create a [class@CompletionContext] with the activation
* type as %GTK_SOURCE_COMPLETION_ACTIVATION_USER_REQUESTED.
*
* Applications should not connect to it, but may emit it with
- * g_signal_emit_by_name() if they need to activate the completion by
+ * [func@GObject.signal_emit_by_name] if they need to activate the completion by
* another means, for example with another key binding or a menu entry.
*/
signals[SHOW_COMPLETION] =
@@ -813,8 +814,9 @@ gtk_source_view_class_init (GtkSourceViewClass *klass)
* @n_presses: the number of presses
*
* Emitted when a line mark has been activated (for instance when there
- * was a button press in the line marks gutter). You can use @iter to
- * determine on which line the activation took place.
+ * was a button press in the line marks gutter).
+ *
+ * You can use @iter to determine on which line the activation took place.
*/
signals[LINE_MARK_ACTIVATED] =
g_signal_new ("line-mark-activated",
@@ -838,9 +840,9 @@ gtk_source_view_class_init (GtkSourceViewClass *klass)
* @view: the #GtkSourceView which received the signal.
* @down: %TRUE to move down, %FALSE to move up.
*
- * The ::move-lines signal is a keybinding which gets emitted
- * when the user initiates moving a line. The default binding key
- * is Alt+Up/Down arrow. And moves the currently selected lines,
+ * The signal is a keybinding which gets emitted when the user initiates moving a line.
+ *
+ * The default binding key is Alt+Up/Down arrow. And moves the currently selected lines,
* or the current line up or down by one line.
*/
signals[MOVE_LINES] =
@@ -861,9 +863,9 @@ gtk_source_view_class_init (GtkSourceViewClass *klass)
* @view: the #GtkSourceView which received the signal
* @count: the number of words to move over
*
- * The ::move-words signal is a keybinding which gets emitted
- * when the user initiates moving a word. The default binding key
- * is Alt+Left/Right Arrow and moves the current selection, or the current
+ * The signal is a keybinding which gets emitted when the user initiates moving a word.
+ *
+ * The default binding key is Alt+Left/Right Arrow and moves the current selection, or the current
* word by one word.
*/
signals[MOVE_WORDS] =
@@ -885,9 +887,9 @@ gtk_source_view_class_init (GtkSourceViewClass *klass)
* @snippet: a #GtkSourceSnippet
* @location: (inout): a #GtkTextIter
*
- * The ::push-snippet signal is emitted to insert a new snippet into
- * the view. If another snippet was active, it will be paused until all
- * focus positions of @snippet have been exhausted.
+ * The signal is emitted to insert a new snippet into the view.
+ *
+ * If another snippet was active, it will be paused until all focus positions of @snippet have been
exhausted.
*
* @location will be updated to point at the end of the snippet.
*/
@@ -912,9 +914,10 @@ gtk_source_view_class_init (GtkSourceViewClass *klass)
* @iter: a #GtkTextIter
* @count: the count
*
- * Emitted when a the cursor was moved according to the smart home
- * end setting. The signal is emitted after the cursor is moved, but
- * during the GtkTextView::move-cursor action. This can be used to find
+ * Emitted when a the cursor was moved according to the smart home end setting.
+ *
+ * The signal is emitted after the cursor is moved, but
+ * during the [signal@Gtk.TextView::move-cursor] action. This can be used to find
* out whether the cursor was moved by a normal home/end or by a smart
* home/end.
*/
@@ -2789,14 +2792,14 @@ gtk_source_view_create_buffer (GtkTextView *text_view)
/**
* gtk_source_view_new:
*
- * Creates a new #GtkSourceView.
+ * Creates a new `GtkSourceView`.
*
- * By default, an empty #GtkSourceBuffer will be lazily created and can be
- * retrieved with gtk_text_view_get_buffer().
+ * By default, an empty [class@Buffer] will be lazily created and can be
+ * retrieved with [method@Gtk.TextView.get_buffer].
*
* If you want to specify your own buffer, either override the
- * #GtkTextViewClass create_buffer factory method, or use
- * gtk_source_view_new_with_buffer().
+ * [vfunc@Gtk.TextView.create_buffer] factory method, or use
+ * [ctor@View.new_with_buffer].
*
* Returns: a new #GtkSourceView.
*/
@@ -2810,8 +2813,9 @@ gtk_source_view_new (void)
* gtk_source_view_new_with_buffer:
* @buffer: a #GtkSourceBuffer.
*
- * Creates a new #GtkSourceView widget displaying the buffer
- * @buffer. One buffer can be shared among many widgets.
+ * Creates a new #GtkSourceView widget displaying the buffer @buffer.
+ *
+ * One buffer can be shared among many widgets.
*
* Returns: a new #GtkSourceView.
*/
@@ -3000,9 +3004,10 @@ set_tab_stops_internal (GtkSourceView *view)
* @view: a #GtkSourceView.
* @width: width of tab in characters.
*
- * Sets the width of tabulation in characters. The #GtkTextBuffer still contains
- * \t characters, but they can take a different visual width in a #GtkSourceView
- * widget.
+ * Sets the width of tabulation in characters.
+ *
+ * The #GtkTextBuffer still contains `\t` characters,
+ * but they can take a different visual width in a [class@View] widget.
*/
void
gtk_source_view_set_tab_width (GtkSourceView *view,
@@ -3057,21 +3062,23 @@ gtk_source_view_get_tab_width (GtkSourceView *view)
* @width: indent width in characters.
*
* Sets the number of spaces to use for each step of indent when the tab key is
- * pressed. If @width is -1, the value of the #GtkSourceView:tab-width property
+ * pressed.
+ *
+ * If @width is -1, the value of the [property@View:tab-width] property
* will be used.
*
- * The #GtkSourceView:indent-width interacts with the
- * #GtkSourceView:insert-spaces-instead-of-tabs property and
- * #GtkSourceView:tab-width. An example will be clearer: if the
- * #GtkSourceView:indent-width is 4 and
- * #GtkSourceView:tab-width is 8 and
- * #GtkSourceView:insert-spaces-instead-of-tabs is %FALSE, then pressing the tab
+ * The [property@View:indent-width] interacts with the
+ * [property@View:insert-spaces-instead-of-tabs] property and
+ * [property@View:tab-width]. An example will be clearer:
+ *
+ * If the [property@View:indent-width] is 4 and [property@View:tab-width] is 8 and
+ * [property@View:insert-spaces-instead-of-tabs] is %FALSE, then pressing the tab
* key at the beginning of a line will insert 4 spaces. So far so good. Pressing
- * the tab key a second time will remove the 4 spaces and insert a \t character
- * instead (since #GtkSourceView:tab-width is 8). On the other hand, if
- * #GtkSourceView:insert-spaces-instead-of-tabs is %TRUE, the second tab key
+ * the tab key a second time will remove the 4 spaces and insert a `\t` character
+ * instead (since [property@View:tab-width] is 8). On the other hand, if
+ * [property@View:insert-spaces-instead-of-tabs] is %TRUE, the second tab key
* pressed will insert 4 more spaces for a total of 8 spaces in the
- * #GtkTextBuffer.
+ * [class@Gtk.TextBuffer].
*
* The test-widget program (available in the GtkSourceView repository) may be
* useful to better understand the indentation settings (enable the space
@@ -3099,7 +3106,8 @@ gtk_source_view_set_indent_width (GtkSourceView *view,
* @view: a #GtkSourceView.
*
* Returns the number of spaces to use for each step of indent.
- * See gtk_source_view_set_indent_width() for details.
+ *
+ * See [method@View.set_indent_width] for details.
*
* Return value: indent width.
*/
@@ -4131,7 +4139,7 @@ gtk_source_view_get_auto_indent (GtkSourceView *view)
* If %TRUE auto-indentation of text is enabled.
*
* When Enter is pressed to create a new line, the auto-indentation inserts the
- * same indentation as the previous line. This is <emphasis>not</emphasis> a
+ * same indentation as the previous line. This is **not** a
* "smart indentation" where an indentation level is added or removed depending
* on the context.
*/
@@ -4177,9 +4185,10 @@ gtk_source_view_get_insert_spaces_instead_of_tabs (GtkSourceView *view)
* @view: a #GtkSourceView.
* @enable: whether to insert spaces instead of tabs.
*
- * If %TRUE a tab key pressed is replaced by a group of space characters. Of
- * course it is still possible to insert a real \t programmatically with the
- * #GtkTextBuffer API.
+ * If %TRUE a tab key pressed is replaced by a group of space characters.
+ *
+ * Of course it is still possible to insert a real `\t` programmatically with the
+ * [class@Gtk.TextBuffer] API.
*/
void
gtk_source_view_set_insert_spaces_instead_of_tabs (GtkSourceView *view,
@@ -4204,7 +4213,7 @@ gtk_source_view_set_insert_spaces_instead_of_tabs (GtkSourceView *view,
* @view: a #GtkSourceView.
*
* Returns whether when the tab key is pressed the current selection
- * should get indented instead of replaced with the \t character.
+ * should get indented instead of replaced with the `\t` character.
*
* Return value: %TRUE if the selection is indented when tab is pressed.
*/
@@ -4224,14 +4233,14 @@ gtk_source_view_get_indent_on_tab (GtkSourceView *view)
* @enable: whether to indent a block when tab is pressed.
*
* If %TRUE, when the tab key is pressed when several lines are selected, the
- * selected lines are indented of one level instead of being replaced with a \t
+ * selected lines are indented of one level instead of being replaced with a `\t`
* character. Shift+Tab unindents the selection.
*
* If the first or last line is not selected completely, it is also indented or
* unindented.
*
* When the selection doesn't span several lines, the tab key always replaces
- * the selection with a normal \t character.
+ * the selection with a normal `\t` character.
*/
void
gtk_source_view_set_indent_on_tab (GtkSourceView *view,
@@ -4515,7 +4524,7 @@ gtk_source_view_set_smart_home_end (GtkSourceView *view,
* gtk_source_view_get_smart_home_end:
* @view: a #GtkSourceView.
*
- * Returns a #GtkSourceSmartHomeEndType end value specifying
+ * Returns a [enum@SmartHomeEndType] end value specifying
* how the cursor will move when HOME and END keys are pressed.
*
* Returns: a #GtkSourceSmartHomeEndType value.
@@ -4536,7 +4545,7 @@ gtk_source_view_get_smart_home_end (GtkSourceView *view)
* @iter: a position in @view.
*
* Determines the visual column at @iter taking into consideration the
- * #GtkSourceView:tab-width of @view.
+ * [property@View:tab-width] of @view.
*
* Returns: the visual column at @iter.
*/
@@ -4886,9 +4895,10 @@ mark_category_free (MarkCategory *category)
* gtk_source_view_get_completion:
* @view: a #GtkSourceView.
*
- * Gets the #GtkSourceCompletion associated with @view. The returned object is
- * guaranteed to be the same for the lifetime of @view. Each #GtkSourceView
- * object has a different #GtkSourceCompletion.
+ * Gets the [class@Completion] associated with @view.
+ *
+ * The returned object is guaranteed to be the same for the lifetime of @view.
+ * Each `GtkSourceView` object has a different [class@Completion].
*
* Returns: (transfer none): the #GtkSourceCompletion associated with @view.
*/
@@ -4911,9 +4921,10 @@ gtk_source_view_get_completion (GtkSourceView *view)
* gtk_source_view_get_hover:
* @view: a #GtkSourceView.
*
- * Gets the #GtkSourceHover associated with @view. The returned object is
- * guaranteed to be the same for the lifetime of @view. Each #GtkSourceView
- * object has a different #GtkSourceHover.
+ * Gets the [class@Hover] associated with @view.
+ *
+ * The returned object is guaranteed to be the same for the lifetime of @view.
+ * Each [class@View] object has a different [class@Hover].
*
* Returns: (transfer none): a #GtkSourceHover associated with @view.
*/
@@ -4937,8 +4948,9 @@ gtk_source_view_get_hover (GtkSourceView *view)
* @view: a #GtkSourceView.
* @window_type: the gutter window type.
*
- * Returns the #GtkSourceGutter object associated with @window_type for @view.
- * Only GTK_TEXT_WINDOW_LEFT and GTK_TEXT_WINDOW_RIGHT are supported,
+ * Returns the [class@Gutter] object associated with @window_type for @view.
+ *
+ * Only %GTK_TEXT_WINDOW_LEFT and %GTK_TEXT_WINDOW_RIGHT are supported,
* respectively corresponding to the left and right gutter. The line numbers
* and mark category icons are rendered in the left gutter.
*
@@ -5108,9 +5120,10 @@ gtk_source_view_get_background_pattern (GtkSourceView *view)
* gtk_source_view_get_space_drawer:
* @view: a #GtkSourceView.
*
- * Gets the #GtkSourceSpaceDrawer associated with @view. The returned object is
- * guaranteed to be the same for the lifetime of @view. Each #GtkSourceView
- * object has a different #GtkSourceSpaceDrawer.
+ * Gets the [class@SpaceDrawer] associated with @view.
+ *
+ * The returned object is guaranteed to be the same for the lifetime of @view.
+ * Each [class@View] object has a different [class@SpaceDrawer].
*
* Returns: (transfer none): the #GtkSourceSpaceDrawer associated with @view.
*/
@@ -5278,11 +5291,10 @@ gtk_source_view_push_snippet (GtkSourceView *view,
* gtk_source_view_get_enable_snippets:
* @view: a #GtkSourceView
*
- * Gets the #GtkSourceView:enable-snippets property.
+ * Gets the [property@View:enable-snippets] property.
*
- * If %TRUE, matching snippets found in the #GtkSourceSnippetManager
- * may be expanded when the user presses Tab after a word in the
- * #GtkSourceView.
+ * If %TRUE, matching snippets found in the [class@SnippetManager]
+ * may be expanded when the user presses Tab after a word in the [class@View].
*
* Returns: %TRUE if enabled
*/
@@ -5301,11 +5313,11 @@ gtk_source_view_get_enable_snippets (GtkSourceView *view)
* @view: a #GtkSourceView
* @enable_snippets: if snippets should be enabled
*
- * Sets the #GtkSourceView:enable-snippets property.
+ * Sets the [property@View:enable-snippets] property.
*
* If @enable_snippets is %TRUE, matching snippets found in the
- * #GtkSourceSnippetManager may be expanded when the user presses
- * Tab after a word in the #GtkSourceView.
+ * [class@SnippetManager] may be expanded when the user presses
+ * Tab after a word in the [class@View].
*/
void
gtk_source_view_set_enable_snippets (GtkSourceView *view,
@@ -5330,7 +5342,7 @@ gtk_source_view_set_enable_snippets (GtkSourceView *view,
* gtk_source_view_get_indenter:
* @view: a #GtkSourceView
*
- * Gets the #GtkSourceView:indenter property.
+ * Gets the [property@View:indenter] property.
*
* Returns: (transfer none) (nullable): a #GtkSourceIndenter or %NULL
*/
diff --git a/gtksourceview/gtksourcevimimcontext.c b/gtksourceview/gtksourcevimimcontext.c
index 626f65a6..f35b3b2c 100644
--- a/gtksourceview/gtksourcevimimcontext.c
+++ b/gtksourceview/gtksourcevimimcontext.c
@@ -33,13 +33,13 @@
*
* Vim emulation.
*
- * The #GtkSourceVimIMContext is a #GtkIMContext implementation that can
- * be used to provide Vim-like editing controls within a #GtkSourceView.
+ * The `GtkSourceVimIMContext` is a [iface@Gtk.IMContext] implementation that can
+ * be used to provide Vim-like editing controls within a [class@View].
*
- * The #GtkSourceViMIMContext will process incoming #GdkKeyEvent as the
- * user types. It should be used in conjunction with a #GtkEventControllerKey.
+ * The `GtkSourceViMIMContext` will process incoming [class@Gdk.KeyEvent] as the
+ * user types. It should be used in conjunction with a [class@Gtk.EventControllerKey].
*
- * Various features supported by #GtkSourceVimIMContext include:
+ * Various features supported by `GtkSourceVimIMContext` include:
*
* - Normal, Insert, Replace, Visual, and Visual Line modes
* - Support for an integrated command bar and current command preview
@@ -52,30 +52,30 @@
* - Some commonly used Vim commands
*
* It is recommended that applications display the contents of
- * #GtkSourceVimIMContext:command-bar-text and
- * #GtkSourceVimIMContext:command-text to the user as they represent the
+ * [property@VimIMContext:command-bar-text] and
+ * [property@VimIMContext:command-text] to the user as they represent the
* command-bar and current command preview found in Vim.
*
- * #GtkSourceVimIMContext attempts to work with additional #GtkIMContext
- * implementations such as IBus by querying the #GtkTextView before processing
+ * `GtkSourceVimIMContext` attempts to work with additional [iface@Gtk.IMContext]
+ * implementations such as IBus by querying the [class@Gtk.TextView] before processing
* the command in states which support it (notably Insert and Replace modes).
*
- * <informalexample><programlisting>
- * GtkEventController *key;
- * GtkSourceView *view;
- * GtkIMContext *im_context;
+ * ```c
+ * GtkEventController *key;
+ * GtkSourceView *view;
+ * GtkIMContext *im_context;
*
- * view = gtk_source_view_new ();
- * im_context = gtk_source_vim_im_context_new ();
- * key = gtk_event_controller_key_new ();
+ * view = gtk_source_view_new ();
+ * im_context = gtk_source_vim_im_context_new ();
+ * key = gtk_event_controller_key_new ();
*
- * gtk_event_controller_key_set_im_context (GTK_EVENT_CONTROLLER_KEY (key), im_context);
- * gtk_event_controller_set_propagation_phase (key, GTK_PHASE_CAPTURE);
- * gtk_widget_add_controller (GTK_WIDGET (view), key);
+ * gtk_event_controller_key_set_im_context (GTK_EVENT_CONTROLLER_KEY (key), im_context);
+ * gtk_event_controller_set_propagation_phase (key, GTK_PHASE_CAPTURE);
+ * gtk_widget_add_controller (GTK_WIDGET (view), key);
*
- * g_object_bind_property (im_context, "command-bar-text", command_bar_label, "label", 0);
- * g_object_bind_property (im_context, "command-text", command_label, "label", 0);
- * </programlisting></informalexample>
+ * g_object_bind_property (im_context, "command-bar-text", command_bar_label, "label", 0);
+ * g_object_bind_property (im_context, "command-text", command_label, "label", 0);
+ * ```
*
* Since: 5.4
*/
@@ -411,8 +411,8 @@ gtk_source_vim_im_context_class_init (GtkSourceVimIMContextClass *klass)
* @self: a #GtkSourceVimIMContext
* @command: the command to execute
*
- * The "execute-command" signal is emitted when a command should be
- * executed. This might be something like ":wq" or ":e <path>".
+ * The signal is emitted when a command should be
+ * executed. This might be something like `:wq` or `:e <path>`.
*
* If the application chooses to implement this, it should return
* %TRUE from this signal to indicate the command has been handled.
@@ -461,11 +461,10 @@ gtk_source_vim_im_context_class_init (GtkSourceVimIMContextClass *klass)
* @view: the #GtkSourceView
* @path: (nullable): the path if provided, otherwise %NULL
*
- * Requests the application save the file. If a filename was provided,
- * it will be available to the signal handler as @path.
- *
- * This may be executed in relation to the user running the
- * `:write` or `:w` commands.
+ * Requests the application save the file.
+ *
+ * If a filename was provided, it will be available to the signal handler as @path.
+ * This may be executed in relation to the user running the `:write` or `:w` commands.
*
* Since: 5.4
*/
@@ -487,8 +486,9 @@ gtk_source_vim_im_context_class_init (GtkSourceVimIMContextClass *klass)
* @view: the #GtkSourceView
* @path: (nullable): the path if provided, otherwise %NULL
*
- * Requests the application open the file found at @path. If @path is
- * %NULL, then the current file should be reloaded from storage.
+ * Requests the application open the file found at @path.
+ *
+ * If @path is %NULL, then the current file should be reloaded from storage.
*
* This may be executed in relation to the user running the
* `:edit` or `:e` commands.
@@ -582,7 +582,7 @@ gtk_source_vim_im_context_get_command_bar_text (GtkSourceVimIMContext *self)
*
* Executes @command as if it was typed into the command bar by the
* user except that this does not emit the
- * #GtkSourceVimIMContext::execute-command signal.
+ * [signal@VimIMContext::execute-command] signal.
*
* Since: 5.4
*/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
