[doxygen] replace @see by \see

qgis · Dec 6, 2017 · b72c569 · b72c569
1 parent 14e6df4
commit b72c569
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 29 deletions.
diff --git a/python/core/processing/qgsprocessingoutputs.sip b/python/core/processing/qgsprocessingoutputs.sip
@@ -65,30 +65,30 @@ class QgsProcessingOutputDefinition
 %Docstring
  Returns the name of the output. This is the internal identifier by which
  algorithms access this output.
- @see setName()
+.. seealso:: :py:func:`setName()`
  :rtype: str
 %End
 
     void setName( const QString &name );
 %Docstring
  Sets the ``name`` of the output. This is the internal identifier by which
  algorithms access this output.
- @see name()
+.. seealso:: :py:func:`name()`
 %End
 
     QString description() const;
 %Docstring
  Returns the description for the output. This is the user-visible string
  used to identify this output.
- @see setDescription()
+.. seealso:: :py:func:`setDescription()`
  :rtype: str
 %End
 
     void setDescription( const QString &description );
 %Docstring
  Sets the ``description`` for the output. This is the user-visible string
  used to identify this output.
- @see description()
+.. seealso:: :py:func:`description()`
 %End
 
   protected:

diff --git a/python/core/processing/qgsprocessingparameters.sip b/python/core/processing/qgsprocessingparameters.sip
@@ -236,57 +236,57 @@ class QgsProcessingParameterDefinition
 %Docstring
  Returns the name of the parameter. This is the internal identifier by which
  algorithms access this parameter.
- @see setName()
+.. seealso:: :py:func:`setName()`
  :rtype: str
 %End
 
     void setName( const QString &name );
 %Docstring
  Sets the ``name`` of the parameter. This is the internal identifier by which
  algorithms access this parameter.
- @see name()
+.. seealso:: :py:func:`name()`
 %End
 
     QString description() const;
 %Docstring
  Returns the description for the parameter. This is the user-visible string
  used to identify this parameter.
- @see setDescription()
+.. seealso:: :py:func:`setDescription()`
  :rtype: str
 %End
 
     void setDescription( const QString &description );
 %Docstring
  Sets the ``description`` for the parameter. This is the user-visible string
  used to identify this parameter.
- @see description()
+.. seealso:: :py:func:`description()`
 %End
 
     QVariant defaultValue() const;
 %Docstring
  Returns the default value for the parameter.
- @see setDefaultValue()
+.. seealso:: :py:func:`setDefaultValue()`
  :rtype: QVariant
 %End
 
     void setDefaultValue( const QVariant &value );
 %Docstring
  Sets the default ``value`` for the parameter. Caller takes responsibility
  to ensure that ``value`` is a valid input for the parameter subclass.
- @see defaultValue()
+.. seealso:: :py:func:`defaultValue()`
 %End
 
     Flags flags() const;
 %Docstring
  Returns any flags associated with the parameter.
- @see setFlags()
+.. seealso:: :py:func:`setFlags()`
  :rtype: Flags
 %End
 
     void setFlags( const Flags &flags );
 %Docstring
  Sets the ``flags`` associated with the parameter.
- @see flags()
+.. seealso:: :py:func:`flags()`
 %End
 
     virtual bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = 0 ) const;

diff --git a/src/core/processing/qgsprocessingoutputs.h b/src/core/processing/qgsprocessingoutputs.h
@@ -81,28 +81,28 @@ class CORE_EXPORT QgsProcessingOutputDefinition
     /**
      * Returns the name of the output. This is the internal identifier by which
      * algorithms access this output.
-     * @see setName()
+     * \see setName()
      */
     QString name() const { return mName; }
 
     /**
      * Sets the \a name of the output. This is the internal identifier by which
      * algorithms access this output.
-     * @see name()
+     * \see name()
      */
     void setName( const QString &name ) { mName = name; }
 
     /**
      * Returns the description for the output. This is the user-visible string
      * used to identify this output.
-     * @see setDescription()
+     * \see setDescription()
      */
     QString description() const { return mDescription; }
 
     /**
      * Sets the \a description for the output. This is the user-visible string
      * used to identify this output.
-     * @see description()
+     * \see description()
      */
     void setDescription( const QString &description ) { mDescription = description; }
 

