forked from 0x2620/oxjs
various documentation-related changes
This commit is contained in:
parent
b6fdf0c28b
commit
a6ed310087
13 changed files with 880 additions and 301 deletions
|
|
@ -1,4 +1,28 @@
|
|||
// vim: et:ts=4:sw=4:sts=4:ft=js
|
||||
|
||||
/*@
|
||||
Ox.Calendar <f> Basic calendar object
|
||||
() -> <f> Calendar object
|
||||
(options) -> <f> Calendar object
|
||||
(options, self) -> <f> Calendar object
|
||||
options <o> Options object
|
||||
date <d|new Date()> UTC Date on which the calendar is centered
|
||||
dates <[o]|[]> Date objects to be displayed
|
||||
end <s> End of the event (UTC Date, as string)
|
||||
name <s> Name of the event
|
||||
start <s> Start of the event (UTC Date, as string)
|
||||
type <s> Type of the event (like "person")
|
||||
height <n|256> Height in px
|
||||
range <[n]|[100, 5101]> Start and end year of the calendar
|
||||
width <n|256> Width in px
|
||||
zoom <n|8> Initial zoom level
|
||||
self <o> Shared private variable
|
||||
@*/
|
||||
|
||||
// Fixme: switch to UTC
|
||||
// Fixme: in options.dates, replace "stop" with "end"
|
||||
// Fixme: create a variable-resolution date type (with end that is _inclusive_)
|
||||
|
||||
Ox.Calendar = function(options, self) {
|
||||
|
||||
self = self || {};
|
||||
|
|
@ -6,9 +30,9 @@ Ox.Calendar = function(options, self) {
|
|||
.defaults({
|
||||
date: new Date(),
|
||||
dates: [],
|
||||
height: 512,
|
||||
range: [100, 5101],
|
||||
width: 512,
|
||||
height: 256,
|
||||
range: [1000, 3000],
|
||||
width: 256,
|
||||
zoom: 8
|
||||
})
|
||||
.options(options || {})
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue