better doxigen description

qgis · Sep 26, 2017 · e3cf1e0 · e3cf1e0
1 parent f276216
commit e3cf1e0
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/python/core/qgsvectorlayereditbuffer.sip b/python/core/qgsvectorlayereditbuffer.sip
@@ -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 );
 };
diff --git a/src/core/qgsvectorlayereditbuffer.h b/src/core/qgsvectorlayereditbuffer.h
@@ -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 );