jsduck 2.0.pre4 → 3.0.pre

data/template/app/view/cls/Overview.js

@@ -1,415 +0,0 @@
-/**
- * Renders the whole class-documentation page.
- */
-Ext.define('Docs.view.cls.Overview', {
-    extend: 'Ext.panel.Panel',
-    alias: 'widget.classoverview',
-    requires: [
-        'Docs.view.cls.Toolbar',
-        'Docs.Syntax',
-        'Docs.Settings'
-    ],
-
-    cls: 'class-overview iScroll',
-    autoScroll: true,
-    bodyPadding: '20',
-
-    /**
-     * Scrolls the specified element into view
-     *
-     * @param {String} query  DomQuery selector string.
-     */
-    scrollToEl: function(query) {
-        var el = Ext.get(Ext.query(query)[0]);
-        if (el) {
-            var isMember = el.hasCls("member");
-            var scrollOffset = el.getY() - (isMember ? 145 : 135);
-            var docContent = this.getEl().down('.x-panel-body');
-            var currentScroll = docContent.getScroll()['top'];
-            docContent.scrollTo('top', currentScroll + scrollOffset);
-
-            if (isMember && el.down(".expandable")) {
-                el.addCls('open');
-            }
-            el.highlight();
-        }
-    },
-
-    /**
-     * Renders class documentation in this panel.
-     *
-     * @param {Object} docClass
-     */
-    load: function(docClass) {
-        this.docClass = docClass;
-
-        if (this.toolbar) {
-            this.removeDocked(this.toolbar, true);
-        }
-        this.toolbar = Ext.create('Docs.view.cls.Toolbar', {
-            docClass: this.docClass,
-            listeners: {
-                hideInherited: function(hideInherited) {
-                    this.filterMembers(this.toolbar.getFilterValue(), hideInherited);
-                },
-                filter: function(search) {
-                    this.filterMembers(search, Docs.Settings.get("hideInherited"));
-                },
-                scope: this
-            }
-        });
-        this.addDocked(this.toolbar);
-
-        this.update(this.renderClass(docClass));
-        Docs.Syntax.highlight(this.getEl());
-
-        if (Docs.Settings.get("hideInherited")) {
-            this.filterMembers("", true);
-        }
-    },
-
-    /**
-     * Filters members by search string and inheritance.
-     * @param {String} search
-     * @param {Boolean} hideInherited
-     * @private
-     */
-    filterMembers: function(search, hideInherited) {
-        Docs.Settings.set("hideInherited", hideInherited);
-        var isSearch = search.length > 0;
-
-        // Hide the class documentation when filtering
-        Ext.Array.forEach(Ext.query('.doc-contents, .hierarchy'), function(el) {
-            Ext.get(el).setStyle({display: isSearch ? 'none' : 'block'});
-        });
-
-        // Hide members who's name doesn't match with the search string
-        // and hide inherited members if hideInherited=true
-        var re = new RegExp(Ext.String.escapeRegex(search), "i");
-        this.eachMember(function(m) {
-            var el = Ext.get(m.tagname + "-" + m.name);
-            var byInheritance = !hideInherited || (m.owner === this.docClass.name);
-            var byFilter = !isSearch || re.test(m.name);
-            if (byInheritance && byFilter) {
-                el.setStyle({display: 'block'});
-            }
-            else {
-                el.setStyle({display: 'none'});
-            }
-        }, this);
-
-        // Remove all first-child classes
-        Ext.Array.forEach(Ext.query('.member.first-child'), function(m) {
-            Ext.get(m).removeCls('first-child');
-        });
-
-        Ext.Array.forEach(['cfg', 'property', 'method', 'event'], function(type) {
-            var sectionId = '#m-' + type;
-
-            // Hide the section completely if all items in it are hidden
-            var visibleEls = this.getVisibleElements(sectionId + " .member");
-            var section = Ext.query(sectionId)[0];
-            section && Ext.get(section).setStyle({display: visibleEls.length > 0 ? 'block' : 'none'});
-
-            // Hide subsections completely if all items in them are hidden
-            Ext.Array.forEach(Ext.query(sectionId+" .subsection"), function(subsection) {
-                var visibleEls = this.getVisibleElements(".member", subsection);
-                if (visibleEls.length > 0) {
-                    // add first-child class to first member in subsection
-                    visibleEls[0].addCls('first-child');
-                    // make sure subsection is visible
-                    Ext.get(subsection).setStyle({display: 'block'});
-                }
-                else {
-                    // Hide subsection completely if empty
-                    Ext.get(subsection).setStyle({display: 'none'});
-                }
-            }, this);
-        }, this);
-
-        this.toolbar.hideInherited(hideInherited);
-    },
-
-    getVisibleElements: function(selector, root) {
-        var els = Ext.Array.map(Ext.query(selector, root), function(node) {
-            return Ext.get(node);
-        });
-        return Ext.Array.filter(els, function(el) {
-            return el.isVisible();
-        });
-    },
-
-    // Loops through each member of class
-    eachMember: function(callback, scope) {
-        Ext.Array.forEach(['members', 'statics'], function(group) {
-            Ext.Object.each(this.docClass[group], function(type, members) {
-                Ext.Array.forEach(members, callback, scope);
-            }, this);
-        }, this);
-    },
-
-    renderClass: function(cls) {
-        this.classTpl = this.classTpl || new Ext.XTemplate(
-            '<div>',
-                '{hierarchy}',
-                 '<div class="doc-contents">',
-                    '{doc}',
-                '</div>',
-                '<div class="members">',
-                    '{members}',
-                '</div>',
-            '</div>'
-        );
-
-        return this.classTpl.apply({
-            doc: cls.doc,
-            hierarchy: this.renderHierarchy(cls),
-            members: this.renderMembers(cls)
-        });
-    },
-
-    renderHierarchy: function(cls) {
-        if (cls.superclasses.length === 0 && cls.allMixins.length === 0 && cls.alternateClassNames.length === 0) {
-            return "";
-        }
-
-        this.hierarchyTpl = this.hierarchyTpl || new Ext.XTemplate(
-            '<pre class="hierarchy">',
-            '<tpl if="alternateClassNames.length &gt; 0">',
-                '<h4>Alternate names</h4>',
-                '<tpl for="alternateClassNames">',
-                    '<div class="alternate-class-name">{.}</div>',
-                '</tpl>',
-            '</tpl>',
-            '<tpl if="tree">',
-                '<h4>Hierarchy</h4>',
-                '{tree}',
-            '</tpl>',
-            '<tpl if="mixins.length &gt; 0">',
-                '<h4>Mixins</h4>',
-                '<tpl for="mixins">',
-                    '<div class="mixin">{.}</div>',
-                '</tpl>',
-            '</tpl>',
-            '</pre>'
-        );
-
-        return this.hierarchyTpl.apply({
-            tree: cls.superclasses.length ? this.renderClassTree(cls.superclasses.concat(cls.name), true) : "",
-            mixins: Ext.Array.map(cls.allMixins, this.renderLink, this),
-            alternateClassNames: cls.alternateClassNames
-        });
-    },
-
-    renderClassTree: function(superclasses, firstChild) {
-        if (superclasses.length === 0) {
-            return "";
-        }
-
-        this.classTreeTpl = this.classTreeTpl || new Ext.XTemplate(
-            '<div class="subclass {firstChild}">',
-              '{link}',
-              '{subtree}',
-            '</div>'
-        );
-
-        var name = superclasses[0];
-        return this.classTreeTpl.apply({
-            firstChild: firstChild ? 'first-child' : '',
-            link: superclasses.length > 1 ? this.renderLink(name) : '<strong>'+name+'</strong>',
-            subtree: this.renderClassTree(superclasses.slice(1))
-        });
-    },
-
-    renderLink: function(className) {
-        return Ext.String.format('<a href="#/api/{0}" rel="{0}" class="docClass">{0}</a>', className);
-    },
-
-    renderMembers: function(cls) {
-        var sections = [
-            {type: "cfg", title: "Config options"},
-            {type: "property", title: "Properties"},
-            {type: "method", title: "Methods"},
-            {type: "event", title: "Events"}
-        ];
-
-        // Skip rendering empty sections
-        return Ext.Array.map(sections, function(sec) {
-            var members = cls.members[sec.type];
-            var statics = cls.statics[sec.type];
-            return (members.length > 0 || statics.length > 0) ? this.renderSection(members, statics, sec) : "";
-        }, this).join("");
-    },
-
-    renderSection: function(members, statics, section) {
-        this.sectionTpl = this.sectionTpl || new Ext.XTemplate(
-            '<div id="m-{type}">',
-                '<tpl if="!statics.length">',
-                    '<div class="definedBy">Defined By</div>',
-                '</tpl>',
-                '<h3 class="members-title">{title}</h3>',
-                '<tpl if="members.length">',
-                    '<div class="subsection">',
-                        '<tpl if="statics.length">',
-                            '<div class="definedBy">Defined By</div>',
-                            '<h4 class="members-subtitle">Instance {title}</h3>',
-                        '</tpl>',
-                        '{members}',
-                    '</div>',
-                '</tpl>',
-                '<tpl if="statics.length">',
-                    '<div class="subsection">',
-                        '<div class="definedBy">Defined By</div>',
-                        '<h4 class="members-subtitle">Static {title}</h3>',
-                        '{statics}',
-                    '</div>',
-                '</tpl>',
-            '</div>'
-        );
-
-        return this.sectionTpl.apply({
-            type: section.type,
-            title: section.title,
-            members: Ext.Array.map(members, this.renderMemberDiv, this).join(""),
-            statics: Ext.Array.map(statics, this.renderMemberDiv, this).join("")
-        });
-    },
-
-    renderMemberDiv: function(member, index) {
-        this.memberTpl = this.memberTpl || new Ext.XTemplate(
-            '<div id="{tagname}-{name}" class="member {firstChild} {inherited}">',
-                // leftmost column: expand button
-                '<a href="#" class="side {expandable}">',
-                    '<span>&nbsp;</span>',
-                '</a>',
-                // member name and type + link to owner class and source
-                '<div class="title">',
-                    '<div class="meta">',
-                        '<a href="#/api/{owner}" rel="{owner}" class="definedIn docClass">{owner}</a><br/>',
-                        '<a href="source/{href}" target="_blank" class="viewSource">view source</a>',
-                    '</div>',
-                    '{signature}',
-                '</div>',
-                // short and long descriptions
-                '<div class="description">',
-                    '<div class="short">{[this.shortDoc(values)]}</div>',
-                    '<div class="long">{longDoc}</div>',
-                '</div>',
-            '</div>',
-            {
-                // Returns contents for short documentation
-                shortDoc: function(cfg) {
-                    return cfg.shortDoc ? cfg.shortDoc : cfg.doc;
-                }
-            }
-        );
-
-        return this.memberTpl.apply(Ext.apply({
-            // use classname "first-child" when it's first member in its category
-            firstChild: (index === 0) ? "first-child" : "",
-            // use classname "expandable" when member has shortened description
-            expandable: member.shortDoc ? "expandable" : "not-expandable",
-            // use classname "inherited" when member is not defined in this class
-            inherited: member.owner === this.docClass.name ? "not-inherited" : "inherited",
-            // method params signature or property type signature
-            signature: this.renderSignature(member),
-            // full documentation together with optional parameters and return value
-            longDoc: this.renderLongDoc(member)
-        }, member));
-    },
-
-    renderSignature: function(member) {
-        this.signatureTpl = this.signatureTpl || new Ext.XTemplate(
-            '{before}<a href="#/api/{member}-{tagname}-{name}" class="name {expandable}">{name}</a>{params}{after}'
-        );
-
-        var cfg = Ext.apply({}, member);
-        cfg.expandable = member.shortDoc ? "expandable" : "not-expandable";
-
-        if (member.tagname === "method" && member.name === "constructor") {
-            cfg.before = "<strong class='constructor-signature'>new</strong>";
-            cfg.name = this.docClass.name;
-        }
-
-        if (member.tagname === "cfg" || member.tagname === "property") {
-            cfg.params = "<span> : " + member.type + "</span>";
-        }
-        else {
-            var ps = Ext.Array.map(member.params, this.renderShortParam, this).join(", ");
-            cfg.params = '( <span class="pre">' + ps + "</span> )";
-            if (member.tagname === "method") {
-                cfg.params += " : " + member["return"].type;
-            }
-        }
-
-        if (member['protected']) {
-            cfg.after = "<strong class='protected-signature'>protected</strong>";
-        }
-        if (member['static']) {
-            cfg.after = "<strong class='static-signature'>static</strong>";
-        }
-        if (member.deprecated) {
-            cfg.after = "<strong class='deprecated-signature'>deprecated</strong>";
-        }
-
-        return this.signatureTpl.apply(cfg);
-    },
-
-    renderShortParam: function(param) {
-        var p = param.type + " " + param.name;
-        return param.optional ? "["+p+"]" : p;
-    },
-
-    renderLongDoc: function(member) {
-        var doc = member.doc;
-
-        if (member.deprecated) {
-            var v = member.deprecated.version ? "since " + member.deprecated.version : "";
-            doc += '<div class="deprecated">';
-            doc += Ext.String.format('<p>This {0} has been <strong>deprecated</strong> {1}</p>', member.tagname, v);
-            doc += member.deprecated.text;
-            doc += '</div>';
-        }
-
-        if (member.params && member.params.length > 0) {
-            doc += '<h3 class="pa">Parameters</h3>';
-            var ps = Ext.Array.map(member.params, this.renderLongParam, this).join("");
-            doc += "<ul>" + ps + "</ul>";
-        }
-
-        if (member["return"]) {
-            doc += this.renderReturn(member["return"]);
-        }
-
-        return doc;
-    },
-
-    renderLongParam: function(param) {
-        this.paramTpl = this.paramTpl || new Ext.XTemplate(
-            '<li>',
-                '<span class="pre">{name}</span> : {type}',
-                '<div class="sub-desc">',
-                    '{doc}',
-                '</div>',
-            '</li>'
-        );
-
-        return this.paramTpl.apply(param);
-    },
-
-    renderReturn: function(returnDoc) {
-        this.returnTpl = this.returnTpl || new Ext.XTemplate(
-            '<h3 class="pa">Returns</h3>',
-            '<ul>',
-                '<li>',
-                    '<span class="pre">{type}</span>',
-                    '<div class="sub-desc">',
-                        '{doc}',
-                    '</div>',
-                '</li>',
-            '</ul>'
-        );
-
-        return this.returnTpl.apply(returnDoc);
-    }
-});

