Browse files

Doc

  • Loading branch information...
1 parent 9a3870d commit b4042c240ec6b60427e1c8833c66ac8065a6513c @neyric committed Aug 20, 2012
View
2 index.html
@@ -94,7 +94,7 @@
<h2>Fork on GitHub</h2>
<p>Download, fork, pull, file issues, and more with the official WireIt repo on Github. You can still download the <a href="https://github.com/neyric/wireit/downloads">old 0.5.0 version</a>.</p>
- <p class="current-version">Currently <a href="VERSION.txt">v3.0.0pr1</a></p>
+ <p class="current-version">Currently <a href="VERSION.txt">v3.0.0pr2</a></p>
<p style="text-align: center;"><a class="btn primary" href="http://github.com/neyric/wireit/">Download &raquo;</a></p>
View
2 src/arrow-wire/arrow-wire.js
@@ -1,5 +1,5 @@
/**
- * @module straight-wire
+ * @module arrow-wire
*/
YUI.add('arrow-wire', function(Y) {
View
1 src/terminal-ddgroups/terminal-ddgroups.js
@@ -4,6 +4,7 @@
YUI.add('terminal-ddgroups', function(Y) {
/**
+ * Extension to add "groups" labels when hovering the terminal
* @class TerminalDDGroups
* @constructor
* @param {Object} config configuration object
View
48 src/terminal-dragedit/terminal-dragedit.js
@@ -4,6 +4,7 @@
YUI.add('terminal-dragedit', function(Y) {
/**
+ * Extension which makes the wires editable
* @class TerminalDragEdit
* @constructor
* @param {Object} config configuration object
@@ -33,16 +34,26 @@ Y.TerminalDragEdit.ATTRS = {
value: true
},
+ /**
+ * @attribute graphic
+ */
graphic: {
value: null
},
+
+ /**
+ * @attribute alwaysSrc
+ */
alwaysSrc: {
value: false
}
};
Y.TerminalDragEdit.prototype = {
+ /**
+ * @method _renderUIdragedit
+ */
_renderUIdragedit: function() {
if( this.get('editable') ) {
@@ -71,6 +82,9 @@ Y.TerminalDragEdit.prototype = {
},
+ /**
+ * @method _bindUIdragedit
+ */
_bindUIdragedit: function() {
var drag = this.drag;
if(drag) {
@@ -127,14 +141,22 @@ Y.TerminalDragEdit.prototype = {
},
- // Update the position of the fake target and redraw the wire
+ /**
+ * Update the position of the fake target and redraw the wire
+ * @method _onDragEditDrag
+ * @private
+ */
_onDragEditDrag: function(ev) {
this._editwireX = ev.pageX;
this._editwireY = ev.pageY;
this.drag.wire._draw();
},
- // on drop hit, set the wire src and tgt terminals
+ /**
+ * on drop hit, set the wire src and tgt terminals
+ * @method _onDragEditDrophit
+ * @private
+ */
_onDragEditDrophit: function(ev) {
if( this.isValidWireTerminal(ev.drop.terminal) ) {
@@ -157,13 +179,18 @@ Y.TerminalDragEdit.prototype = {
}
},
- // on drop miss, destroy the wire
-
+ /**
+ * on drop miss, destroy the wire
+ * @method _onDragEditDropmiss
+ */
_onDragEditDropmiss: function(ev) {
this.drag.wire.destroy();
this.drag.wire = null;
},
+ /**
+ * @method _onDragEditEnter
+ */
_onDragEditEnter: function(ev) {
var pos = ev.drop.terminal.getXY();
@@ -175,10 +202,17 @@ Y.TerminalDragEdit.prototype = {
},
+ /**
+ * @method _onDragEditExit
+ */
_onDragEditExit: function(ev) {
this._magnetX = null;
this._magnetY = null;
},
+
+ /**
+ * @method isValidWireTerminal
+ */
isValidWireTerminal: function(DDterminal) {
if(this.get('parent') !== undefined && (this.get('parent').get('preventSelfWiring'))){
if (DDterminal._parentNode._node == this._parentNode._node) {
@@ -188,9 +222,11 @@ Y.TerminalDragEdit.prototype = {
return true;
},
-
+ /**
+ * @method destructor
+ */
destructor: function() {
-
+
if(this.drag) {
this.drag.destroy();
}
View
2 src/terminal-input/terminal-input.js
@@ -34,6 +34,6 @@ Y.extend(Y.TerminalInput, Y.Terminal, {
ddConfig: { type: "input", allowedTypes: ["output"] }
});
-}, '0.7.0',{
+}, '3.6.0',{
requires: ['terminal']
});
View
2 src/terminal-output/terminal-output.js
@@ -51,6 +51,6 @@ Y.extend(Y.TerminalOutput, Y.Terminal, {
});
-}, '0.7.0',{
+}, '3.6.0',{
requires: ['terminal']
});
View
33 src/textarea-container/textarea-container.js
@@ -7,31 +7,14 @@ YUI.add("textarea-container", function(Y){
* Form container for a single textarea field which is resizeable.
* Important: this class takes the exact same arguments as the FormContainer !
* You still need to specify the "fields".
- * @class WireTextareaContainer
- * @extends WireFormContainer
+ * @class TextareaContainer
+ * @extends FormContainer
* @constructor
* @param {Object} options Configuration object (see properties)
- * @param {Layer} layer The Y.Layer (or subclass) instance that contains this container
*/
Y.TextareaContainer = Y.Base.create("textarea-container", Y.Container, [], {
-
-
- /**
- * @method renderUI
- */
- /*renderUI: function() {
- Y.TextareaContainer.superclass.renderUI.call(this);
- this._renderTextarea();
- },
-
-
- _renderTextarea: function() {
-
-
- },*/
-
SERIALIZABLE_ATTRS: Y.Container.prototype.SERIALIZABLE_ATTRS.concat(['value'])
@@ -48,13 +31,17 @@ Y.TextareaContainer = Y.Base.create("textarea-container", Y.Container, [], {
ATTRS: {
+ /**
+ * Value of the textarea
+ * @attribute value
+ */
value: {
getter: function() {
return this.getStdModNode(Y.WidgetStdMod.BODY).one('textarea').get('value');
},
setter: function(value) {
- this.set('bodyContent', '<textarea>'+value+'</textarea>')
+ this.set('bodyContent', '<textarea>'+value+'</textarea>');
}
},
@@ -64,12 +51,8 @@ Y.TextareaContainer = Y.Base.create("textarea-container", Y.Container, [], {
*/
bodyContent: {
value: '<textarea />'
- },
-
-
- resizable: {
- value: false
}
+
}
});
View
2 yuidoc.json
@@ -1,7 +1,7 @@
{
"name": "WireIt",
"description": "WireIt",
- "version": "3.0.0pr1",
+ "version": "3.0.0pr2",
"url": "http://neyric.github.com/wireit",
"options": {
"linkNatives": "true",

0 comments on commit b4042c2

Please sign in to comment.