[doxygen] replace @see by \see

This commit is contained in:
Denis Rouzaud 2017-12-06 07:41:20 -04:00
parent 14e6df450a
commit b72c569cf3
9 changed files with 29 additions and 29 deletions

View File

@ -65,7 +65,7 @@ class QgsProcessingOutputDefinition
%Docstring %Docstring
Returns the name of the output. This is the internal identifier by which Returns the name of the output. This is the internal identifier by which
algorithms access this output. algorithms access this output.
@see setName() .. seealso:: :py:func:`setName()`
:rtype: str :rtype: str
%End %End
@ -73,14 +73,14 @@ class QgsProcessingOutputDefinition
%Docstring %Docstring
Sets the ``name`` of the output. This is the internal identifier by which Sets the ``name`` of the output. This is the internal identifier by which
algorithms access this output. algorithms access this output.
@see name() .. seealso:: :py:func:`name()`
%End %End
QString description() const; QString description() const;
%Docstring %Docstring
Returns the description for the output. This is the user-visible string Returns the description for the output. This is the user-visible string
used to identify this output. used to identify this output.
@see setDescription() .. seealso:: :py:func:`setDescription()`
:rtype: str :rtype: str
%End %End
@ -88,7 +88,7 @@ class QgsProcessingOutputDefinition
%Docstring %Docstring
Sets the ``description`` for the output. This is the user-visible string Sets the ``description`` for the output. This is the user-visible string
used to identify this output. used to identify this output.
@see description() .. seealso:: :py:func:`description()`
%End %End
protected: protected:

View File

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

View File

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

View File

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

View File

@ -287,7 +287,7 @@ void QgsEditFormConfig::readXml( const QDomNode &node, const QgsReadWriteContext
} }
// Temporary < 2.12 b/w compatibility "dot" support patch // 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 // 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 if yes, transform it in an import statement for the module
// and set the PythonInitCodeSource to CodeSourceDialog // and set the PythonInitCodeSource to CodeSourceDialog

View File

@ -31,7 +31,7 @@
* @ingroup UnitTests * @ingroup UnitTests
* This is a unit test for the vector layer cache * This is a unit test for the vector layer cache
* *
* @see QgsVectorLayerCache * \see QgsVectorLayerCache
*/ */
class TestVectorLayerCache : public QObject class TestVectorLayerCache : public QObject
{ {

View File

@ -33,7 +33,7 @@
* @ingroup UnitTests * @ingroup UnitTests
* This is a unit test for the vector layer join buffer * This is a unit test for the vector layer join buffer
* *
* @see QgsVectorLayerJoinBuffer * \see QgsVectorLayerJoinBuffer
*/ */
class TestVectorLayerJoinBuffer : public QObject class TestVectorLayerJoinBuffer : public QObject
{ {

View File

@ -28,7 +28,7 @@
* @ingroup UnitTests * @ingroup UnitTests
* This is a unit test for the field expression widget * This is a unit test for the field expression widget
* *
* @see QgsFieldExpressionWidget * \see QgsFieldExpressionWidget
*/ */
class TestQgsFieldExpressionWidget : public QObject class TestQgsFieldExpressionWidget : public QObject
{ {

View File

@ -32,7 +32,7 @@
* @ingroup UnitTests * @ingroup UnitTests
* This is a unit test for the scale range widget * This is a unit test for the scale range widget
* *
* @see QgsScaleRangeWidget * \see QgsScaleRangeWidget
*/ */
class TestQgsScaleRangeWidget : public QObject class TestQgsScaleRangeWidget : public QObject
{ {