0021936: [CEA 698] GEO-GUI : Several metho to get the entry of one object, several...

* add explanation about internal nature of some GEOM methods to the documentation

diff --git a/src/GEOM_SWIG/geompyDC.py b/src/GEOM_SWIG/geompyDC.py
index 1fb5f2560b4814730fd4e7ad8499b6705498a21a..13f145feb5524bec632fd46f89d28dd775e86976 100644 (file)
--- a/src/GEOM_SWIG/geompyDC.py
+++ b/src/GEOM_SWIG/geompyDC.py
@@ -9093,13 +9093,19 @@ class geompyDC(GEOM._objref_GEOM_Gen):
             RaiseIfFailed("LoadTexture", self.InsertOp)
             return ID
 
-        ## Get entry of the object
+        ## Get internal name of the object based on its study entry
+        #  @note This method does not provide an unique identifier of the geometry object.
+        #  @note This is internal function of GEOM component, though it can be used outside it for 
+        #  appropriate reason (e.g. for identification of geometry object).
         #  @param obj geometry object
         #  @return unique object identifier
         #  @ingroup l1_geompy_auxiliary
         def getObjectID(self, obj):
             """
-            Get entry of the object
+            Get internal name of the object based on its study entry.
+            Note: this method does not provide an unique identifier of the geometry object.
+            It is an internal function of GEOM component, though it can be used outside GEOM for 
+            appropriate reason (e.g. for identification of geometry object).
 
             Parameters:
                 obj geometry object