Skip to content

Commit

Permalink
better doxigen description
Browse files Browse the repository at this point in the history
  • Loading branch information
luipir committed Sep 26, 2017
1 parent f276216 commit e3cf1e0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
7 changes: 5 additions & 2 deletions python/core/qgsvectorlayereditbuffer.sip
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,11 @@ class QgsVectorLayerEditBuffer : QObject
* Geom is modified only if successful convertion is possibile.
* In case of conversion a message is sent to the log.
* @param geometry pointer to the geometry that should be adapted to provider
* @return bool true if success
* @note added in QGIS 2.18
* @return bool true if success.
* Success means that input geometry is changed because conversion is applied or
* geometry is untouched if geometry conversion is not necessary.
* Fail if conversion is not possible and geometry is untuched.
* @note added in QGIS 2.18.14
*/
bool adaptGeometry( QgsGeometry* geometry );
};
7 changes: 5 additions & 2 deletions src/core/qgsvectorlayereditbuffer.h
Original file line number Diff line number Diff line change
Expand Up @@ -182,8 +182,11 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject
* Geom is modified only if successful convertion is possibile.
* In case of conversion a message is sent to the log.
* @param geometry pointer to the geometry that should be adapted to provider
* @return bool true if success
* @note added in QGIS 2.18
* @return bool true if success.
* Success means that input geometry is changed because conversion is applied or
* geometry is untouched if geometry conversion is not necessary.
* Fail if conversion is not possible and geometry is untuched.
* @note added in QGIS 2.18.14
*/
bool adaptGeometry( QgsGeometry* geometry );

Expand Down

0 comments on commit e3cf1e0

Please sign in to comment.