Menu
▾
▴
[Openautomation-svn] SF.net SVN: openautomation:[739] CometVisu/trunk/visu
|
From: <ma...@us...> - 2012-04-02 21:49:59
|
Revision: 739
http://openautomation.svn.sourceforge.net/openautomation/?rev=739&view=rev
Author: mayerch
Date: 2012-04-02 21:49:52 +0000 (Mon, 02 Apr 2012)
Log Message:
-----------
Preparation for cleaner file structure and automated build script:
* initial support for automatic documentation generation (using YUIdoc)
Modified Paths:
--------------
CometVisu/trunk/visu/designs/structure_custom.js
CometVisu/trunk/visu/designs/structure_pure.js
CometVisu/trunk/visu/lib/cometvisu-client.js
CometVisu/trunk/visu/lib/compatibility.js
CometVisu/trunk/visu/lib/templateengine.js
Modified: CometVisu/trunk/visu/designs/structure_custom.js
===================================================================
--- CometVisu/trunk/visu/designs/structure_custom.js 2012-04-02 17:42:08 UTC (rev 738)
+++ CometVisu/trunk/visu/designs/structure_custom.js 2012-04-02 21:49:52 UTC (rev 739)
@@ -13,15 +13,21 @@
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
+ */
+
+/**
+ * This module defines the custom widget additions to the CometVisu visualisation.
+ * @module Structure custom
*/
/**
* This class defines all the custom changes to the visu
+ * @class VisuDesign_Custom
*/
function VisuDesign_Custom() {}; // do NOT change here
VisuDesign_Custom.prototype = new VisuDesign(); // do NOT change here
-/**
+/*
* Custom changes could go here and look e.g. like
****************************************
VisuDesign_Custom.prototype.addCreator("line", {
@@ -35,7 +41,7 @@
****************************************
*/
-/**
+/*
* This is a custom function that extends the available widgets.
* It's purpose is to change the design of the visu during runtime
* to demonstrate all available
Modified: CometVisu/trunk/visu/designs/structure_pure.js
===================================================================
--- CometVisu/trunk/visu/designs/structure_pure.js 2012-04-02 17:42:08 UTC (rev 738)
+++ CometVisu/trunk/visu/designs/structure_pure.js 2012-04-02 21:49:52 UTC (rev 739)
@@ -13,6 +13,12 @@
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
+ */
+
+/**
+ * This module defines the widgets for the CometVisu visualisation.
+ * @module Structure Pure
+ * @title CometVisu Structure "pure"
*/
// Define ENUM of maturity levels for features, so that e.g. the editor can
@@ -22,12 +28,11 @@
development : 1
};
-/**
+/*
* this function implements widget stylings
*
* implemented in: default_update, trigger-widget
*/
-
$.fn.setWidgetStyling = function(value) {
var styling = stylings[this.data('styling')];
if (styling) {
@@ -48,7 +53,7 @@
return this;
}
-/**
+/*
* this function implements all widget layouts that are identical (JNK)
*
* implemented: rowspan, colspan
@@ -63,7 +68,7 @@
return this;
}
- /**
+/*
* this function implements the widget label (JNK)
*/
@@ -75,9 +80,9 @@
return this;
}
-/**
- * this function extracts all addresses with attributes (JNK)
- */
+/*
+ * this function extracts all addresses with attributes (JNK)
+ */
function makeAddressList(page) {
var address = {};
@@ -94,6 +99,7 @@
/**
* This class defines all the building blocks for a Visu in the "Pure" design
+ * @class VisuDesign
*/
function VisuDesign() {
@@ -124,7 +130,7 @@
return this.popups[name];
}
- /**
+ /*
* The creators object contians all widgets creators and their mapping to the
* XML config file tags
*/
@@ -457,7 +463,7 @@
element.data( 'valueInternal', true );
}
},
- /**
+ /*
* Start a thread that regularily sends the silder position to the bus
*/
slideStart:function(event,ui)
@@ -478,7 +484,7 @@
data.value = actor.slider('value');
}, 250 ) ); // update KNX every 250 ms
},
- /**
+ /*
* Delete the update thread and send the final value of the slider to the bus
*/
slideChange:function(event,ui)
@@ -1297,7 +1303,7 @@
}
};
-/**
+/*
* Figure out best placement of popup.
* A preference can optionally be passed. The position is that of the numbers
* on the numeric keypad. I.e. a value of "6" means centered above the anchor.
Modified: CometVisu/trunk/visu/lib/cometvisu-client.js
===================================================================
--- CometVisu/trunk/visu/lib/cometvisu-client.js 2012-04-02 17:42:08 UTC (rev 738)
+++ CometVisu/trunk/visu/lib/cometvisu-client.js 2012-04-02 21:49:52 UTC (rev 739)
@@ -13,14 +13,19 @@
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
- *
+ */
+
+/**
+ * The JavaScript library that implements the CometVisu protocol.
* @module CometVisu Client
* @title CometVisu Client
+ * @reqires jQuery
*/
/**
* Class that handles the communicaton of the client
* @class CometVisu
+ * @constructor foo
* @param {String} urlPrefix The address of the service
*/
function CometVisu( urlPrefix )
@@ -43,6 +48,7 @@
/**
* This function gets called once the communication is established and session information is available
+ * @method handleSession
*/
this.handleSession = function( json )
{
@@ -59,6 +65,7 @@
/**
* This function gets called once the communication is established and session information is available
+ * @method handleRead
*/
this.handleRead = function( json )
{
@@ -89,6 +96,7 @@
/**
* This function gets called on an error
* FIXME: this should be a prototype, so that the application developer can override it
+ * @method handleError
*/
this.handleError=function(xhr,str,excptObj)
{
@@ -113,6 +121,7 @@
/**
* Build the URL part that contains the addresses and filters
+ * @method buildRequest
*/
this.buildRequest = function()
{
@@ -124,6 +133,7 @@
/**
* Subscribe to the addresses in the parameter
* The second parameter (filter) is optional
+ * @method subscribe
*/
this.subscribe = function( addresses, filters )
{
@@ -137,7 +147,8 @@
/**
* This function starts the communication by a login and then runs the
- * ongoing communication task
+ * ongoing communication task
+ * @method login
*/
this.login = function()
{
@@ -150,6 +161,7 @@
/**
* This function stops an ongoing connection
+ * @method stop
*/
this.stop = function()
{
@@ -160,6 +172,7 @@
/**
* This function sends a value
+ * @method write
*/
this.write = function( address, value )
{
@@ -174,6 +187,7 @@
/**
* Restart the read request, e.g. when the watchdog kicks in
+ * @method restart
*/
this.restart = function()
{
@@ -185,6 +199,7 @@
/**
* The watchdog to recreate a read request when it stopped somehow
+ * @method watchdog
*/
var watchdog = (function(){
var last = new Date();
Modified: CometVisu/trunk/visu/lib/compatibility.js
===================================================================
--- CometVisu/trunk/visu/lib/compatibility.js 2012-04-02 17:42:08 UTC (rev 738)
+++ CometVisu/trunk/visu/lib/compatibility.js 2012-04-02 21:49:52 UTC (rev 739)
@@ -136,7 +136,7 @@
sprintf = sprintfWrapper.init;
-/**
+/*
* be able to access GET-Params
*/
$.extend({
Modified: CometVisu/trunk/visu/lib/templateengine.js
===================================================================
--- CometVisu/trunk/visu/lib/templateengine.js 2012-04-02 17:42:08 UTC (rev 738)
+++ CometVisu/trunk/visu/lib/templateengine.js 2012-04-02 21:49:52 UTC (rev 739)
@@ -13,6 +13,9 @@
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
+ *
+ * @module Templateengine
+ * @title CometVisu templateengine
*/
var design = new VisuDesign_Custom();
@@ -111,7 +114,7 @@
return value;
}
-/**
+/*
* Make sure everything looks right when the window gets resized.
* This is necessary as the scroll effect requires a fixed element size
*/
@@ -440,7 +443,7 @@
}
}
-/**
+/*
* Show a popup of type "type".
* The attributes is an type dependend object
* This function returnes a jQuery object that points to the whole popup,
@@ -454,7 +457,7 @@
return design.popups[ type ].create( attributes );
}
-/**
+/*
* Remove the popup.
* The parameter is the jQuery object returned by the showPopup function
*/
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
