[sipify] do not copy struct docstrings

qgis · Apr 7, 2017 · 97e2661 · 97e2661
1 parent f82997c
commit 97e2661
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/scripts/sipify.pl b/scripts/sipify.pl
@@ -389,7 +389,7 @@ sub processDoxygenLine
     }
 
     # write comment
-    if ( $line =~ m/^\s*$/ || $line =~ m/\/\// || $line =~ m/\s*typedef / ){
+    if ( $line =~ m/^\s*$/ || $line =~ m/\/\// || $line =~ m/\s*typedef / || $line =~ m/\s*struct / ){
         $comment = '';
     }
     elsif ( $comment !~ m/^\s*$/ ){

diff --git a/tests/scripts/sipifyheader.expected.sip b/tests/scripts/sipifyheader.expected.sip
@@ -69,6 +69,12 @@ class QgsSipifyHeader : QtClass<QVariant>
     };
     typedef QFlags<QgsSipifyHeader::MyEnum> Flags;
 
+    struct Data
+    {
+      QString name;
+      int count;
+    };
+
     explicit QgsSipifyHeader();
 %Docstring
 A constructor with definition in header

diff --git a/tests/scripts/sipifyheader.h b/tests/scripts/sipifyheader.h
@@ -105,6 +105,16 @@ class CORE_EXPORT QgsSipifyHeader : public QtClass<QVariant>, private Ui::QgsBas
     };
     Q_DECLARE_FLAGS( Flags, MyEnum )
 
+    /**
+     * Docstring headers for structs are not supported by sip (as of 4.18) and
+     * therefore this docstring must not to be copied to the sipfile.
+     */
+    struct Data
+    {
+      QString name;
+      int count;
+    };
+
     //! A constructor with definition in header
     explicit QgsSipifyHeader()
       : QtClass<QVariant>()