oxjs/examples/documentation/oxdoc/js/example.js

/*
**OxDoc Tutorial**
*/
'use strict';
/*
An OxDoc comment is an inline or  multi-line comment that starts with `@`:
```
//@ ...
/*@
...
*/
```
The syntax is simple: almost every line has the form `name <type> summary`. If
it doesn't, its meaning depends on its context. 
*/
this.My = {};

/*
If the first line of the comment doesn't match `name <type> summary`, it is a
section definition. Here, it marks a section named 'Primitives'.
*/
//@ Primitives

/*
This inline comment documents an item by providing its name, type and one-line
summary.
*/
//@ My.REQUEST_TIMEOUT <number> Request timeout, in milliseconds
My.REQUEST_TIMEOUT = 60000;

/*
In a multiline comment, lines that follow the inital definition are indented, as
they refer to the item defined in the line above. Lines that don't match `name
<type> summary` are parsed as a description. Like the summary, the description
can contain `markdown`.
*/
/*@
My.MAGIC_CONSTANT <number> Magic constant, needed for HTTP requests
    Please note that the value of `My.MAGIC_CONSTANT` (either `23` or `42`) is
    browser-dependent.
*/
My.MAGIC_CONSTANT = navigator.userAgent.length % 2 ? 23 : 42;

/*
This defines a new section named 'Objects'.
*/
//@ Objects

/*
Lines that start with `#` are inline comments. The follwing lines document
properties of the `My.favorites` object. This example shows all possible values
for `type`. These values can be shortened, it's sufficient to specify their
first character.
*/
/*@
My.favorites <object> ...
    # Properties  --------------------------------------------------------------
    array       <a> My favorite array
    boolean     <b> My favorite boolean value
    date        <d> My favorite date
    error       <e> My favorite error
    function    <f> My favorite function
    arguments   <g> My favorite arguments
    htmlelement <h> My favorite HTML element
    nodelist    <l> My favorite nodelist
    number      <n> My favorite number
    object      <o> My favorite object
    regexp      <r> My favorite regular expression
    string      <s> My favorite string
    undefined   <u> Undefined is an all-time favorite
    window      <w> ...
    other       <+> ...
    any         <*> Favorite of the day
    # Events -------------------------------------------------------------------
    event       <!> Fires when My.favorite['function'] is called
*/
My.favorites = (function() {
    var favorites = {
            array: [],
            boolean: false,
            date: new Date(),
            error: new Error(),
            'function': function() {
                My.triggerEvent(this, 'event');
            },
            arguments: (function() { return arguments; }()),
            htmlelement: document.createElement('a'),
            nodelist: document.getElementsByTagName('a'),
            number: 0,
            object: {},
            regexp: new RegExp(),
            string: '',
            'undefined': void 0,
            'window': window,
            other: document
        },
        keys = Object.keys(favorites);
    favorites.any = favorites[keys[Math.floor(Math.random() * keys.length)]];
    return favorites;
}());

/*
Documentation can be nested. In other words, one can document the properties of
a property (of a property...). Also, if all elements of an array are of a known
type (in this case `string`), one can mark the type as `<[s]>` instead of just
`<array>`.
*/
/*@
My.HTMLUtils <o> HTML Utilities
    namedEntities <[s]> Named HTML entities
    replace <o> Entity decoding utilities
        namedEntities <a> Can be passed to `String.prototype.replace`
            0 <r> Matches named entities
            1 <f> Decodes named entities
        numericEntities <a> Can be passed to `String.prototype.replace`
            0 <r> Matches numeric entities
            1 <f> Decodes numeric entities
*/
My.HTMLUtils = (function() {
    var chars = '"&\'<>',
        entities = ['&quot;', '&amp;', '&apos;', '&lt;', '&gt;'];
    return {
        namedEntities: entities,
        replace: {
            namedEntities: [
                new RegExp('(' + entities.join('|') + ')', 'g'),
                function(match) {
                    return chars[entities.indexOf(match)];
                }
            ],
            numericEntities: [
                /&#([0-9A-FX]+);/gi,
                function(match, code) {
                    return String.fromCharCode(
                        /^X/i.test(code)
                            ? parseInt(code.slice(1), 16)
                            : parseInt(code, 10)
                    );
                }
            ],
        }
    };
}());

/*
The beginning of another section, named 'Functions'.
*/
//@ Functions

