Sketcher: Documentation of delete functions

This commit is contained in:
Abdullah Tahiri 2017-01-29 00:25:34 +01:00
parent 0edf17245c
commit 9725be8686

View File

@ -90,7 +90,12 @@ public:
int addGeometry(const Part::Geometry *geo, bool construction=false);
/// add unspecified geometry
int addGeometry(const std::vector<Part::Geometry *> &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<Constraint *> &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);