Change color action for a body object

[modules/shaper.git] / src / ModelAPI / ModelAPI_AttributeColor.h

diff --git a/src/ModelAPI/ModelAPI_AttributeColor.h b/src/ModelAPI/ModelAPI_AttributeColor.h
index 945d9f868d2768f7ebff2152df3241aa4021b5c0..6d3986a25d0f9ff9cd2e54534dd9ae3857d33bc1 100644 (file)
--- a/src/ModelAPI/ModelAPI_AttributeColor.h
+++ b/src/ModelAPI/ModelAPI_AttributeColor.h
@@ -15,7 +15,7 @@
 
 /**\class ModelAPI_AttributeColor
  * \ingroup DataModel
- * \brief API for the attribute that contains color (int, int, int).
+ * \brief API for the attribute that contains color (int, int, int). The color is in the range [0, 255]
  * There is an opportunity to fill the attribute by a random color
  */
 
@@ -23,6 +23,9 @@ class ModelAPI_AttributeColor : public ModelAPI_Attribute
 {
  public:
   /// Defines the color value
+  /// \param theRed the red part of the color
+  /// \param theRed the green part of the color
+  /// \param theRed the blue part of the color
   MODELAPI_EXPORT virtual void setValues(const int theRed,
                                          const int theGreen,
                                          const int theBlue) = 0;