sanj/oxjs
1
0
Fork 0
forked from 0x2620/oxjs
Code Pull requests Activity

add documentation stubs

Browse source
This commit is contained in:
j 2012-05-21 12:38:18 +02:00
commit 509745407b
102 changed files with 613 additions and 163 deletions
Download patch file Download diff file Expand all files Collapse all files

26
source/Ox.UI/js/Video/Ox.AnnotationFolder.js
View file

@ -1,5 +1,3 @@
// vim: et:ts=4:sw=4:sts=4:ft=javascript
'use strict';
/*@
@ -583,12 +581,20 @@ Ox.AnnotationFolder = function(options, self) {
return that;
};
/*@
blurItem <f> blur item
() -> <o> blur selected item
@*/
that.blurItem = function() {
self.editing = false;
self.$annotations.blurItem();
return that;
};
/*@
editItem <f> edit item
() -> <o> edit selected item
@*/
that.editItem = function() {
self.editing = true;
self.$panel.options({collapsed: false});
@ -596,15 +602,27 @@ Ox.AnnotationFolder = function(options, self) {
return that;
};
/*@
gainFocus <f> gain focus
() -> <o> gain focus
@*/
that.gainFocus = function() {
self.$annotations.gainFocus();
return that;
};
/*@
removeItem <f> remove item
() -> <o> remove selected item
@*/
that.removeItem = function() {
self.$annotations.removeItem();
};
/*@
selectItem <f> select item
(position) -> <o> select item at position
@*/
that.selectItem = function(position) {
// selects the first (0) or last (-1) visible annotation
if (self.annotations.length) {
@ -619,6 +637,10 @@ Ox.AnnotationFolder = function(options, self) {
}
};
/*@
updateItem <f> update item
(id, data) -> <o> update item
@*/
that.updateItem = function(id, data) {
var item = Ox.getObjectById(self.options.items, id);
Ox.forEach(data, function(value, key) {

20
source/Ox.UI/js/Video/Ox.AnnotationPanel.js
View file

@ -463,6 +463,10 @@ Ox.AnnotationPanel = function(options, self) {
}
};
/*@
addItem <f> add item
(layer, item) -> <o> add item to layer
@*/
that.addItem = function(layer, item) {
// called from addannotation callback
var i = Ox.getIndexById(self.options.layers, layer);
@ -476,18 +480,30 @@ Ox.AnnotationPanel = function(options, self) {
renderEditMenu();
};
/*@
blurItem <f> blur item
() -> <o> blur selected item
@*/
that.blurItem = function() {
self.editing = false;
getFolder(self.options.selected).blurItem();
renderEditMenu();
};
/*@
editItem <f> editItem
() -> <o> put selected item into edit mode
@*/
that.editItem = function() {
self.editing = true;
getFolder(self.options.selected).editItem();
renderEditMenu();
};
/*@
removeItem <f> removeItem
(remove) -> <o> remove item
@*/
that.removeItem = function(remove) {
if (remove) {
// remove initiated by video editor
@ -501,6 +517,10 @@ Ox.AnnotationPanel = function(options, self) {
}
};
/*@
updateItem <f> updateItem
(id, item) -> <o> update item
@*/
that.updateItem = function(id, item) {
// called from editannotation callback
// on the first update of a new annotation, the id will change

8
source/Ox.UI/js/Video/Ox.BlockVideoTimeline.js
View file

@ -1,7 +1,11 @@
// vim: et:ts=4:sw=4:sts=4:ft=javascript
'use strict';
/*@
Ox.BlockVideoTimeline <function> Block Video Timeline
(options[, self]) -> <o> Block Video Timeline
options <o> Options
self <o> Shared private variable
@*/
Ox.BlockVideoTimeline = function(options, self) {
self = self || {};

2
source/Ox.UI/js/Video/Ox.LargeVideoTimeline.js
View file

@ -1,5 +1,3 @@
// vim: et:ts=4:sw=4:sts=4:ft=javascript
'use strict';
/*@

1
source/Ox.UI/js/Video/Ox.SmallVideoTimeline.js
View file

@ -3,7 +3,6 @@
/*@
Ox.SmallVideoTimeline <f> Small Video Timeline
@*/
Ox.SmallVideoTimeline = function(options, self) {
self = self || {};

6
source/Ox.UI/js/Video/Ox.SmallVideoTimelineImage.js
View file

@ -1,5 +1,11 @@
'use strict';
/*@
Ox.SmallVideoTimelineImage <function> Small Video Timeline Image
(options[, self]) -> <o> Small Video Timeline Image
options <o> Options
self <o> Shared private variable
@*/
Ox.SmallVideoTimelineImage = function(options, self) {
self = self || {};

6
source/Ox.UI/js/Video/Ox.VideoEditor.js
View file

@ -1,5 +1,3 @@
// vim: et:ts=4:sw=4:sts=4:ft=javascript
'use strict';
/*@
@ -1409,6 +1407,10 @@ Ox.VideoEditor = function(options, self) {
self.$annotationPanel.addItem(layer, annotation);
};
/*@
updateAnnotation <f> updateAnnotation
(id, annotation) -> <o> update annotation with id
@*/
that.updateAnnotation = function(id, annotation) {
// called from editannotation callback
self.options.selected = annotation.id; // fixme: needed?

2
source/Ox.UI/js/Video/Ox.VideoEditorPlayer.js
View file

@ -1,5 +1,3 @@
// vim: et:ts=4:sw=4:sts=4:ft=javascript
'use strict';
/*@

2
source/Ox.UI/js/Video/Ox.VideoElement.js
View file

@ -1,5 +1,3 @@
// vim: et:ts=4:sw=4:sts=4:ft=javascript
'use strict';
/*@

2
source/Ox.UI/js/Video/Ox.VideoPanel.js
View file

@ -1,5 +1,3 @@
// vim: et:ts=4:sw=4:sts=4:ft=javascript
'use strict';
/*@

6
source/Ox.UI/js/Video/Ox.VideoPlayer.js
View file

@ -1,5 +1,3 @@
// vim: et:ts=4:sw=4:sts=4:ft=javascript
'use strict';
/*@
@ -2391,6 +2389,10 @@ Ox.VideoPlayer = function(options, self) {
}
};
/*@
changeVolume <f> change volume
(num) -> <o> change volume
@*/
that.changeVolume = function(num) {
changeVolume(num);
return that;

8
source/Ox.UI/js/Video/Ox.VideoPreview.js
View file

@ -1,7 +1,11 @@
// vim: et:ts=4:sw=4:sts=4:ft=javascript
'use strict';
/*@
Ox.VideoPreview <function> Video Preview
(options[, self]) -> <o> Video Preview
options <o> Options
self <o> Shared private variable
@*/
Ox.VideoPreview = function(options, self) {
self = self || {};

8
source/Ox.UI/js/Video/Ox.VideoTimelinePanel.js
View file

@ -1,5 +1,3 @@
// vim: et:ts=4:sw=4:sts=4:ft=javascript
'use strict';
/*@
@ -280,10 +278,14 @@ Ox.VideoTimelinePanel = function(options, self) {
}
};
/*@
toggleAnnotations <f> toggle annotations
() -> <o> toggle annotations
@*/
that.toggleAnnotations = function() {
that.$element.toggle(1);
};
return that;
};
};

12
source/Ox.UI/js/Video/Ox.VideoTimelinePlayer.js
View file

@ -1,7 +1,11 @@
// vim: et:ts=4:sw=4:sts=4:ft=javascript
'use strict';
/*@
Ox.VideoTimelinePlayer <function> Video Timeline Player
(options[, self]) -> <o> Video Timeline Player
options <o> Options
self <o> Shared private variable
@*/
Ox.VideoTimelinePlayer = function(options, self) {
self = self || {};
@ -802,6 +806,10 @@ Ox.VideoTimelinePlayer = function(options, self) {
}
};
/*@
togglePaused <f> toggle paused
() -> <o> toggle paused
@*/
that.togglePaused = function() {
togglePaused();
return that;