Skip to content
Permalink
Browse files

updated doxigen directives

  • Loading branch information
luipir committed Sep 26, 2017
1 parent fbaf966 commit 027a71549bd7ade6230207e921114eb5398521a1
@@ -390,7 +390,7 @@ class QgsVectorDataProvider : QgsDataProvider

void pushError( const QString& msg );

/** Converts the geometry to the provider type if possible / necessary
/** \brief Converts the geometry to the provider type if possible / necessary
* this is the list of possibile modifications:
* - convert compoundcurve to circularstring
* (possible if compoundcurve consists of one circular string)
@@ -399,6 +399,8 @@ class QgsVectorDataProvider : QgsDataProvider
* - convert to linear type from curved type
* - Add z/m 0 default values
* - Remove z/m
@return the converted geometry or nullptr if no conversion was necessary or possible*/
* \ref QgsVectorLayerEditBuffer::adaptGeometry()
* \param geom Geometry to convert
* \returns the converted geometry or nullptr if no conversion was necessary or possible*/
QgsGeometry* convertToProviderType( const QgsGeometry* geom ) const /Factory/;
};
@@ -149,16 +149,16 @@ class QgsVectorLayerEditBuffer : QObject

void updateLayerFields();

/** Apply geometry modification basing on provider geometry type.
/** \brief Apply geometry modification basing on provider geometry type.
* Geometry is modified only if successful conversion is possible.
* adaptGeometry calls QgsVectorDataProvider::convertToProviderType()
* adaptGeometry calls \ref QgsVectorDataProvider::convertToProviderType()
* if necessary and that apply the modifications.
* @param geometry pointer to the geometry that should be adapted to provider
* @return bool true if success.
* \param geometry pointer to the geometry that should be adapted to provider
* \returns bool true if success.
* True: Input geometry is changed because conversion is applied or
* geometry is untouched if geometry conversion is not necessary.
* False: Conversion is not possible and geometry is untouched.
* @note added in QGIS 2.18.14
* \note added in QGIS 2.18.14
*/
bool adaptGeometry( QgsGeometry* geometry );
};
@@ -468,7 +468,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider
/** Old-style mapping of index to name for QgsPalLabeling fix */
QgsAttrPalIndexNameHash mAttrPalIndexName;

/** Converts the geometry to the provider type if possible / necessary
/** \brief Converts the geometry to the provider type if possible / necessary
* this is the list of possibile modifications:
* - convert compoundcurve to circularstring
* (possible if compoundcurve consists of one circular string)
@@ -477,7 +477,9 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider
* - convert to linear type from curved type
* - Add z/m 0 default values
* - Remove z/m
@return the converted geometry or nullptr if no conversion was necessary or possible*/
* \ref QgsVectorLayerEditBuffer::adaptGeometry()
* \param geom Geometry to convert
* \returns the converted geometry or nullptr if no conversion was necessary or possible*/
QgsGeometry* convertToProviderType( const QgsGeometry* geom ) const;

private:
@@ -178,16 +178,16 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject

void updateLayerFields();

/** Apply geometry modification basing on provider geometry type.
/** \brief Apply geometry modification basing on provider geometry type.
* Geometry is modified only if successful conversion is possible.
* adaptGeometry calls QgsVectorDataProvider::convertToProviderType()
* adaptGeometry calls \ref QgsVectorDataProvider::convertToProviderType()
* if necessary and that apply the modifications.
* @param geometry pointer to the geometry that should be adapted to provider
* @return bool true if success.
* \param geometry pointer to the geometry that should be adapted to provider
* \returns bool true if success.
* True: Input geometry is changed because conversion is applied or
* geometry is untouched if geometry conversion is not necessary.
* False: Conversion is not possible and geometry is untouched.
* @note added in QGIS 2.18.14
* \note added in QGIS 2.18.14
*/
bool adaptGeometry( QgsGeometry* geometry );

0 comments on commit 027a715

Please sign in to comment.
You can’t perform that action at this time.