[gtksourceview: 4/21] docs: port types sections to gi-docgen
- From: Christian Hergert <chergert src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtksourceview: 4/21] docs: port types sections to gi-docgen
- Date: Thu, 2 Dec 2021 00:02:52 +0000 (UTC)
commit ce93366bc0e09833fee897fdf5aacdc25a60ad34
Author: Bilal Elmoussaoui <bil elmoussaoui gmail com>
Date: Mon Nov 29 21:39:36 2021 +0100
docs: port types sections to gi-docgen
.../completion-providers/snippets/gtksourcecompletionsnippets.c | 6 +++---
.../completion-providers/words/gtksourcecompletionwords.c | 6 +++---
gtksourceview/gtksourcebindinggroup.c | 6 +++---
gtksourceview/gtksourcebuffer.c | 7 +++----
gtksourceview/gtksourcecompletion.c | 6 +++---
gtksourceview/gtksourcecompletioncell.c | 6 +++---
gtksourceview/gtksourcecompletioncontext.c | 8 +++-----
gtksourceview/gtksourcecompletionproposal.c | 6 +++---
gtksourceview/gtksourcecompletionprovider.c | 6 +++---
gtksourceview/gtksourceencoding.c | 7 +++----
gtksourceview/gtksourcefile.c | 7 +++----
gtksourceview/gtksourcefileloader.c | 7 +++----
gtksourceview/gtksourcefilesaver.c | 7 +++----
gtksourceview/gtksourcegutter.c | 7 +++----
gtksourceview/gtksourcegutterlines.c | 6 +++---
gtksourceview/gtksourcegutterrenderer.c | 7 +++----
gtksourceview/gtksourcegutterrendererpixbuf.c | 7 +++----
gtksourceview/gtksourcegutterrenderertext.c | 7 +++----
gtksourceview/gtksourcehover.c | 8 +++-----
gtksourceview/gtksourcehovercontext.c | 7 +++----
gtksourceview/gtksourcehoverdisplay.c | 7 +++----
gtksourceview/gtksourcehoverprovider.c | 7 +++----
gtksourceview/gtksourceindenter.c | 7 +++----
gtksourceview/gtksourcelanguage.c | 7 +++----
gtksourceview/gtksourcelanguagemanager.c | 7 +++----
gtksourceview/gtksourcemap.c | 7 +++----
gtksourceview/gtksourcemark.c | 7 +++----
gtksourceview/gtksourcemarkattributes.c | 6 ++----
gtksourceview/gtksourceprintcompositor.c | 6 +++---
gtksourceview/gtksourceregion.c | 7 +++----
gtksourceview/gtksourcesearchcontext.c | 7 +++----
gtksourceview/gtksourcesearchsettings.c | 7 +++----
gtksourceview/gtksourcesignalgroup.c | 6 +++---
gtksourceview/gtksourcesnippet.c | 7 +++----
gtksourceview/gtksourcesnippetchunk.c | 6 +++---
gtksourceview/gtksourcesnippetcontext.c | 6 +++---
gtksourceview/gtksourcesnippetmanager.c | 7 +++----
gtksourceview/gtksourcespacedrawer.c | 7 +++----
gtksourceview/gtksourcestyle.c | 7 +++----
gtksourceview/gtksourcestylescheme.c | 7 +++----
gtksourceview/gtksourcestyleschemechooser.c | 7 +++----
gtksourceview/gtksourcestyleschemechooserbutton.c | 7 +++----
gtksourceview/gtksourcestyleschemechooserwidget.c | 7 +++----
gtksourceview/gtksourcestyleschememanager.c | 7 +++----
gtksourceview/gtksourcestyleschemepreview.c | 6 +++---
gtksourceview/gtksourcetag.c | 7 +++----
gtksourceview/gtksourceview.c | 7 +++----
gtksourceview/gtksourcevimimcontext.c | 6 +++---
48 files changed, 143 insertions(+), 180 deletions(-)
---
diff --git a/gtksourceview/completion-providers/snippets/gtksourcecompletionsnippets.c
b/gtksourceview/completion-providers/snippets/gtksourcecompletionsnippets.c
index 1f077946..86e6bebf 100644
--- a/gtksourceview/completion-providers/snippets/gtksourcecompletionsnippets.c
+++ b/gtksourceview/completion-providers/snippets/gtksourcecompletionsnippets.c
@@ -36,9 +36,9 @@
#include "gtksourcecompletionsnippetsproposal-private.h"
/**
- * SECTION:completionsnippets
- * @title: GtkSourceCompletionSnippets
- * @short_description: A GtkSourceCompletionProvider for the completion of snippets
+ * GtkSourceCompletionSnippets:
+ *
+ * A GtkSourceCompletionProvider for the completion of snippets.
*
* The #GtkSourceCompletionSnippets is an example of an implementation of
* the #GtkSourceCompletionProvider interface. The proposals are snippets
diff --git a/gtksourceview/completion-providers/words/gtksourcecompletionwords.c
b/gtksourceview/completion-providers/words/gtksourcecompletionwords.c
index 0b2a6177..73e796bb 100644
--- a/gtksourceview/completion-providers/words/gtksourcecompletionwords.c
+++ b/gtksourceview/completion-providers/words/gtksourcecompletionwords.c
@@ -20,9 +20,9 @@
*/
/**
- * SECTION:completionwords
- * @title: GtkSourceCompletionWords
- * @short_description: A GtkSourceCompletionProvider for the completion of words
+ * GtkSourceCompletionWords:
+ *
+ * A GtkSourceCompletionProvider for the completion of words.
*
* The #GtkSourceCompletionWords is an example of an implementation of
* the #GtkSourceCompletionProvider interface. The proposals are words
diff --git a/gtksourceview/gtksourcebindinggroup.c b/gtksourceview/gtksourcebindinggroup.c
index 2d4f90b5..ddf94582 100644
--- a/gtksourceview/gtksourcebindinggroup.c
+++ b/gtksourceview/gtksourcebindinggroup.c
@@ -27,9 +27,9 @@
#include "gtksourcebindinggroup-private.h"
/*
- * SECTION:gtksourcebindinggroup:
- * @title: GtkSourceBindingGroup
- * @short_description: Binding multiple properties as a group
+ * GtkSourceBindingGroup:
+ *
+ * Binding multiple properties as a group.
*
* The #GtkSourceBindingGroup can be used to bind multiple properties
* from an object collectively.
diff --git a/gtksourceview/gtksourcebuffer.c b/gtksourceview/gtksourcebuffer.c
index 6f1a8a41..e2b384f2 100644
--- a/gtksourceview/gtksourcebuffer.c
+++ b/gtksourceview/gtksourcebuffer.c
@@ -44,10 +44,9 @@
#include "gtksourcetrace.h"
/**
- * SECTION:buffer
- * @Short_description: Subclass of #GtkTextBuffer
- * @Title: GtkSourceBuffer
- * @See_also: #GtkTextBuffer, #GtkSourceView
+ * GtkSourceBuffer:
+ *
+ * Subclass of #GtkTextBuffer.
*
* A #GtkSourceBuffer object is the model for #GtkSourceView widgets.
* It extends the #GtkTextBuffer class by adding features useful to display
diff --git a/gtksourceview/gtksourcecompletion.c b/gtksourceview/gtksourcecompletion.c
index 5f305f34..3427f3af 100644
--- a/gtksourceview/gtksourcecompletion.c
+++ b/gtksourceview/gtksourcecompletion.c
@@ -35,9 +35,9 @@
#include "gtksourceview-private.h"
/**
- * SECTION:completion
- * @title: GtkSourceCompletion
- * @short_description: Main Completion Object
+ * GtkSourceCompletion:
+ *
+ * Main Completion Object.
*
* The completion system helps the user when they writes some text,
* such as words, command names, functions, and suchlike. Proposals can
diff --git a/gtksourceview/gtksourcecompletioncell.c b/gtksourceview/gtksourcecompletioncell.c
index e5e67781..cad05cfe 100644
--- a/gtksourceview/gtksourcecompletioncell.c
+++ b/gtksourceview/gtksourcecompletioncell.c
@@ -25,9 +25,9 @@
#include "gtksourcecompletioncell-private.h"
/**
- * SECTION:completioncell
- * @title: GtkSourceCompletionCell
- * @short_description: widget for single cell of completion proposal
+ * GtkSourceCompletionCell:
+ *
+ * Widget for single cell of completion proposal.
*
* The #GtkSourceCompletionCell widget provides a container to display various
* types of information with the completion display.
diff --git a/gtksourceview/gtksourcecompletioncontext.c b/gtksourceview/gtksourcecompletioncontext.c
index 686bc05e..f6fe6df1 100644
--- a/gtksourceview/gtksourcecompletioncontext.c
+++ b/gtksourceview/gtksourcecompletioncontext.c
@@ -32,11 +32,9 @@
#include "gtksourcecompletionprovider.h"
/**
- * SECTION:completioncontext
- * @Title: GtkSourceCompletionContext
- * @Short_description: The context of a completion
- * @See_also: #GtkSourceCompletion, #GtkSourceCompletionProvider, and
- * #GtkSourceCompletionProposal.
+ * GtkSourceCompletionContext:
+ *
+ * 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.
diff --git a/gtksourceview/gtksourcecompletionproposal.c b/gtksourceview/gtksourcecompletionproposal.c
index 7b613ff5..ef5d18f0 100644
--- a/gtksourceview/gtksourcecompletionproposal.c
+++ b/gtksourceview/gtksourcecompletionproposal.c
@@ -24,9 +24,9 @@
#include "gtksourcecompletionproposal.h"
/**
- * SECTION:completionproposal
- * @Title: GtkSourceCompletionProposal
- * @Short_description: interface for completion proposals
+ * GtkSourceCompletionProposal:
+ *
+ * Interface for completion proposals.
*
* This interface is used to denote that an object is capable of being
* a completion proposal for #GtkSourceCompletion.
diff --git a/gtksourceview/gtksourcecompletionprovider.c b/gtksourceview/gtksourcecompletionprovider.c
index 401f52d0..07eeb4bc 100644
--- a/gtksourceview/gtksourcecompletionprovider.c
+++ b/gtksourceview/gtksourcecompletionprovider.c
@@ -27,9 +27,9 @@
#include "gtksourcecompletionprovider.h"
/**
- * SECTION:completionprovider
- * @title: GtkSourceCompletionProvider
- * @short_description: Completion provider interface
+ * GtkSourceCompletionProvider:
+ *
+ * Completion provider interface.
*
* You must implement this interface to provide proposals to #GtkSourceCompletion
*
diff --git a/gtksourceview/gtksourceencoding.c b/gtksourceview/gtksourceencoding.c
index 520f966e..8b53b2f6 100644
--- a/gtksourceview/gtksourceencoding.c
+++ b/gtksourceview/gtksourceencoding.c
@@ -25,10 +25,9 @@
#include <glib/gi18n-lib.h>
/**
- * SECTION:encoding
- * @Short_description: Character encoding
- * @Title: GtkSourceEncoding
- * @See_also: #GtkSourceFileSaver, #GtkSourceFileLoader
+ * GtkSourceEncoding:
+ *
+ * Character encoding.
*
* The #GtkSourceEncoding boxed type represents a character encoding. It is used
* for example by #GtkSourceFile. Note that the text in GTK+ widgets is always
diff --git a/gtksourceview/gtksourcefile.c b/gtksourceview/gtksourcefile.c
index 3be80460..2cbd7bb6 100644
--- a/gtksourceview/gtksourcefile.c
+++ b/gtksourceview/gtksourcefile.c
@@ -24,10 +24,9 @@
#include "gtksource-enumtypes.h"
/**
- * SECTION:file
- * @Short_description: On-disk representation of a GtkSourceBuffer
- * @Title: GtkSourceFile
- * @See_also: #GtkSourceFileLoader, #GtkSourceFileSaver
+ * GtkSourceFile:
+ *
+ * On-disk representation of a GtkSourceBuffer.
*
* A #GtkSourceFile object is the on-disk representation of a #GtkSourceBuffer.
* With a #GtkSourceFile, you can create and configure a #GtkSourceFileLoader
diff --git a/gtksourceview/gtksourcefileloader.c b/gtksourceview/gtksourcefileloader.c
index 75763604..0ab38aa4 100644
--- a/gtksourceview/gtksourcefileloader.c
+++ b/gtksourceview/gtksourcefileloader.c
@@ -33,10 +33,9 @@
#include "gtksource-enumtypes.h"
/**
- * SECTION:fileloader
- * @Short_description: Load a file into a GtkSourceBuffer
- * @Title: GtkSourceFileLoader
- * @See_also: #GtkSourceFile, #GtkSourceFileSaver
+ * GtkSourceFileLoader:
+ *
+ * Load a file into a GtkSourceBuffer.
*
* A #GtkSourceFileLoader object permits to load the contents of a #GFile or a
* #GInputStream into a #GtkSourceBuffer.
diff --git a/gtksourceview/gtksourcefilesaver.c b/gtksourceview/gtksourcefilesaver.c
index 4c92f7ac..88adc532 100644
--- a/gtksourceview/gtksourcefilesaver.c
+++ b/gtksourceview/gtksourcefilesaver.c
@@ -33,10 +33,9 @@
#include "gtksource-enumtypes.h"
/**
- * SECTION:filesaver
- * @Short_description: Save a GtkSourceBuffer into a file
- * @Title: GtkSourceFileSaver
- * @See_also: #GtkSourceFile, #GtkSourceFileLoader
+ * GtkSourceFileSaver:
+ *
+ * Save a GtkSourceBuffer into a file.
*
* A #GtkSourceFileSaver object permits to save a #GtkSourceBuffer into a
* #GFile.
diff --git a/gtksourceview/gtksourcegutter.c b/gtksourceview/gtksourcegutter.c
index 23609eff..e88a27d8 100644
--- a/gtksourceview/gtksourcegutter.c
+++ b/gtksourceview/gtksourcegutter.c
@@ -31,10 +31,9 @@
#include "gtksourcegutterrenderer-private.h"
/**
- * SECTION:gutter
- * @Short_description: Gutter object for GtkSourceView
- * @Title: GtkSourceGutter
- * @See_also: #GtkSourceView, #GtkSourceMark
+ * GtkSourceGutter:
+ *
+ * Gutter object for GtkSourceView.
*
* The #GtkSourceGutter object represents the left or right gutter of the text
* view. It is used by #GtkSourceView to draw the line numbers and
diff --git a/gtksourceview/gtksourcegutterlines.c b/gtksourceview/gtksourcegutterlines.c
index c43b0a42..5a805377 100644
--- a/gtksourceview/gtksourcegutterlines.c
+++ b/gtksourceview/gtksourcegutterlines.c
@@ -25,9 +25,9 @@
#include "quarkset-inline.h"
/**
- * SECTION:gutterlines
- * @title: GtkSourceGutterLines
- * @short_description: Collected information about visible lines
+ * GtkSourceGutterLines:
+ *
+ * Collected information about visible lines.
*
* The #GtkSourceGutterLines object is used to collect information about
* visible lines.
diff --git a/gtksourceview/gtksourcegutterrenderer.c b/gtksourceview/gtksourcegutterrenderer.c
index ec7e66f2..eb92e171 100644
--- a/gtksourceview/gtksourcegutterrenderer.c
+++ b/gtksourceview/gtksourcegutterrenderer.c
@@ -31,10 +31,9 @@
#include "gtksource-marshal.h"
/**
- * SECTION:gutterrenderer
- * @Short_description: Gutter cell renderer
- * @Title: GtkSourceGutterRenderer
- * @See_also: #GtkSourceGutter
+ * GtkSourceGutterRenderer:
+ *
+ * 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
diff --git a/gtksourceview/gtksourcegutterrendererpixbuf.c b/gtksourceview/gtksourcegutterrendererpixbuf.c
index a0562d94..8a6fba88 100644
--- a/gtksourceview/gtksourcegutterrendererpixbuf.c
+++ b/gtksourceview/gtksourcegutterrendererpixbuf.c
@@ -23,10 +23,9 @@
#include "gtksourcepixbufhelper-private.h"
/**
- * SECTION:gutterrendererpixbuf
- * @Short_description: Renders a pixbuf in the gutter
- * @Title: GtkSourceGutterRendererPixbuf
- * @See_also: #GtkSourceGutterRenderer, #GtkSourceGutter
+ * GtkSourceGutterRendererPixbuf:
+ *
+ * Renders a pixbuf in the gutter.
*
* A #GtkSourceGutterRendererPixbuf can be used to render an image in a cell of
* #GtkSourceGutter.
diff --git a/gtksourceview/gtksourcegutterrenderertext.c b/gtksourceview/gtksourcegutterrenderertext.c
index 103fe989..d0052014 100644
--- a/gtksourceview/gtksourcegutterrenderertext.c
+++ b/gtksourceview/gtksourcegutterrenderertext.c
@@ -22,10 +22,9 @@
#include "gtksourcegutterrenderertext.h"
/**
- * SECTION:gutterrenderertext
- * @Short_description: Renders text in the gutter
- * @Title: GtkSourceGutterRendererText
- * @See_also: #GtkSourceGutterRenderer, #GtkSourceGutter
+ * GtkSourceGutterRendererText:
+ *
+ * Renders text in the gutter.
*
* A #GtkSourceGutterRendererText can be used to render text in a cell of
* #GtkSourceGutter.
diff --git a/gtksourceview/gtksourcehover.c b/gtksourceview/gtksourcehover.c
index 36e26826..237f4e00 100644
--- a/gtksourceview/gtksourcehover.c
+++ b/gtksourceview/gtksourcehover.c
@@ -33,11 +33,9 @@
#define DEFAULT_HOVER_DELAY 500
/**
- * SECTION:hover
- * @Title: GtkSourceHover
- * @Short_description: Interactive tooltips
- * @See_also: #GtkSourceHoverProvider, #GtkSourceHoverDisplay, and
- * #GtkSourceHoverContext.
+ * GtkSourceHover:
+ *
+ * Interactive tooltips.
*
* #GtkSourceHover allows a #GtkSourceView to provide contextual information.
* When enabled, if the user hovers over a word in the text editor, a series
diff --git a/gtksourceview/gtksourcehovercontext.c b/gtksourceview/gtksourcehovercontext.c
index a7eb79f4..2fb98ade 100644
--- a/gtksourceview/gtksourcehovercontext.c
+++ b/gtksourceview/gtksourcehovercontext.c
@@ -28,10 +28,9 @@
#include "gtksourceview.h"
/**
- * SECTION:hovercontext
- * @Title: GtkSourceHoverContext
- * @Short_description: Context for populating #GtkSourceHoverDisplay contents
- * @See_also: #GtkSourceHover, #GtkSourceHoverProvider, #GtkSourceHoverDisplay
+ * GtkSourceHoverContext:
+ *
+ * Context for populating #GtkSourceHoverDisplay contents.
*
* #GtkSourceHoverContext contains information about the request to populate
* contents for a #GtkSourceHoverDisplay.
diff --git a/gtksourceview/gtksourcehoverdisplay.c b/gtksourceview/gtksourcehoverdisplay.c
index 1938acfd..7f704338 100644
--- a/gtksourceview/gtksourcehoverdisplay.c
+++ b/gtksourceview/gtksourcehoverdisplay.c
@@ -24,10 +24,9 @@
#include "gtksourcehoverdisplay-private.h"
/**
- * SECTION:hoverdisplay
- * @Title: GtkSourceHoverDisplay
- * @Short_description: display for interactive tooltips
- * @See_also: #GtkSourceHoverProvider
+ * GtkSourceHoverDisplay:
+ *
+ * Display for interactive tooltips.
*
* #GtkSourceHoverDisplay is a #GtkWidget that may be populated with widgets
* to be displayed to the user in interactive tooltips. The children widgets
diff --git a/gtksourceview/gtksourcehoverprovider.c b/gtksourceview/gtksourcehoverprovider.c
index 9ff3a80a..e22e9ed4 100644
--- a/gtksourceview/gtksourcehoverprovider.c
+++ b/gtksourceview/gtksourcehoverprovider.c
@@ -26,10 +26,9 @@
#include "gtksourcehoverprovider.h"
/**
- * SECTION:hoverprovider
- * @Title: GtkSourceHoverProvider
- * @Short_description: interface to populate interactive tooltips
- * @See_also: #GtkSourceHover, #GtkSourceHoverDisplay, #GtkSourceHoverContext
+ * GtkSourceHoverProvider:
+ *
+ * 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
diff --git a/gtksourceview/gtksourceindenter.c b/gtksourceview/gtksourceindenter.c
index ae8ae156..ffefa7e7 100644
--- a/gtksourceview/gtksourceindenter.c
+++ b/gtksourceview/gtksourceindenter.c
@@ -25,10 +25,9 @@
#include "gtksourceview.h"
/**
- * SECTION:indenter
- * @Title: GtkSourceIndenter
- * @Short_description: Auto-indentation interface
- * @See_also: gtk_source_view_set_indenter()
+ * GtkSourceIndenter:
+ *
+ * Auto-indentation interface.
*
* By default, #GtkSourceView can auto-indent as you type when
* #GtkSourceView:auto-indent is enabled. The indentation simply copies the
diff --git a/gtksourceview/gtksourcelanguage.c b/gtksourceview/gtksourcelanguage.c
index 93706286..999474ca 100644
--- a/gtksourceview/gtksourcelanguage.c
+++ b/gtksourceview/gtksourcelanguage.c
@@ -38,10 +38,9 @@
#endif
/**
- * SECTION:language
- * @Short_description: Represents a syntax highlighted language
- * @Title: GtkSourceLanguage
- * @See_also: #GtkSourceLanguageManager
+ * GtkSourceLanguage:
+ *
+ * Represents a syntax highlighted language.
*
* A #GtkSourceLanguage represents a programming or markup language, affecting
* syntax highlighting and [context classes][context-classes].
diff --git a/gtksourceview/gtksourcelanguagemanager.c b/gtksourceview/gtksourcelanguagemanager.c
index e6ea9b18..81557b63 100644
--- a/gtksourceview/gtksourcelanguagemanager.c
+++ b/gtksourceview/gtksourcelanguagemanager.c
@@ -28,10 +28,9 @@
#include "gtksourceutils-private.h"
/**
- * SECTION:languagemanager
- * @Short_description: Provides access to GtkSourceLanguages
- * @Title: GtkSourceLanguageManager
- * @See_also: #GtkSourceLanguage
+ * GtkSourceLanguageManager:
+ *
+ * Provides access to GtkSourceLanguages.
*
* #GtkSourceLanguageManager is an object which processes language description
* files and creates and stores #GtkSourceLanguage objects, and provides API to
diff --git a/gtksourceview/gtksourcemap.c b/gtksourceview/gtksourcemap.c
index ccc7d5d5..2c619208 100644
--- a/gtksourceview/gtksourcemap.c
+++ b/gtksourceview/gtksourcemap.c
@@ -39,10 +39,9 @@
#define DRAG_THRESHOLD 5.0
/**
- * SECTION:map
- * @Short_description: Widget that displays a map for a specific #GtkSourceView
- * @Title: GtkSourceMap
- * @See_also: #GtkSourceView
+ * GtkSourceMap:
+ *
+ * Widget that displays a map for a specific #GtkSourceView.
*
* #GtkSourceMap is a widget that maps the content of a #GtkSourceView into
* a smaller view so the user can have a quick overview of the whole document.
diff --git a/gtksourceview/gtksourcemark.c b/gtksourceview/gtksourcemark.c
index 5a5970e0..9b82ef1a 100644
--- a/gtksourceview/gtksourcemark.c
+++ b/gtksourceview/gtksourcemark.c
@@ -24,10 +24,9 @@
#include "gtksourcebuffer-private.h"
/**
- * SECTION:mark
- * @Short_description: Mark object for GtkSourceBuffer
- * @Title: GtkSourceMark
- * @See_also: #GtkSourceBuffer
+ * GtkSourceMark:
+ *
+ * Mark object for GtkSourceBuffer.
*
* 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
diff --git a/gtksourceview/gtksourcemarkattributes.c b/gtksourceview/gtksourcemarkattributes.c
index 915ce247..fe75a963 100644
--- a/gtksourceview/gtksourcemarkattributes.c
+++ b/gtksourceview/gtksourcemarkattributes.c
@@ -26,10 +26,8 @@
#include "gtksourcepixbufhelper-private.h"
/**
- * SECTION:markattributes
- * @short_description: The source mark attributes object
- * @title: GtkSourceMarkAttributes
- * @see_also: #GtkSourceMark
+ * GtkSourceMarkAttributes:
+ * The source mark attributes object.
*
* #GtkSourceMarkAttributes is an object specifying attributes used by
* a #GtkSourceView to visually show lines marked with #GtkSourceMark<!-- -->s
diff --git a/gtksourceview/gtksourceprintcompositor.c b/gtksourceview/gtksourceprintcompositor.c
index 9221e0a3..85b05bbe 100644
--- a/gtksourceview/gtksourceprintcompositor.c
+++ b/gtksourceview/gtksourceprintcompositor.c
@@ -33,9 +33,9 @@
#include "gtksourcetrace.h"
/**
- * SECTION:printcompositor
- * @Short_description: Compose a GtkSourceBuffer for printing
- * @Title: GtkSourcePrintCompositor
+ * GtkSourcePrintCompositor:
+ *
+ * Compose a GtkSourceBuffer for printing.
*
* The #GtkSourcePrintCompositor object is used to compose a #GtkSourceBuffer
* for printing. You can set various configuration options to customize the
diff --git a/gtksourceview/gtksourceregion.c b/gtksourceview/gtksourceregion.c
index 4d5413e1..91fc6af4 100644
--- a/gtksourceview/gtksourceregion.c
+++ b/gtksourceview/gtksourceregion.c
@@ -23,10 +23,9 @@
#include "gtksourceregion.h"
/**
- * SECTION:region
- * @Short_description: Region utility
- * @Title: GtkSourceRegion
- * @See_also: #GtkTextBuffer
+ * GtkSourceRegion:
+ *
+ * Region utility.
*
* A #GtkSourceRegion permits to store a group of subregions of a
* #GtkTextBuffer. #GtkSourceRegion stores the subregions with pairs of
diff --git a/gtksourceview/gtksourcesearchcontext.c b/gtksourceview/gtksourcesearchcontext.c
index 0847cbb8..9a2448d9 100644
--- a/gtksourceview/gtksourcesearchcontext.c
+++ b/gtksourceview/gtksourcesearchcontext.c
@@ -36,10 +36,9 @@
#include "implregex-private.h"
/**
- * SECTION:searchcontext
- * @Short_description: Search context
- * @Title: GtkSourceSearchContext
- * @See_also: #GtkSourceBuffer, #GtkSourceSearchSettings
+ * GtkSourceSearchContext:
+ *
+ * Search context.
*
* A #GtkSourceSearchContext is used for the search and replace in a
* #GtkSourceBuffer. The search settings are represented by a
diff --git a/gtksourceview/gtksourcesearchsettings.c b/gtksourceview/gtksourcesearchsettings.c
index 25504c33..8a5beb12 100644
--- a/gtksourceview/gtksourcesearchsettings.c
+++ b/gtksourceview/gtksourcesearchsettings.c
@@ -22,10 +22,9 @@
#include "gtksourcesearchsettings.h"
/**
- * SECTION:searchsettings
- * @Short_description: Search settings
- * @Title: GtkSourceSearchSettings
- * @See_also: #GtkSourceSearchContext
+ * GtkSourceSearchSettings:
+ *
+ * Search settings.
*
* A #GtkSourceSearchSettings object represents the settings of a search. The
* search settings can be associated with one or several
diff --git a/gtksourceview/gtksourcesignalgroup.c b/gtksourceview/gtksourcesignalgroup.c
index 637eb1f7..5c99d713 100644
--- a/gtksourceview/gtksourcesignalgroup.c
+++ b/gtksourceview/gtksourcesignalgroup.c
@@ -26,9 +26,9 @@
#include "gtksourcesignalgroup-private.h"
/*
- * SECTION:gtksourcesignalgroup
- * @title: GtkSourceSignalGroup
- * @short_description: Manage a collection of signals on a #GObject
+ * GtkSourceSignalGroup:
+ *
+ * Manage a collection of signals on a #GObject.
*
* #GtkSourceSignalGroup manages to simplify the process of connecting
* many signals to a #GObject as a group. As such there is no API
diff --git a/gtksourceview/gtksourcesnippet.c b/gtksourceview/gtksourcesnippet.c
index e2dc1859..fed47a62 100644
--- a/gtksourceview/gtksourcesnippet.c
+++ b/gtksourceview/gtksourcesnippet.c
@@ -28,10 +28,9 @@
#include "gtksourcesnippetcontext-private.h"
/**
- * SECTION:snippet
- * @title: GtkSourceSnippet
- * @short_description: Quick insertion code snippets
- * @see_also: #GtkSourceSnippetChunk, #GtkSourceSnippetContext, #GtkSourceSnippetManager
+ * GtkSourceSnippet:
+ *
+ * Quick insertion code snippets.
*
* The #GtkSourceSnippet represents a series of chunks that can quickly be
* inserted into the #GtkSourceView.
diff --git a/gtksourceview/gtksourcesnippetchunk.c b/gtksourceview/gtksourcesnippetchunk.c
index 6a9d2ae3..911215ea 100644
--- a/gtksourceview/gtksourcesnippetchunk.c
+++ b/gtksourceview/gtksourcesnippetchunk.c
@@ -23,9 +23,9 @@
#include "gtksourcesnippetcontext.h"
/**
- * SECTION:snippetchunk
- * @title: GtkSourceSnippetChunk
- * @short_description: An chunk of text within the source snippet
+ * GtkSourceSnippetChunk:
+ *
+ * A chunk of text within the source snippet.
*
* The #GtkSourceSnippetChunk represents a single chunk of text that
* may or may not be an edit point within the snippet. Chunks that are
diff --git a/gtksourceview/gtksourcesnippetcontext.c b/gtksourceview/gtksourcesnippetcontext.c
index 3064c73f..5c581a0b 100644
--- a/gtksourceview/gtksourcesnippetcontext.c
+++ b/gtksourceview/gtksourcesnippetcontext.c
@@ -26,9 +26,9 @@
#include "gtksourcesnippetcontext-private.h"
/**
- * SECTION:snippetcontext
- * @title: GtkSourceSnippetContext
- * @short_description: Context for expanding #GtkSourceSnippetChunk
+ * GtkSourceSnippetContext:
+ *
+ * Context for expanding #GtkSourceSnippetChunk.
*
* 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
diff --git a/gtksourceview/gtksourcesnippetmanager.c b/gtksourceview/gtksourcesnippetmanager.c
index 770867dd..c5d81983 100644
--- a/gtksourceview/gtksourcesnippetmanager.c
+++ b/gtksourceview/gtksourcesnippetmanager.c
@@ -25,10 +25,9 @@
#include "gtksourceutils-private.h"
/**
- * SECTION:snippetmanager
- * @title: GtkSourceSnippetManager
- * @short_description: Provides access to #GtkSourceSnippet
- * @see_also: #GtkSourceSnippet
+ * GtkSourceSnippetManager:
+ *
+ * Provides access to #GtkSourceSnippet.
*
* #GtkSourceSnippetManager is an object which processes snippet description
* files and creates #GtkSourceSnippet objects.
diff --git a/gtksourceview/gtksourcespacedrawer.c b/gtksourceview/gtksourcespacedrawer.c
index 84d7ba76..f4eb83b5 100644
--- a/gtksourceview/gtksourcespacedrawer.c
+++ b/gtksourceview/gtksourcespacedrawer.c
@@ -36,10 +36,9 @@
#include "gtksourceview.h"
/**
- * SECTION:spacedrawer
- * @Short_description: Represent white space characters with symbols
- * @Title: GtkSourceSpaceDrawer
- * @See_also: #GtkSourceView
+ * GtkSourceSpaceDrawer:
+ *
+ * Represent white space characters with symbols.
*
* #GtkSourceSpaceDrawer provides a way to visualize white spaces, by drawing
* symbols.
diff --git a/gtksourceview/gtksourcestyle.c b/gtksourceview/gtksourcestyle.c
index 92567652..ea8d2737 100644
--- a/gtksourceview/gtksourcestyle.c
+++ b/gtksourceview/gtksourcestyle.c
@@ -23,10 +23,9 @@
#include "gtksourcestyle-private.h"
/**
- * SECTION:style
- * @Short_description: Represents a style
- * @Title: GtkSourceStyle
- * @See_also: #GtkSourceStyleScheme, #GtkSourceStyleSchemeManager
+ * GtkSourceStyle:
+ *
+ * Represents a style.
*
* The #GtkSourceStyle structure is used to describe text attributes
* which are set when given style is used.
diff --git a/gtksourceview/gtksourcestylescheme.c b/gtksourceview/gtksourcestylescheme.c
index 92028fe6..5c810e43 100644
--- a/gtksourceview/gtksourcestylescheme.c
+++ b/gtksourceview/gtksourcestylescheme.c
@@ -32,10 +32,9 @@
#include "gtksourcelanguage-private.h"
/**
- * SECTION:stylescheme
- * @Short_description: Controls the appearance of GtkSourceView
- * @Title: GtkSourceStyleScheme
- * @See_also: #GtkSourceStyle, #GtkSourceStyleSchemeManager
+ * GtkSourceStyleScheme:
+ *
+ * Controls the appearance of GtkSourceView.
*
* #GtkSourceStyleScheme contains all the text styles to be used in
* #GtkSourceView and #GtkSourceBuffer. For instance, it contains text styles
diff --git a/gtksourceview/gtksourcestyleschemechooser.c b/gtksourceview/gtksourcestyleschemechooser.c
index 2d7230a4..f98facd9 100644
--- a/gtksourceview/gtksourcestyleschemechooser.c
+++ b/gtksourceview/gtksourcestyleschemechooser.c
@@ -23,10 +23,9 @@
#include "gtksourcestylescheme.h"
/**
- * SECTION:styleschemechooser
- * @Short_description: Interface implemented by widgets for choosing style schemes
- * @Title: GtkSourceStyleSchemeChooser
- * @See_also: #GtkSourceStyleSchemeChooserWidget, #GtkSourceStyleSchemeChooserButton
+ * GtkSourceStyleSchemeChooser:
+ *
+ * Interface implemented by widgets for choosing style schemes.
*
* #GtkSourceStyleSchemeChooser is an interface that is implemented by widgets
* for choosing style schemes.
diff --git a/gtksourceview/gtksourcestyleschemechooserbutton.c
b/gtksourceview/gtksourcestyleschemechooserbutton.c
index 6b14921e..db6e64c5 100644
--- a/gtksourceview/gtksourcestyleschemechooserbutton.c
+++ b/gtksourceview/gtksourcestyleschemechooserbutton.c
@@ -28,10 +28,9 @@
#include "gtksourcestylescheme-private.h"
/**
- * SECTION:styleschemechooserbutton
- * @Short_description: A button to launch a style scheme selection dialog
- * @Title: GtkSourceStyleSchemeChooserButton
- * @See_also: #GtkSourceStyleSchemeChooserWidget
+ * GtkSourceStyleSchemeChooserButton:
+ *
+ * A button to launch a style scheme selection dialog.
*
* The #GtkSourceStyleSchemeChooserButton is a button which displays
* the currently selected style scheme and allows to open a style scheme
diff --git a/gtksourceview/gtksourcestyleschemechooserwidget.c
b/gtksourceview/gtksourcestyleschemechooserwidget.c
index dad9c632..b8055809 100644
--- a/gtksourceview/gtksourcestyleschemechooserwidget.c
+++ b/gtksourceview/gtksourcestyleschemechooserwidget.c
@@ -31,10 +31,9 @@
#include "gtksourceview.h"
/**
- * SECTION:styleschemechooserwidget
- * @Short_description: A widget for choosing style schemes
- * @Title: GtkSourceStyleSchemeChooserWidget
- * @See_also: #GtkSourceStyleSchemeChooserButton
+ * GtkSourceStyleSchemeChooserWidget:
+ *
+ * A widget for choosing style schemes.
*
* The #GtkSourceStyleSchemeChooserWidget widget lets the user select a
* style scheme. By default, the chooser presents a predefined list
diff --git a/gtksourceview/gtksourcestyleschememanager.c b/gtksourceview/gtksourcestyleschememanager.c
index cc5d7fbf..6d8aef54 100644
--- a/gtksourceview/gtksourcestyleschememanager.c
+++ b/gtksourceview/gtksourcestyleschememanager.c
@@ -26,10 +26,9 @@
#include "gtksourceutils-private.h"
/**
- * SECTION:styleschememanager
- * @Short_description: Provides access to GtkSourceStyleSchemes
- * @Title: GtkSourceStyleSchemeManager
- * @See_also: #GtkSourceStyleScheme
+ * GtkSourceStyleSchemeManager:
+ *
+ * Provides access to GtkSourceStyleSchemes.
*
* Object which provides access to #GtkSourceStyleScheme<!-- -->s.
*/
diff --git a/gtksourceview/gtksourcestyleschemepreview.c b/gtksourceview/gtksourcestyleschemepreview.c
index dd1ab4ad..1ec4cbcb 100644
--- a/gtksourceview/gtksourcestyleschemepreview.c
+++ b/gtksourceview/gtksourcestyleschemepreview.c
@@ -36,9 +36,9 @@
#include "gtksourceview.h"
/**
- * SECTION:styleschemepreview
- * @title: GtkSourceStyleSchemePreview
- * @short_description: a preview widget for #GtkSourceStyleScheme
+ * GtkSourceStyleSchemePreview:
+ *
+ * A preview widget for #GtkSourceStyleScheme.
*
* This widget provides a convenient #GtkWidget to preview a #GtkSourceStyleScheme.
*
diff --git a/gtksourceview/gtksourcetag.c b/gtksourceview/gtksourcetag.c
index 96e40fea..5f9fe955 100644
--- a/gtksourceview/gtksourcetag.c
+++ b/gtksourceview/gtksourcetag.c
@@ -24,10 +24,9 @@
#include "gtksourcetag.h"
/**
- * SECTION:tag
- * @Short_description: A tag that can be applied to text in a GtkSourceBuffer
- * @Title: GtkSourceTag
- * @See_also: #GtkSourceBuffer
+ * GtkSourceTag:
+ *
+ * A tag that can be applied to text in a GtkSourceBuffer.
*
* #GtkSourceTag is a subclass of #GtkTextTag that adds properties useful for
* the GtkSourceView library.
diff --git a/gtksourceview/gtksourceview.c b/gtksourceview/gtksourceview.c
index 028292a1..3d55e573 100644
--- a/gtksourceview/gtksourceview.c
+++ b/gtksourceview/gtksourceview.c
@@ -57,10 +57,9 @@
#include "gtksourcetrace.h"
/**
- * SECTION:view
- * @Short_description: Subclass of #GtkTextView
- * @Title: GtkSourceView
- * @See_also: #GtkTextView, #GtkSourceBuffer
+ * GtkSourceView:
+ *
+ * Subclass of #GtkTextView.
*
* #GtkSourceView is the main class of the GtkSourceView library.
* Use a #GtkSourceBuffer to display text with a #GtkSourceView.
diff --git a/gtksourceview/gtksourcevimimcontext.c b/gtksourceview/gtksourcevimimcontext.c
index e548c9d5..626f65a6 100644
--- a/gtksourceview/gtksourcevimimcontext.c
+++ b/gtksourceview/gtksourcevimimcontext.c
@@ -29,9 +29,9 @@
#include "vim/gtksourcevimcommand.h"
/**
- * SECTION:vimimcontext
- * @title: GtkSourceVimIMContext
- * @short_description: Vim emulation
+ * GtkSourceVimIMContext:
+ *
+ * Vim emulation.
*
* The #GtkSourceVimIMContext is a #GtkIMContext implementation that can
* be used to provide Vim-like editing controls within a #GtkSourceView.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]