Remove ingroup and class from doxygen when creating sip docstrings

nyalldawson · nyalldawson · commit 28a57c8f95fc · 2017-04-02T20:30:22.000+10:00
diff --git a/python/core/processing/qgsprocessingfeedback.sip b/python/core/processing/qgsprocessingfeedback.sip
@@ -12,8 +12,6 @@
 class QgsProcessingFeedback : QgsFeedback
 {
 %Docstring
- \class QgsProcessingFeedback
- \ingroup core
  Base class for providing feedback from a processing algorithm.
 
  This base class implementation silently ignores all feedback reported by algorithms.
diff --git a/python/core/processing/qgsprocessingprovider.sip b/python/core/processing/qgsprocessingprovider.sip
@@ -12,8 +12,6 @@
 class QgsProcessingProvider
 {
 %Docstring
- \class QgsProcessingProvider
- \ingroup core
  Abstract base class for processing providers. An algorithm provider is a set of
  related algorithms, typically from the same external application or related
  to a common area of analysis.
diff --git a/python/core/processing/qgsprocessingregistry.sip b/python/core/processing/qgsprocessingregistry.sip
@@ -12,8 +12,6 @@
 class QgsProcessingRegistry : QObject
 {
 %Docstring
- \class QgsProcessingRegistry
- \ingroup core
  Registry for various processing components, including providers, algorithms
  and various parameters and outputs.
 
diff --git a/python/core/qgsactionscope.sip b/python/core/qgsactionscope.sip
@@ -10,7 +10,6 @@
 class QgsActionScope
 {
 %Docstring
- \ingroup core
  An action scope defines a "place" for an action to be shown and may add
  additional expression variables.
  Each QgsAction can be available in one or several action scopes.
diff --git a/python/core/qgsactionscoperegistry.sip b/python/core/qgsactionscoperegistry.sip
@@ -10,7 +10,6 @@
 class QgsActionScopeRegistry : QObject
 {
 %Docstring
- \ingroup core
  The action scope registry is an application wide registry that
  contains a list of available action scopes.
  Some scopes are available by default, additional ones can be registered
diff --git a/python/core/qgsanimatedicon.sip b/python/core/qgsanimatedicon.sip
@@ -11,7 +11,6 @@
 class QgsAnimatedIcon : QObject
 {
 %Docstring
- \ingroup core
  Animated icon is keeping an animation running if there are listeners connected to frameChanged
 %End
 
diff --git a/python/core/qgsfeature.sip b/python/core/qgsfeature.sip
@@ -20,7 +20,6 @@ typedef qint64 QgsFeatureId;
 class QgsFeature
 {
 %Docstring
- \ingroup core
  The feature class encapsulates a single feature including its id,
  geometry and a list of field/values attributes.
  \note QgsFeature objects are implicitly shared.
diff --git a/python/core/qgssettings.sip b/python/core/qgssettings.sip
@@ -12,8 +12,6 @@
 class QgsSettings : QObject
 {
 %Docstring
- \ingroup core
- \class QgsSettings
 
  This class is a composition of two QSettings instances:
  - the main QSettings instance is the standard User Settings and
diff --git a/python/core/qgsvectorlayer.sip b/python/core/qgsvectorlayer.sip
@@ -22,7 +22,6 @@ typedef QList<QgsPointV2> QgsPointSequence;
 class QgsVectorLayer : QgsMapLayer, QgsExpressionContextGenerator
 {
 %Docstring
- \ingroup core
  Represents a vector layer which manages a vector based data sets.
 
  The QgsVectorLayer is instantiated by specifying the name of a data provider,
diff --git a/scripts/sipify.pl b/scripts/sipify.pl
@@ -7,6 +7,17 @@
 # "multiline function signatures"
 # docustrings for QgsFeature::QgsAttributes
 
+sub shouldSkipDoxygenLine
+{
+    do {no warnings 'uninitialized';
+        if ( $_[0] =~ m/[\\@](ingroup|class)/ ) {
+            return 1;
+        }
+        return 0;
+    }
+}
+
+
 my $headerfile = $ARGV[0];
 
 open(my $header, "<", $headerfile) || die "Couldn't open '".$headerfile."' for reading because: ".$!;
@@ -150,12 +161,18 @@
     # Detect comment block
     if ($line =~ m/^\s*\/\*/){
         do {no warnings 'uninitialized';
-            $comment = $line =~ s/^\s*\/\*(\*)?(.*)$/$2/r;
+            if ( !shouldSkipDoxygenLine($line) )
+            {
+                $comment = $line =~ s/^\s*\/\*(\*)?(.*)$/$2/r;
+            }
         };
         $comment =~ s/^\s*$//;
         while(!eof $header){
             $line = readline $header;
-            $comment .= $line =~ s/\s*\*?(.*?)(\/)?$/$1/r;
+            if ( !shouldSkipDoxygenLine($line) )
+            {
+               $comment .= $line =~ s/\s*\*?(.*?)(\/)?$/$1/r;
+            }
             if ( $line =~ m/\*\/$/ ){
                 last;
             }
@@ -167,7 +184,7 @@
 
     # save comments and do not print them, except in SIP_RUN
     if ( $SIP_RUN == 0 ){
-        if ( $line =~ m/^\s*\/\// ){
+        if ( $line =~ m/^\s*\/\// && !shouldSkipDoxygenLine($line) ){
             $line =~ s/^\s*\/\/\!*\s*(.*)\n?$/$1/;
             $comment = $line;
             next;
diff --git a/tests/scripts/sipifyheader.expected.sip b/tests/scripts/sipifyheader.expected.sip
@@ -39,7 +39,6 @@ typedef QVector<QVariant> QgsSuperClass;
 class QgsSipifyHeader : QtClass<QVariant>
 {
 %Docstring
- \ingroup core
  Documentation goes here
 %End
 
@@ -125,6 +124,9 @@ complex default value and type (i.e. containing commas) should be given as a str
 
 class ClassWithPrivateInheritanceOnly
 {
+%Docstring
+ Documentation goes here
+%End
 
 %TypeHeaderCode
 #include "sipifyheader.h"
diff --git a/tests/scripts/sipifyheader.h b/tests/scripts/sipifyheader.h
@@ -162,6 +162,11 @@ class CORE_EXPORT QgsSipifyHeader : public QtClass<QVariant>, private QgsBaseCla
 
 };
 
+/**
+ * \class ClassWithPrivateInheritanceOnly
+ * \ingroup core
+ * Documentation goes here
+ */
 class CORE_EXPORT ClassWithPrivateInheritanceOnly : private QgsBaseClass
 {
     //! A constructor with definition in header on several lines

Original file line number	Diff line number	Diff line change
`@@ -12,8 +12,6 @@`
`12`	`12`	`class QgsProcessingFeedback : QgsFeedback`
`13`	`13`	`{`
`14`	`14`	`%Docstring`
`15`		`- \class QgsProcessingFeedback`
`16`		`- \ingroup core`
`17`	`15`	`Base class for providing feedback from a processing algorithm.`
`18`	`16`
`19`	`17`	`This base class implementation silently ignores all feedback reported by algorithms.`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,6 @@`
`10`	`10`	`class QgsActionScope`
`11`	`11`	`{`
`12`	`12`	`%Docstring`
`13`		`- \ingroup core`
`14`	`13`	`An action scope defines a "place" for an action to be shown and may add`
`15`	`14`	`additional expression variables.`
`16`	`15`	`Each QgsAction can be available in one or several action scopes.`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,6 @@`
`11`	`11`	`class QgsAnimatedIcon : QObject`
`12`	`12`	`{`
`13`	`13`	`%Docstring`
`14`		`- \ingroup core`
`15`	`14`	`Animated icon is keeping an animation running if there are listeners connected to frameChanged`
`16`	`15`	`%End`
`17`	`16`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,6 @@ typedef qint64 QgsFeatureId;`
`20`	`20`	`class QgsFeature`
`21`	`21`	`{`
`22`	`22`	`%Docstring`
`23`		`- \ingroup core`
`24`	`23`	`The feature class encapsulates a single feature including its id,`
`25`	`24`	`geometry and a list of field/values attributes.`
`26`	`25`	`\note QgsFeature objects are implicitly shared.`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,6 @@ typedef QList<QgsPointV2> QgsPointSequence;`
`22`	`22`	`class QgsVectorLayer : QgsMapLayer, QgsExpressionContextGenerator`
`23`	`23`	`{`
`24`	`24`	`%Docstring`
`25`		`- \ingroup core`
`26`	`25`	`Represents a vector layer which manages a vector based data sets.`
`27`	`26`
`28`	`27`	`The QgsVectorLayer is instantiated by specifying the name of a data provider,`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,6 @@ typedef QVector<QVariant> QgsSuperClass;`
`39`	`39`	`class QgsSipifyHeader : QtClass<QVariant>`
`40`	`40`	`{`
`41`	`41`	`%Docstring`
`42`		`- \ingroup core`
`43`	`42`	`Documentation goes here`
`44`	`43`	`%End`
`45`	`44`
`@@ -125,6 +124,9 @@ complex default value and type (i.e. containing commas) should be given as a str`
`125`	`124`
`126`	`125`	`class ClassWithPrivateInheritanceOnly`
`127`	`126`	`{`
	`127`	`+%Docstring`
	`128`	`+ Documentation goes here`
	`129`	`+%End`
`128`	`130`
`129`	`131`	`%TypeHeaderCode`
`130`	`132`	`#include "sipifyheader.h"`