data/template/app/view/cls/Toolbar.js

@@ -1,199 +0,0 @@
-/**
- * Toolbar with menus providing quick access to class members.
- */
-Ext.define('Docs.view.cls.Toolbar', {
-    extend: 'Ext.toolbar.Toolbar',
-    requires: [
-        'Docs.view.HoverMenuButton',
-        'Docs.Settings',
-        'Ext.form.field.Checkbox'
-    ],
-
-    dock: 'top',
-    cls: 'member-links',
-    padding: '3 5',
-
-    /**
-     * @cfg {Object} docClass
-     * Documentation for a class.
-     */
-    docClass: {},
-
-    initComponent: function() {
-        this.addEvents(
-            /**
-             * @event hideInherited
-             * Fires when hideInherited checkbox toggled.
-             * @param {Boolean} hide  True when inherited items should get hidden.
-             */
-            "hideInherited",
-            /**
-             * @event filter
-             * Fires when text typed to filter.
-             * @param {String} search  The search text.
-             */
-            "filter",
-            /**
-             * @event toggleExpanded
-             * Fires expandAll/collapseAll buttons clicked.
-             * @param {Boolean} expand  True to expand all, false to collapse all.
-             */
-            "toggleExpanded"
-        );
-
-        this.items = [];
-        this.memberButtons = {};
-
-        var memberTitles = {
-            cfg: "Configs",
-            property: "Properties",
-            method: "Methods",
-            event: "Events"
-        };
-        for (var type in memberTitles) {
-            var members = this.docClass.members[type];
-            var statics = this.docClass.statics[type];
-            if (members.length || statics.length) {
-                var btn = this.createMemberButton({
-                    text: memberTitles[type],
-                    type: type,
-                    members: members.concat(statics)
-                });
-                this.memberButtons[type] = btn;
-                this.items.push(btn);
-            }
-        }
-
-        if (this.docClass.subclasses.length) {
-            this.items.push(this.createClassListButton("Sub Classes", this.docClass.subclasses));
-        }
-        if (this.docClass.mixedInto.length) {
-            this.items.push(this.createClassListButton("Mixed Into", this.docClass.mixedInto));
-        }
-
-        this.items = this.items.concat([
-            { xtype: 'tbspacer', width: 10 },
-            this.filterField = Ext.widget("textfield", {
-                emptyText: 'Find class members...',
-                enableKeyEvents: true,
-                listeners: {
-                    keyup: function(cmp) {
-                        this.fireEvent("filter", cmp.getValue());
-                    },
-                    specialkey: function(cmp, event) {
-                        if (event.keyCode === Ext.EventObject.ESC) {
-                            cmp.reset();
-                            this.fireEvent("filter", "");
-                        }
-                    },
-                    scope: this
-                }
-            }),
-            { xtype: 'tbfill' },
-            {
-                boxLabel: 'Hide inherited',
-                boxLabelAlign: 'before',
-                xtype: 'checkbox',
-                margin: '0 5 0 0',
-                padding: '0 0 5 0',
-                checked: Docs.Settings.get("hideInherited"),
-                handler: function(el) {
-                    this.fireEvent("hideInherited", el.checked);
-                },
-                scope: this
-            },
-            {
-                xtype: 'button',
-                iconCls: 'expandAllMembers',
-                tooltip: "Expand all",
-                enableToggle: true,
-                toggleHandler: function(btn, pressed) {
-                    btn.setIconCls(pressed ? 'collapseAllMembers' : 'expandAllMembers');
-                    btn.setTooltip(pressed ? "Collapse all" : "Expand all");
-                    this.fireEvent("toggleExpanded", pressed);
-                },
-                scope: this
-            }
-        ]);
-
-        this.callParent(arguments);
-    },
-
-    createMemberButton: function(cfg) {
-        var data = Ext.Array.map(cfg.members, function(m) {
-            return this.createLinkRecord(this.docClass.name, m);
-        }, this);
-
-        return Ext.create('Docs.view.HoverMenuButton', {
-            text: cfg.text,
-            cls: 'icon-'+cfg.type,
-            store: this.createStore(data),
-            showCount: true,
-            listeners: {
-                click: function() {
-                    this.up('classoverview').scrollToEl("#m-" + cfg.type);
-                },
-                scope: this
-            }
-        });
-    },
-
-    createClassListButton: function(text, classes) {
-        var data = Ext.Array.map(classes, function(cls) {
-            return this.createLinkRecord(cls);
-        }, this);
-
-        return Ext.create('Docs.view.HoverMenuButton', {
-            text: text,
-            cls: 'icon-subclass',
-            showCount: true,
-            store: this.createStore(data)
-        });
-    },
-
-    // creates store tha holds link records
-    createStore: function(records) {
-        var store = Ext.create('Ext.data.Store', {
-            fields: ['id', 'cls', 'url', 'label', 'inherited', 'static']
-        });
-        store.add(records);
-        return store;
-    },
-
-    // Creates link object referencing a class (and optionally a class member)
-    createLinkRecord: function(cls, member) {
-        return {
-            cls: cls,
-            url: member ? cls+"-"+member.tagname+"-"+member.name : cls,
-            label: member ? ((member.name === "constructor") ? cls : member.name) : cls,
-            inherited: member ? member.owner !== cls : false,
-            'static': member ? member['static'] : false
-        };
-    },
-
-    /**
-     * Hides or unhides inherited members in dropdown menus.
-     * @param {Boolean} hide
-     */
-    hideInherited: function(hide) {
-        Ext.Array.forEach(['cfg', 'property', 'method', 'event'], function(type) {
-            if (this.memberButtons[type]) {
-                var store = this.memberButtons[type].getStore();
-                if (hide) {
-                    store.filterBy(function(m) { return !m.get("inherited"); });
-                }
-                else {
-                    store.clearFilter();
-                }
-            }
-        }, this);
-    },
-
-    /**
-     * Returns the current text in filter field.
-     * @return {String}
-     */
-    getFilterValue: function() {
-        return this.filterField.getValue();
-    }
-});