diff --git a/src/core/processing/qgsprocessingparameters.h b/src/core/processing/qgsprocessingparameters.h
@@ -278,53 +278,53 @@ class CORE_EXPORT QgsProcessingParameterDefinition
     /**
      * Returns the name of the parameter. This is the internal identifier by which
      * algorithms access this parameter.
-     * @see setName()
+     * \see setName()
      */
     QString name() const { return mName; }
 
     /**
      * Sets the \a name of the parameter. This is the internal identifier by which
      * algorithms access this parameter.
-     * @see name()
+     * \see name()
      */
     void setName( const QString &name ) { mName = name; }
 
     /**
      * Returns the description for the parameter. This is the user-visible string
      * used to identify this parameter.
-     * @see setDescription()
+     * \see setDescription()
      */
     QString description() const { return mDescription; }
 
     /**
      * Sets the \a description for the parameter. This is the user-visible string
      * used to identify this parameter.
-     * @see description()
+     * \see description()
      */
     void setDescription( const QString &description ) { mDescription = description; }
 
     /**
      * Returns the default value for the parameter.
-     * @see setDefaultValue()
+     * \see setDefaultValue()
      */
     QVariant defaultValue() const { return mDefault; }
 
     /**
      * Sets the default \a value for the parameter. Caller takes responsibility
      * to ensure that \a value is a valid input for the parameter subclass.
-     * @see defaultValue()
+     * \see defaultValue()
      */
     void setDefaultValue( const QVariant &value ) { mDefault = value; }
 
     /**
      * Returns any flags associated with the parameter.
-     * @see setFlags()
+     * \see setFlags()
      */
     Flags flags() const { return mFlags; }
 
     /**
      * Sets the \a flags associated with the parameter.
-     * @see flags()
+     * \see flags()
      */
     void setFlags( const Flags &flags ) { mFlags = flags; }
 

diff --git a/src/core/qgseditformconfig.cpp b/src/core/qgseditformconfig.cpp
@@ -287,7 +287,7 @@ void QgsEditFormConfig::readXml( const QDomNode &node, const QgsReadWriteContext
   }
 
   // Temporary < 2.12 b/w compatibility "dot" support patch
-  // @see: https://github.com/qgis/QGIS/pull/2498
+  // \see: https://github.com/qgis/QGIS/pull/2498
   // For b/w compatibility, check if there's a dot in the function name
   // and if yes, transform it in an import statement for the module
   // and set the PythonInitCodeSource to CodeSourceDialog

diff --git a/tests/src/core/testqgsvectorlayercache.cpp b/tests/src/core/testqgsvectorlayercache.cpp
@@ -31,7 +31,7 @@
  * @ingroup UnitTests
  * This is a unit test for the vector layer cache
  *
- * @see QgsVectorLayerCache
+ * \see QgsVectorLayerCache
  */
 class TestVectorLayerCache : public QObject
 {

diff --git a/tests/src/core/testqgsvectorlayerjoinbuffer.cpp b/tests/src/core/testqgsvectorlayerjoinbuffer.cpp
@@ -33,7 +33,7 @@
  * @ingroup UnitTests
  * This is a unit test for the vector layer join buffer
  *
- * @see QgsVectorLayerJoinBuffer
+ * \see QgsVectorLayerJoinBuffer
  */
 class TestVectorLayerJoinBuffer : public QObject
 {

diff --git a/tests/src/gui/testqgsfieldexpressionwidget.cpp b/tests/src/gui/testqgsfieldexpressionwidget.cpp
@@ -28,7 +28,7 @@
  * @ingroup UnitTests
  * This is a unit test for the field expression widget
  *
- * @see QgsFieldExpressionWidget
+ * \see QgsFieldExpressionWidget
  */
 class TestQgsFieldExpressionWidget : public QObject
 {

diff --git a/tests/src/gui/testqgsscalerangewidget.cpp b/tests/src/gui/testqgsscalerangewidget.cpp
@@ -32,7 +32,7 @@
  * @ingroup UnitTests
  * This is a unit test for the scale range widget
  *
- * @see QgsScaleRangeWidget
+ * \see QgsScaleRangeWidget
  */
 class TestQgsScaleRangeWidget : public QObject
 {