From 9725be86867b393ab5d69db1f458049a5878eff9 Mon Sep 17 00:00:00 2001 From: Abdullah Tahiri Date: Sun, 29 Jan 2017 00:25:34 +0100 Subject: [PATCH] Sketcher: Documentation of delete functions --- src/Mod/Sketcher/App/SketchObject.h | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/src/Mod/Sketcher/App/SketchObject.h b/src/Mod/Sketcher/App/SketchObject.h index a9ef75e7d..224c4800d 100644 --- a/src/Mod/Sketcher/App/SketchObject.h +++ b/src/Mod/Sketcher/App/SketchObject.h @@ -90,7 +90,12 @@ public: int addGeometry(const Part::Geometry *geo, bool construction=false); /// add unspecified geometry int addGeometry(const std::vector &geoList, bool construction=false); - /// delete geometry + /*! + \brief Deletes indicated geometry (by geoid). + \param GeoId - the geometry to delete + \param deleteinternalgeo - if true deletes the associated and unconstraint internal geometry, otherwise deletes only the GeoId + \retval int - 0 if successful + */ int delGeometry(int GeoId, bool deleteinternalgeo = true); /// add all constraints in the list int addConstraints(const std::vector &ConstraintList); @@ -184,9 +189,11 @@ public: * \return -1 on error */ int ExposeInternalGeometry(int GeoId); - /// Deletes all unused (not further constrained) internal geometry /*! - * \return -1 on error + \brief Deletes all unused (not further constrained) internal geometry + \param GeoId - the geometry having the internal geometry to delete + \param delgeoid - if true in addition to the unused internal geometry also deletes the GeoId geometry + \retval int - returns -1 on error */ int DeleteUnusedInternalGeometry(int GeoId, bool delgeoid=false);