[pango/gi-docs: 8/13] layout: Move docs into the long description




commit efb1ab55cdf37813be9b35ef1c9bd54204c9128c
Author: Matthias Clasen <mclasen redhat com>
Date:   Thu Feb 4 14:21:22 2021 -0500

    layout: Move docs into the long description
    
    g-ir-scanner picks the long description over the struct
    docs, when the id matches.

 docs/pango-docs.sgml    |  2 +-
 docs/pango-sections.txt |  2 +-
 pango/pango-layout.c    | 13 ++++++-------
 3 files changed, 8 insertions(+), 9 deletions(-)
---
diff --git a/docs/pango-docs.sgml b/docs/pango-docs.sgml
index 2ac4f6df..dc196a63 100644
--- a/docs/pango-docs.sgml
+++ b/docs/pango-docs.sgml
@@ -22,7 +22,7 @@
     <xi:include href="xml/glyphs.xml"/>
     <xi:include href="xml/text-attributes.xml"/>
     <xi:include href="xml/markup.xml"/>
-    <xi:include href="xml/layout.xml"/>
+    <xi:include href="xml/pangolayout.xml"/>
     <xi:include href="xml/scripts.xml"/>
     <xi:include href="xml/bidi.xml"/>
     <xi:include href="xml/vertical.xml"/>
diff --git a/docs/pango-sections.txt b/docs/pango-sections.txt
index 358f5bbf..9d6a80ba 100644
--- a/docs/pango-sections.txt
+++ b/docs/pango-sections.txt
@@ -497,7 +497,7 @@ pango_tab_array_get_type
 
 <SECTION>
 <TITLE>Layout Objects</TITLE>
-<FILE>layout</FILE>
+<FILE>pangolayout</FILE>
 PangoLayout
 PangoLayoutIter
 pango_layout_new
diff --git a/pango/pango-layout.c b/pango/pango-layout.c
index 810dbb61..97f874ac 100644
--- a/pango/pango-layout.c
+++ b/pango/pango-layout.c
@@ -20,7 +20,7 @@
  */
 
 /**
- * SECTION:layout
+ * SECTION:pangolayout
  * @short_description:High-level layout driver objects
  * @title:Layout Objects
  *
@@ -31,10 +31,6 @@
  * high-level driver for formatting entire paragraphs of text
  * at once. This includes paragraph-level functionality such as
  * line-breaking, justification, alignment and ellipsization.
- */
-
-/**
- * PangoLayout:
  *
  * The #PangoLayout structure represents an entire paragraph
  * of text. It is initialized with a #PangoContext, UTF-8 string
@@ -52,9 +48,12 @@
  *
  * It is possible, as well, to ignore the 2-D setup,
  * and simply treat the results of a PangoLayout as a list of lines.
+ */
+
+/**
+ * PangoLayout:
  *
- * The #PangoLayout structure is opaque, and has no user-visible
- * fields.
+ * The #PangoLayout structure is opaque, and has no user-visible fields.
  */
 
 /**


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]