forked from 0x2620/oxjs
some documentation
This commit is contained in:
parent
275dcbb356
commit
bdb8d98787
45 changed files with 775 additions and 255 deletions
|
|
@ -1,5 +1,19 @@
|
|||
/*@
|
||||
Ox.DocPanel <f> Documentation Panel
|
||||
() -> <f> Documentation Panel
|
||||
(options) -> <f> Documentation Panel
|
||||
(options, self) -> <f> Documentation Panel
|
||||
options <o> Options object
|
||||
collapsible <b|true> can be collabsed
|
||||
files <a|[]> files to parse for docs
|
||||
getModule <f> returns module for given item
|
||||
getSection <f> returns section for given item
|
||||
path <s|''> path prefix
|
||||
resizable <b|true> is resizable
|
||||
resize <a|[128, 256, 384]> resize positions
|
||||
size <s|256> default size
|
||||
self <o> shared private variable
|
||||
load <!> fired once all docs are loaded
|
||||
@*/
|
||||
|
||||
Ox.DocPanel = function(options, self) {
|
||||
|
|
@ -43,6 +57,7 @@ Ox.DocPanel = function(options, self) {
|
|||
|
||||
loadList(function(docItems) {
|
||||
self.items = docItems;
|
||||
that.triggerEvent('load', {});
|
||||
});
|
||||
|
||||
function loadList(callback) {
|
||||
|
|
@ -58,6 +73,7 @@ Ox.DocPanel = function(options, self) {
|
|||
}
|
||||
});
|
||||
});
|
||||
|
||||
function makeTree(docItems) {
|
||||
var treeItems = [];
|
||||
docItems.forEach(function(docItem) {
|
||||
|
|
@ -145,6 +161,7 @@ Ox.DocPanel = function(options, self) {
|
|||
});
|
||||
}
|
||||
}
|
||||
that.triggerEvent('select', data);
|
||||
}
|
||||
|
||||
function sortByTitle(a, b) {
|
||||
|
|
@ -156,7 +173,14 @@ Ox.DocPanel = function(options, self) {
|
|||
}
|
||||
return ret;
|
||||
}
|
||||
|
||||
/*@
|
||||
selectItem <f> select item
|
||||
(id) -> <u> select an item
|
||||
id <s> if of item to select
|
||||
@*/
|
||||
that.selectItem = function(id) {
|
||||
self.$list.triggerEvent('select', {'ids': [id]});
|
||||
}
|
||||
return that;
|
||||
|
||||
};
|
||||
};
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue