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

[George Staikos]

SVN commit 418240 by staikos:

Document Plot


 M  +24 -0     bind_plot.h  


--- trunk/extragear/graphics/kst/kst/extensions/js/bind_plot.h #418239:418240
@@ -27,8 +27,17 @@
 
 using namespace KJSEmbed;
 
+/* @class Plot
+   @collection PlotCollection
+   @description This class represents a plot in Kst.
+*/
 class KstBindPlot : public KstBinding {
   public:
+    /* @constructor
+       @arg Window window The window to place the new plot in.  May also be a
+                          string containing the name of an existing Window.
+       @description Creates a new plot and places it in the Window <i>window</i>.
+    */
     KstBindPlot(KJS::ExecState *exec, Kst2DPlotPtr d);
     KstBindPlot(KJS::ExecState *exec, KJS::Object *globalObject = 0L);
     ~KstBindPlot();
@@ -43,10 +52,25 @@
     // member functions
 
     // 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 CurveCollection curves
+       @readonly
+       @description A list of all the Curves used by the plot.
+    */
     KJS::Value curves(KJS::ExecState *exec) const;
+    /* @property PlotLabelCollection labels
+       @readonly
+       @description A list of all the Labels used by the plot.
+    */
     KJS::Value labels(KJS::ExecState *exec) const;
+    /* @property Legend legend
+       @readonly
+       @description The Legend for this plot.
+    */
     KJS::Value legend(KJS::ExecState *exec) const;
 
   protected: