[Kst] extragear/graphics/kst/kst/extensions/js

[George Staikos]

SVN commit 418149 by staikos:

Document Scalar


 M  +10 -1     bind_scalar.h  


--- trunk/extragear/graphics/kst/kst/extensions/js/bind_scalar.h #418148:418149
@@ -27,6 +27,10 @@
 
 using namespace KJSEmbed;
 
+/* @class Scalar
+   @collection ScalarCollection Kst.scalars
+   @description Represents a scalar value (a number) in Kst.
+*/
 class KstBindScalar : public KstBinding {
   public:
     KstBindScalar(KJS::ExecState *exec, KstScalarPtr s);
@@ -40,9 +44,14 @@
     KJS::ReferenceList propList(KJS::ExecState *exec, bool recursive = true);
     bool hasProperty(KJS::ExecState *exec, const KJS::Identifier& propertyName) const;
 
-    // properties
+    /* @property String tagName
+       @description A unique identifier for this data object.
+     */
     void setTagName(KJS::ExecState *exec, const KJS::Value& value);
     KJS::Value tagName(KJS::ExecState *exec) const;
+    /* @property Number value
+       @description Used to access or modify the value of a scalar.
+     */
     void setValue(KJS::ExecState *exec, const KJS::Value& value);
     KJS::Value value(KJS::ExecState *exec) const;