/*
In the case of a function, the indented lines don't document properties, but the
function's signature, return value and arguments. Signature and return value are
just a special case of `name <type> summary`, where `name` has the form
`(arguments) ->`. If an item can be of more than one type (in this case `string`
or `function`), this is documented as `<s|f>`. If it has a default value (in
this case the string `'GET'`), this is documented as `<s|'GET'>`. In the case of
a `function`-type argument (usually a callback function), there is no return
value to document, only the arguments it gets passed.
*/
/*@
My.readURL <f> Asynchronously reads a remote resource
    (url[, method], callback) -> <u> undefined
        Please note that the return value of `My.readURL` may change in the
        future.
    url <s|f> Remote URL, or function that returns one
    method <s|'GET'> Request method ('GET', 'POST', 'PUT' or 'DELETE')
    callback <f> Callback function
        result <s|null> Response text, or `null` in case of an error
        error <o|null> Error object, or `null` in case of success
            code <n> Error code
            text <s> Error text
*/
My.readURL = function(url, method, callback) {
    var request = new XMLHttpRequest();
    if (Ox.isFunction(url)) {
        url = url();
    }
    if (arguments.length == 2) {
        callback = method;
        method = 'GET';
    }
    request.open(method, url, true);
    request.onreadystatechange = function() {
        if (request.readyState == 4) {
            if (request.status == 200) {
                callback(request.responseText, null);
            } else {
                callback(null, {
                    code: request.status,
                    text: request.statusText
                });
            }
        }
    };
    request.send();
};

/*
If a function's return value depends on the absence or presence of optional
arguments, there can be multiple `(arguments) -> <type> summary` lines.
*/
/*@
My.isOdd <f> Synchronously or asynchronously computes if a given number is odd
    (number) -> <b> True if the number is odd
    (number, callback) -> <u> undefined
    number <n> Any number
    callback <f> Callback function
        isOdd <b> True if the number is odd
        ms <n> Time it took to compute the result, in milliseconds
*/
My.isOdd = function(number, callback) {
    var time = +new Date, isOdd = !!(number % 2);
    if (callback) {
        callback(isOdd, +new Date - time);
    } else {
        return isOdd;
    }
};

/*
Another case for multiple `(arguments) -> <type> summary` lines are functions
whose signature cannot be represented in `(required[, optional])` notation. For
a range function — `(stop)` or `(start, stop)` or `(start, stop, step)` — the
notation `([start, ]stop[, step])` would be ambigious, since you cannot call it
with `(stop, step)`.
*/
/*@
My.range <f> Returns a python-style range
    (b)       -> <[n]> Integers from 0 (inclusive) to b (exclusive)
    (a, b)    -> <[n]> Integers from a (inclusice) to b (exclusive)
    (a, b, c) -> <[n]> Numbers from a (inclusive) to b (exclusive), growing by c
*/
My.range = function() {
    var a = [];
    Ox.loop.apply(null, Ox.toArray(arguments).concat(function(i) {
        a.push(i);
    }));
    return a;
};

/*
In case a function has a property or method one wants to document, it gets
prefixed with `.`, in order to differentiate it from an argument.
*/
/*@
My.localStorage <f> Returns a localStorage handler for a given namespace
    (ns) -> storage <f> localStorage handler
        () -> <o> Returns all key:value pairs
        (key) -> <*> Returns one value
        (key, value) -> <f> Sets one value, returns the handler
        ({key: value, ...}) -> <f> Sets one or more values, returns the handler
        key <s> Any string
        value <*> Any value that can be JSON-serialized
        .delete <f> Delete method
            () -> <f> Deletes all key:value pairs, returns the handler
            (key[, ...]) -> <f> Deletes one or more pairs, returns the handler
            key <s> Any string
    ns <s> Namespace
*/
My.localStorage = (function() {
    if (!window.localStorage) {
        window.localStorage = {};
    }
    return function(ns) {
        function storage(key, value) {
            var args, ret;
            if (arguments.length == 0) {
                ret = {};
                Ox.forEach(localStorage, function(value, key) {
                    if (Ox.startsWith(key, ns + '.')) {
                        ret[key.slice(ns.length + 1)] = JSON.parse(value);
                    }
                });
            } else if (arguments.length == 1 && !Ox.isObject(key)) {
                value = localStorage[ns + '.' + key];
                ret = Ox.isUndefined(value) ? void 0 : JSON.parse(value);
            } else {
                Ox.forEach(Ox.makeObject(arguments), function(value, key) {
                    localStorage[ns + '.' + key] = JSON.stringify(value);
                });
                ret = this;
            }
            return ret;
        };
        storage.delete = function() {
            var keys = arguments.length == 0 ? Object.keys(storage())
                : Ox.toArray(arguments)
            keys.forEach(function(key) {
                delete localStorage[ns + '.' + key];
            });
            return storage;
        };
        return storage;
    };
}());