data/template/app/view/index/Container.js

@@ -1,62 +0,0 @@
-/**
- * List of classes on front page.
- * Together with links to guides and icons legend.
- */
-Ext.define('Docs.view.index.Container', {
-    extend: 'Ext.container.Container',
-    alias : 'widget.indexcontainer',
-    cls: 'class-list',
-
-    initComponent: function() {
-        this.tpl = new Ext.XTemplate(
-            '<h1 class="top">{title}</h1>',
-            '<tpl if="notice">',
-                '<div class="notice">{notice}</div>',
-            '</tpl>',
-            '<div class="section legend">',
-                '<h4>Legend</h4>',
-                '<ul>',
-                    '<li class="icon icon-pkg">Package</li>',
-                    '<li class="icon icon-class">Class</li>',
-                    '<li class="icon icon-singleton">Singleton</li>',
-                    '<li class="icon icon-component">Component</li>',
-                    '<li class="icon icon-guide">Guide</li>',
-                '</ul>',
-            '</div>',
-            '<tpl if="guides">',
-                '<div class="section guides">',
-                    '<h1>Guides</h1>',
-                    '{guides}',
-                    '<div class="examples">',
-                        '<a href="http://dev.sencha.com/deploy/ext-4.0.2a/examples/index.html">View the Ext 4.0 examples &rarr;</a>',
-                    '</div>',
-                '</div>',
-            '</tpl>',
-            '{categories}'
-        );
-        this.data = this.extractData();
-        
-        this.callParent(arguments);
-    },
-
-    // Extracts HTML from hidden elements in page
-    extractData: function() {
-        var data = {
-            notice: Ext.get("notice-text"),
-            guides: Ext.get("guides-content"),
-            categories: Ext.get("categories-content")
-        };
-        for (var i in data) {
-            var el = data[i];
-            if (el) {
-                // If page contains the div then extract its contents,
-                // after that remove the original
-                data[i] = el.dom.innerHTML;
-                el.remove();
-            }
-        }
-        // Extract <title> text
-        data.title = Ext.query("title")[0].innerHTML;
-        return data;
-    }
-});