[gtk-doc] mkdb: allow annotations for property and signal docs.



commit 53ead54371bcae7b5a7b1216886eb5ae7d77d293
Author: Stefan Sauer <ensonic users sf net>
Date:   Sat Apr 18 11:27:41 2015 +0200

    mkdb: allow annotations for property and signal docs.
    
    Fixes #727778

 gtkdoc-mkdb.in                          |   45 +++++++++++++++++++++++-------
 tests/annotations/docs/tester-docs.xml  |    2 +-
 tests/gobject/docs-tmpl/tester-docs.xml |    2 +
 tests/gobject/docs/tester-docs.xml      |    2 +
 tests/gobject/src/gobject.c             |    2 +-
 5 files changed, 40 insertions(+), 13 deletions(-)
---
diff --git a/gtkdoc-mkdb.in b/gtkdoc-mkdb.in
index cdfb73c..3d78f32 100755
--- a/gtkdoc-mkdb.in
+++ b/gtkdoc-mkdb.in
@@ -2135,6 +2135,15 @@ sub OutputVariable {
     if (defined ($SymbolDocs{$symbol})) {
         $desc .= &ConvertMarkDown($symbol, $SymbolDocs{$symbol});
     }
+    if (defined ($SymbolAnnotations{$symbol})) {
+        my $param_desc = $SymbolAnnotations{$symbol};
+        my $param_annotations = "";
+        ($param_desc,$param_annotations) = &ExpandAnnotation($symbol, $param_desc);
+        if ($param_annotations ne "") {
+            $desc .= "\n<para>$param_annotations</para>";
+        }
+    }
+
     $desc .= OutputSymbolTraits ($symbol);
     $desc .= "</refsect2>\n";
     return ($synop, $desc);
@@ -2227,18 +2236,15 @@ sub OutputFunction {
     $desc .= &MakeDeprecationNote($symbol);
 
     if (defined ($SymbolDocs{$symbol})) {
-        my $symbol_docs = &ConvertMarkDown($symbol, $SymbolDocs{$symbol});
-        $desc .= $symbol_docs;
+        $desc .= &ConvertMarkDown($symbol, $SymbolDocs{$symbol});
     }
     if (defined ($SymbolAnnotations{$symbol})) {
-      my $param_desc = $SymbolAnnotations{$symbol};
-      my $param_annotations = "";
-      @TRACE@("expand annotation for $symbol: $param_desc");
-      ($param_desc,$param_annotations) = &ExpandAnnotation($symbol, $param_desc);
-      @TRACE@("expanded annotation for $symbol: $param_desc | $param_annotations");
-      if ($param_annotations ne "") {
-         $desc .= "\n<para>$param_annotations</para>";
-      }
+        my $param_desc = $SymbolAnnotations{$symbol};
+        my $param_annotations = "";
+        ($param_desc,$param_annotations) = &ExpandAnnotation($symbol, $param_desc);
+        if ($param_annotations ne "") {
+            $desc .= "\n<para>$param_annotations</para>";
+        }
     }
 
     $desc .= &OutputParamDescriptions ("FUNCTION", $symbol, @fields);
@@ -2839,6 +2845,7 @@ sub ExpandAnnotation {
         $param_desc = $';
 
         @annotations = split(/\)\s*\(/,$1);
+        @TRACE@("annotations for $symbol: '$1'\n");
         foreach $annotation (@annotations) {
             # need to search for the longest key-match in %AnnotationDefinition
             my $match_length=0;
@@ -3659,9 +3666,17 @@ sub GetSignals {
                     $AllDocumentedSymbols{$symbol} = 1;
                 }
             }
+            if (defined ($SymbolAnnotations{$symbol})) {
+                my $param_desc = $SymbolAnnotations{$symbol};
+                my $param_annotations = "";
+                ($param_desc,$param_annotations) = &ExpandAnnotation($symbol, $param_desc);
+                if ($param_annotations ne "") {
+                    $desc .= "\n<para>$param_annotations</para>";
+                }
+            }
             $desc .= &MakeDeprecationNote($symbol);
 
-           $desc .= $parameters;
+            $desc .= $parameters;
             if ($flags_string) {
                 $desc  .= "<para>Flags: $flags_string</para>\n";
             }
@@ -3780,6 +3795,14 @@ sub GetArgs {
 
             $arg_desc .= "<programlisting>  “$name”$pad1 $type_output</programlisting>\n";
             $arg_desc .= $blurb;
+            if (defined ($SymbolAnnotations{$symbol})) {
+                my $param_desc = $SymbolAnnotations{$symbol};
+                my $param_annotations = "";
+                ($param_desc,$param_annotations) = &ExpandAnnotation($symbol, $param_desc);
+                if ($param_annotations ne "") {
+                    $arg_desc .= "\n<para>$param_annotations</para>";
+                }
+            }
             $arg_desc .= &MakeDeprecationNote($symbol);
 
             if ($flags_string) {
diff --git a/tests/annotations/docs/tester-docs.xml b/tests/annotations/docs/tester-docs.xml
index b217fbf..4d3e60e 100644
--- a/tests/annotations/docs/tester-docs.xml
+++ b/tests/annotations/docs/tester-docs.xml
@@ -34,7 +34,7 @@
       <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
     </index>
   
-    <glossary>
+    <glossary id="glossary">
       <title>Glossary</title>
       <glossdiv><title>X</title>
         <glossentry>
diff --git a/tests/gobject/docs-tmpl/tester-docs.xml b/tests/gobject/docs-tmpl/tester-docs.xml
index fc620bf..c832dfb 100644
--- a/tests/gobject/docs-tmpl/tester-docs.xml
+++ b/tests/gobject/docs-tmpl/tester-docs.xml
@@ -98,5 +98,7 @@
         </glossentry>
       </glossdiv>
     </glossary>
+    
+    <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
   </part>
 </book>
diff --git a/tests/gobject/docs/tester-docs.xml b/tests/gobject/docs/tester-docs.xml
index 13883f2..9bbdaaa 100644
--- a/tests/gobject/docs/tester-docs.xml
+++ b/tests/gobject/docs/tester-docs.xml
@@ -111,5 +111,7 @@
         </glossentry>
       </glossdiv>
     </glossary>
+    
+    <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
   </part>
 </book>
diff --git a/tests/gobject/src/gobject.c b/tests/gobject/src/gobject.c
index c34bf55..43f06ee 100644
--- a/tests/gobject/src/gobject.c
+++ b/tests/gobject/src/gobject.c
@@ -352,7 +352,7 @@ static void gtkdoc_object_class_init (GtkdocObjectClass *klass) {
 #endif
 
   /**
-   * GtkdocObject:otest: (type GList(GtkdocObject2j))
+   * GtkdocObject:otest: (type GList(GtkdocObject2))
    *
    * Since: 0.1
    */


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