/*
And one more section, named 'UI Elements'.
*/
//@ UI Elements

/*
When documenting a constructor function, the returned object may come with a lot
more documentation than the function itself. In this case, one may want to
document the contructor's arguments first, then the signature and return value,
follwed by the documentation of the returned object.
*/
/*@
My.Box <f> A very simple colored box
    options <o> Options
        color <[n]> RGB value
    self <o> Shared private object
    ([options[, self]]) -> <o> Box object
        change <!> Fires when the color of the box changes
            color <n> Value between `0` and `255`
*/
My.Box = function(options, self) {
    self = self || {};
    var that = Ox.Element({}, self)
        .defaults({color: [255, 0, 0]})
        .options(options || {})
        .update(setColor)
        .css({width: '256px', height: '256px'});
    setColor();
    function setColor() {
        that.css({background: 'rgb(' + self.options.color.join(', ') + ')'});
        if (arguments.length) {
            that.triggerEvent('change', {color: self.options.color});
        }
    }
    /*
    It can be more convenient to document properties at the place where they are
    defined. A name prefixed with a `.` signals that what follows is not a
    standalone item, but a property of the previous one (or, in case the
    previous item is a function that returns an object, a property of the
    retuned object).
    */
    /*@
    .getHSL <f> Returns the color of the box as HSL value
        () -> <[n]> HSL value
    */
    that.getHSL = function() {
        return Ox.hsl(self.options.value);
    };
    /*@
    .setHSL <f> Sets the color of the box to a given HSL value
        (hsl) -> <o> The Box object
        hsl <[n]> HSL value
    */
    that.setHSL = function(hsl) {
        return that.options({color: Ox.rgb(hsl)});
    };
    /*@
    .toGrayscale <f> Changes the color of the box to grayscale.
        () -> <o> The Box object
    */
    that.toGrayscale = function() {
        return that.options({
            color: Ox.repeat([Ox.avg(self.options.color)], 3)
        });
    };
    return that;
};

/*@
My.ExtendedBox <f> ...
    options <o> Options
        height <n> Height in px
        width <n> Width in px
    self <o> Shared private object
    ([options[, self]]) -> <o:My.Box> Extended Box object
*/
My.ExtendedBox = function(options, self) {
    self = self || {};
    var that = My.Box({}, self)
        .defaults({
            height: 256,
            width: 256
        })
        .options(options || {})
        .update(function(key, value) {
            if (key == 'width' || key == 'height') {
                setSize();
            }
        })
        .css({
        });
    randomize();
    setSize();
    function randomize() {
        that.options({
            color: Ox.range(3).map(function() {
                return Ox.random(256);
            })
        });
    }
    function setSize() {
        that.css({
            width: self.options.width + 'px',
            height: self.options.height + 'px'
        })
    }
    /*@
    .randomize <f> Randomizes the colors of the box
        () -> <o> The Extended Box object
    */
    that.randomize = randomize;
    return that;
};

//@
/*
And finally, this is how everything gets parsed and displayed, in less than 30
lines of code. Note that it would be more efficient to parse the source once
```
var doc = Ox.doc(source);
```
and use
```
Ox.SyntaxHighlighter({
    showLineNumbers: true,
    source: source
})
```
and
```
Ox.TreeList({data: doc})
```
and
```
Ox.DocPanel({
    expanded: true,
    items: doc,
    getModule: function() { return 'My'; },
    path: path,
    stripComments: true
});
```
— but the thing we want to demonstrate here is that we can just pass files to
Ox.SyntaxHighlighter and Ox.DocPanel, and they'll do the rest.
*/
Ox.load('UI', function() {
    var file = 'example.js',
        path = Ox.PATH + '../examples/documentation/oxdoc/js/';
    Ox.get(path + file, function(source) {
        Ox.TabPanel({
            content: function(id) {
                return id == 'source' ? Ox.SyntaxHighlighter({
                        file: path + file,
                        showLineNumbers: true,
                    }).css({overflowY: 'scroll'})
                    : id == 'items' ? Ox.TreeList({data: Ox.doc(source)})
                    : Ox.DocPanel({
                        expanded: true,
                        files: [file],
                        getModule: function() { return 'My'; },
                        path: path,
                        stripComments: true
                    });
            },
            tabs: [
                {id: 'source', title: 'Source Code', selected: true},
                {id: 'items', title: 'Parsed Documentation'},
                {id: 'panel', title: 'Documentation Browser'}
            ]
        }).appendTo(Ox.$body);
    });
});