Strip \a from doxygen comments in sipify

nyalldawson · nyalldawson · commit e1e1f0d51483 · 2017-04-03T13:18:36.000+10:00
diff --git a/python/core/qgsanimatedicon.sip b/python/core/qgsanimatedicon.sip
@@ -21,7 +21,7 @@ class QgsAnimatedIcon : QObject
 
     QgsAnimatedIcon( const QString &iconPath = QString(), QObject *parent = 0 );
 %Docstring
- Create a new animated icon. Optionally, the \a iconPath can already be specified.
+ Create a new animated icon. Optionally, the iconPath can already be specified.
 %End
 
     QString iconPath() const;
diff --git a/python/core/qgspropertytransformer.sip b/python/core/qgspropertytransformer.sip
@@ -26,7 +26,7 @@ class QgsCurveTransform
 
     QgsCurveTransform( const QList< QgsPoint > &controlPoints );
 %Docstring
- Constructs a QgsCurveTransform using a specified list of \a controlPoints.
+ Constructs a QgsCurveTransform using a specified list of controlPoints.
  Behavior is undefined if duplicate x values exist in the control points
  list.
 %End
@@ -69,12 +69,12 @@ class QgsCurveTransform
 
     double y( double x ) const;
 %Docstring
- Returns the mapped y value corresponding to the specified \a x value.
+ Returns the mapped y value corresponding to the specified x value.
 %End
 
     QVector< double > y( const QVector< double > &x ) const;
 %Docstring
- Returns a list of y values corresponding to a list of \a x values.
+ Returns a list of y values corresponding to a list of x values.
  Calling this method is faster then calling the double variant multiple
  times.
 %End
@@ -232,7 +232,7 @@ class QgsPropertyTransformer
     void setCurveTransform( QgsCurveTransform *transform /Transfer/ );
 %Docstring
  Sets a curve transform to apply to input values before they are transformed
- by the individual transform subclasses. Ownership of \a transform is transferred
+ by the individual transform subclasses. Ownership of transform is transferred
  to the property transformer.
  \see curveTransform()
 %End
@@ -247,7 +247,7 @@ class QgsPropertyTransformer
 
     virtual QString toExpression( const QString &baseExpression ) const = 0;
 %Docstring
- Converts the transformer to a QGIS expression string. The \a baseExpression string consists
+ Converts the transformer to a QGIS expression string. The baseExpression string consists
  of a sub-expression reflecting the parent property's state.
 %End
 
@@ -270,7 +270,7 @@ class QgsPropertyTransformer
     double transformNumeric( double input ) const;
 %Docstring
  Applies base class numeric transformations. Derived classes should call this
- to transform an \a input numeric value before they apply any transform to the result.
+ to transform an input numeric value before they apply any transform to the result.
  This applies any curve transforms which may exist on the transformer.
 %End
 };
@@ -329,7 +329,7 @@ class QgsGenericNumericTransformer : QgsPropertyTransformer
 
     double value( double input ) const;
 %Docstring
- Calculates the size corresponding to a specific \a input value.
+ Calculates the size corresponding to a specific input value.
  \returns calculated size using size scale transformer's parameters and type
 %End
 
@@ -610,7 +610,7 @@ Copy constructor
 
     void setRampName( const QString &name );
 %Docstring
- Sets the color ramp's \a name. The ramp name must be set to match
+ Sets the color ramp's name. The ramp name must be set to match
  a color ramp available in the style database for conversion to expression
  to work correctly.
  \see rampName()
diff --git a/python/gui/symbology-ng/characterwidget.sip b/python/gui/symbology-ng/characterwidget.sip
@@ -58,7 +58,7 @@ class CharacterWidget : QWidget
 
     void setFont( const QFont &font );
 %Docstring
- Sets the \a font to show in the widget.
+ Sets the font to show in the widget.
  \see font()
 .. versionadded:: 3.0
 %End
@@ -85,7 +85,7 @@ class CharacterWidget : QWidget
 
     void setCharacter( QChar character );
 %Docstring
- Sets the currently selected \a character in the widget.
+ Sets the currently selected character in the widget.
  \see character()
  \see characterSelected()
 %End
diff --git a/scripts/sipify.pl b/scripts/sipify.pl
@@ -9,19 +9,22 @@
 
 sub processDoxygenLine
 {
-    if ( $_[0] =~ m/[\\@](ingroup|class)/ ) {
+    my $line = $_[0];
+    # remove \a formatting
+    $line =~ s/\\a //g;
+    if ( $line =~ m/[\\@](ingroup|class)/ ) {
         return ""
     }
-    if ( $_[0] =~ m/\\since .*?([\d\.]+)/i ) {
+    if ( $line =~ m/\\since .*?([\d\.]+)/i ) {
         return ".. versionadded:: $1\n";
     }
-    if ( $_[0] =~ m/[\\@]note (.*)/ ) {
+    if ( $line =~ m/[\\@]note (.*)/ ) {
         return ".. note::\n\n   $1\n";
     }
-    if ( $_[0] =~ m/[\\@]brief (.*)/ ) {
+    if ( $line =~ m/[\\@]brief (.*)/ ) {
         return " $1\n";
     }
-    return $_[0];
+    return $line;
 }
 
 
diff --git a/tests/scripts/sipifyheader.h b/tests/scripts/sipifyheader.h
@@ -152,7 +152,7 @@ class CORE_EXPORT QgsSipifyHeader : public QtClass<QVariant>, private QgsBaseCla
 
     /**
      * \brief some brief
-     * My long doc string
+     * My long doc \a string
      * is not very interesting!
      */
     void LongDocStringMethodWithBrief();

Original file line number	Diff line number	Diff line change
`@@ -9,19 +9,22 @@`
`9`	`9`
`10`	`10`	`sub processDoxygenLine`
`11`	`11`	`{`
`12`		`- if ( $_[0] =~ m/[\\@](ingroup\|class)/ ) {`
	`12`	`+ my $line = $_[0];`
	`13`	`+ # remove \a formatting`
	`14`	`+ $line =~ s/\\a //g;`
	`15`	`+ if ( $line =~ m/[\\@](ingroup\|class)/ ) {`
`13`	`16`	`return ""`
`14`	`17`	`}`
`15`		`- if ( $_[0] =~ m/\\since .*?([\d\.]+)/i ) {`
	`18`	`+ if ( $line =~ m/\\since .*?([\d\.]+)/i ) {`
`16`	`19`	`return ".. versionadded:: $1\n";`
`17`	`20`	`}`
`18`		`- if ( $_[0] =~ m/[\\@]note (.*)/ ) {`
	`21`	`+ if ( $line =~ m/[\\@]note (.*)/ ) {`
`19`	`22`	`return ".. note::\n\n $1\n";`
`20`	`23`	`}`
`21`		`- if ( $_[0] =~ m/[\\@]brief (.*)/ ) {`
	`24`	`+ if ( $line =~ m/[\\@]brief (.*)/ ) {`
`22`	`25`	`return " $1\n";`
`23`	`26`	`}`
`24`		`- return $_[0];`
	`27`	`+ return $line;`
`25`	`28`	`}`
`26`	`29`
`27`	`30`