Salome HOME
Additional documentation for AttributeComment.
authorvsr <vsr@opencascade.com>
Tue, 2 Nov 2010 14:41:44 +0000 (14:41 +0000)
committervsr <vsr@opencascade.com>
Tue, 2 Nov 2010 14:41:44 +0000 (14:41 +0000)
idl/SALOMEDS_Attributes.idl

index 39130e2c37ac741ce14fec0589e9daa5c834e288..bd40d4277b1b46816f790bd637e2b4aebfe2a1cc 100644 (file)
@@ -238,8 +238,14 @@ module SALOMEDS
   /*!
     \brief Comment attribute
 
-    The attribute stores a string value containing supplementary information about
-    the SObject. In particular it contains the data type of the %SComponent.
+    The attribute stores arbitrary string value containing supplementary information about
+    the SObject. This is common-usage attribute that can be used for any purpose.
+
+    There is only one explicit limitation: for the SComponent %object representing
+    the root item of the SALOME component tree, the AttributeComment is used to store
+    component data type value. This attribute is automatically set with NewComponent()
+    function of StudyBuilder. Also, the value of this attribute is returned by the 
+    ComponentDataType() function of SComponent interface.
     
     <em>See \ref example6 for an example of this attribute usage in batchmode of %SALOME application.</em>