From: vsr <vsr@opencascade.com>
Date: Tue, 2 Nov 2010 14:41:44 +0000 (+0000)
Subject: Additional documentation for AttributeComment.
X-Git-Tag: V5_1_5rc2~3
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=f80e466357af79a67a2af12fa62aac337731e5e7;p=modules%2Fkernel.git

Additional documentation for AttributeComment.
---

diff --git a/idl/SALOMEDS_Attributes.idl b/idl/SALOMEDS_Attributes.idl
index 39130e2c3..bd40d4277 100644
--- a/idl/SALOMEDS_Attributes.idl
+++ b/idl/SALOMEDS_Attributes.idl
@@ -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>