From 9df8c614ddff47edb985e27de7e163122d3c795b Mon Sep 17 00:00:00 2001
From: Christoph Reiter <reiter.christoph@gmail.com>
Date: Sun, 9 Dec 2018 18:04:49 +0100
Subject: docs: fix gtk-doc warnings and update version infos

Move things around and rename things until gtk-doc is happy.

This also moves the "Since" annotations to the next stable releases and
adds version added info for g_callable_info_get_instance_ownership_transfer()
and g_struct_info_find_field().
---
 docs/reference/gi-docs.xml             | 76 ++++++++++------------------------
 docs/reference/gi-gir-reference.xml    | 16 +++----
 docs/reference/gi-sections.txt         | 30 +++++++++++++-
 docs/reference/gi-struct-hierarchy.xml |  2 +-
 4 files changed, 58 insertions(+), 66 deletions(-)

(limited to 'docs')

diff --git a/docs/reference/gi-docs.xml b/docs/reference/gi-docs.xml
index b6bc54f1..352fe7ec 100644
--- a/docs/reference/gi-docs.xml
+++ b/docs/reference/gi-docs.xml
@@ -28,42 +28,6 @@
 
     <xi:include href="xml/overview-building.xml"/>
     <xi:include href="xml/overview-programming.xml"/>
-    <!-- <chapter>
-      <title>Introduction</title>
-
-      <para>
-        Metadata provided by GObject-Introspection is represented by a
-        number of structures:
-        <synopsis>
-        * <link linkend="gi-GIBaseInfo">GIBaseInfo</link>
-          * <link linkend="gi-GICallableInfo">GICallableInfo</link>
-            * <link linkend="gi-GIFunctionInfo">GIFunctionInfo</link>
-            * <link linkend="gi-GISignalInfo">GISignalInfo</link>
-            * <link linkend="gi-GIVFuncInfo">GIVFuncInfo</link>
-          * <link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link>
-            * <link linkend="gi-GIEnumInfo">GIEnumInfo</link>
-            * <link linkend="gi-GIInterfaceInfo">GIInterfaceInfo</link>
-            * <link linkend="gi-GIObjectInfo">GIObjectInfo</link>
-            * <link linkend="gi-GIStructInfo">GIStructInfo</link>
-            * <link linkend="gi-GIUnionInfo">GIUnionInfo</link>
-          * <link linkend="gi-GIArgInfo">GIArgInfo</link>
-          * <link linkend="gi-GIConstantInfo">GIConstantInfo</link>
-          * <link linkend="gi-GIFieldInfo">GIFieldInfo</link>
-          * <link linkend="gi-GIPropertyInfo">GIPropertyInfo</link>
-          * <link linkend="gi-GITypeInfo">GITypeInfo</link>
-        </synopsis>
-      </para>
-    </chapter> -->
-
-<!--
-    <chapter id="tools">
-      <title>GObject Introspection Tools</title>
-
-      &g-ir-scanner;
-      &g-ir-compiler;
-      &g-ir-generator;
-    </chapter>
--->
 
     <para>
       The GObject-Introspection package contains of a few different parts:
@@ -132,11 +96,6 @@
       <xi:include href="xml/girffi.xml"/>
 
       <xi:include href="xml/gi-gir-reference.xml"/>
-      <!--
-      &gi-gir-creating;
-      &gi-gir-parsing;
-      &gi-gir-verifying;
-       -->
     </chapter>
 
   </part>
@@ -149,26 +108,33 @@
     <title>Index of deprecated symbols</title>
     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
   </index>
-  <index id="api-index-1-29-0" role="1.29.0">
-    <title>Index of new symbols in 1.29.0</title>
-    <xi:include href="xml/api-index-1.29.0.xml"><xi:fallback /></xi:include>
-  </index>
-  <index id="api-index-1-29-17" role="1.29.17">
-    <title>Index of new symbols in 1.29.17</title>
-    <xi:include href="xml/api-index-1.29.17.xml"><xi:fallback /></xi:include>
+  <index id="api-index-1-30" role="1.30">
+    <title>Index of new symbols in 1.30</title>
+    <xi:include href="xml/api-index-1.30.xml"><xi:fallback /></xi:include>
   </index>
-  <index id="api-index-1-30-1" role="1.30.1">
-    <title>Index of new symbols in 1.30.1</title>
-    <xi:include href="xml/api-index-1.30.1.xml"><xi:fallback /></xi:include>
+  <index id="api-index-1-32" role="1.32">
+    <title>Index of new symbols in 1.32</title>
+    <xi:include href="xml/api-index-1.32.xml"><xi:fallback /></xi:include>
   </index>
   <index id="api-index-1-34" role="1.34">
     <title>Index of new symbols in 1.34</title>
     <xi:include href="xml/api-index-1.34.xml"><xi:fallback /></xi:include>
   </index>
-  <index id="api-index-1-35-8" role="1.35.8">
-    <title>Index of new symbols in 1.35.8</title>
-    <xi:include href="xml/api-index-1.35.8.xml"><xi:fallback /></xi:include>
+  <index id="api-index-1-36" role="1.36">
+    <title>Index of new symbols in 1.36</title>
+    <xi:include href="xml/api-index-1.36.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-1-42" role="1.42">
+    <title>Index of new symbols in 1.42</title>
+    <xi:include href="xml/api-index-1.42.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-1-44" role="1.44">
+    <title>Index of new symbols in 1.44</title>
+    <xi:include href="xml/api-index-1.44.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-1-46" role="1.46">
+    <title>Index of new symbols in 1.46</title>
+    <xi:include href="xml/api-index-1.46.xml"><xi:fallback /></xi:include>
   </index>
-
   <xi:include href="xml/annotation-glossary.xml" />
 </book>
diff --git a/docs/reference/gi-gir-reference.xml b/docs/reference/gi-gir-reference.xml
index 38604d03..04c85662 100644
--- a/docs/reference/gi-gir-reference.xml
+++ b/docs/reference/gi-gir-reference.xml
@@ -40,8 +40,8 @@
   <refsect2 id="gi-gir-namespace">
     <title><emphasis>namespace</emphasis> node</title>
 
-    Parent node: <link linkend="gi-gir-api">api</link>.
-    Possible children: <link linkend="gi-gir-callback">callback</link>,
+    Parent node: <link linkend="gi-gir-api-node">api</link>.
+    Possible children: callback,
     <link linkend="gi-gir-class">class</link>,
     <link linkend="gi-gir-function">function</link>.
     <link linkend="gi-gir-interface">interface</link>.
@@ -63,9 +63,9 @@
 
     Parent node: <link linkend="gi-gir-namespace">namespace</link>.
     Possible children: <link linkend="gi-gir-class">constructor</link>,
-    <link linkend="gi-gir-field">field</link>,
-    <link linkend="gi-gir-method">method</link>,
-    <link linkend="gi-gir-property">property</link>.
+    field,
+    method,
+    property.
     <example>
     <title>A GIR fragment showing an class node</title>
     <programlisting><![CDATA[
@@ -86,9 +86,9 @@
     <title><emphasis>interface</emphasis> node</title>
 
     Parent node: <link linkend="gi-gir-namespace">namespace</link>.
-    Possible children: <link linkend="gi-gir-field">field</link>,
-    <link linkend="gi-gir-method">method</link>,
-    <link linkend="gi-gir-property">property</link>.
+    Possible children: field,
+    method,
+    property.
     <example>
     <title>A GIR fragment showing an interface node</title>
     <programlisting><![CDATA[
diff --git a/docs/reference/gi-sections.txt b/docs/reference/gi-sections.txt
index 548a5f48..3fe4bea8 100644
--- a/docs/reference/gi-sections.txt
+++ b/docs/reference/gi-sections.txt
@@ -47,10 +47,36 @@ G_IREPOSITORY_GET_CLASS
 GIRepositoryPrivate
 g_irepository_get_type
 g_irepository_error_quark
+GI_AVAILABLE_IN_1_32
+GI_AVAILABLE_IN_1_34
+GI_AVAILABLE_IN_1_36
+GI_AVAILABLE_IN_1_38
+GI_AVAILABLE_IN_1_40
+GI_AVAILABLE_IN_1_42
+GI_AVAILABLE_IN_1_44
+GI_AVAILABLE_IN_1_46
+GI_AVAILABLE_IN_ALL
+GI_DEPRECATED_IN_1_32
+GI_DEPRECATED_IN_1_32_FOR
+GI_DEPRECATED_IN_1_34
+GI_DEPRECATED_IN_1_34_FOR
+GI_DEPRECATED_IN_1_36
+GI_DEPRECATED_IN_1_36_FOR
+GI_DEPRECATED_IN_1_38
+GI_DEPRECATED_IN_1_38_FOR
+GI_DEPRECATED_IN_1_40
+GI_DEPRECATED_IN_1_40_FOR
+GI_DEPRECATED_IN_1_42
+GI_DEPRECATED_IN_1_42_FOR
+GI_DEPRECATED_IN_1_44
+GI_DEPRECATED_IN_1_44_FOR
+GI_DEPRECATED_IN_1_46
+GI_DEPRECATED_IN_1_46_FOR
 </SECTION>
 
 <SECTION>
 <FILE>gibaseinfo</FILE>
+GIBaseInfo
 GIInfoType
 GIAttributeIter
 g_info_new
@@ -68,8 +94,6 @@ g_base_info_is_deprecated
 <SUBSECTION Standard>
 GI_TYPE_BASE_INFO
 g_base_info_gtype_get_type
-<SUBSECTION Private>
-GIBaseInfoStub
 </SECTION>
 
 <SECTION>
@@ -101,6 +125,7 @@ g_callable_info_can_throw_gerror
 g_callable_info_get_n_args
 g_callable_info_get_arg
 g_callable_info_get_caller_owns
+g_callable_info_get_instance_ownership_transfer
 g_callable_info_get_return_attribute
 g_callable_info_get_return_type
 g_callable_info_invoke
@@ -297,6 +322,7 @@ g_signal_info_true_stops_emit
 <FILE>gistructinfo</FILE>
 GI_IS_STRUCT_INFO
 GIStructInfo
+g_struct_info_find_field
 g_struct_info_get_alignment
 g_struct_info_get_size
 g_struct_info_is_gtype_struct
diff --git a/docs/reference/gi-struct-hierarchy.xml b/docs/reference/gi-struct-hierarchy.xml
index 1407485f..fc77c2f8 100644
--- a/docs/reference/gi-struct-hierarchy.xml
+++ b/docs/reference/gi-struct-hierarchy.xml
@@ -19,7 +19,7 @@
 <title role="synopsis.title">Synopsis</title>
 
 <synopsis>
-* <link linkend="gi-GIBaseInfo">GIBaseInfo</link>
+* <link linkend="GIBaseInfo">GIBaseInfo</link>
   * <link linkend="gi-GICallableInfo">GICallableInfo</link>
     * <link linkend="gi-GIFunctionInfo">GIFunctionInfo</link>
     * <link linkend="gi-GISignalInfo">GISignalInfo</link>
-- 
cgit v1.2.1