jsduck 3.1.0 → 3.2.1

data/lib/jsduck/tag/protected.rb

@@ -0,0 +1,14 @@
+require "jsduck/meta_tag"
+
+module JsDuck::Tag
+  # Implementation of @protected tag
+  class Protected < JsDuck::MetaTag
+    def initialize
+      @name = "protected"
+      @key = :protected
+      @signature = {:long => "protected", :short => "PRO"}
+      @boolean = true
+    end
+  end
+end
+

data/lib/jsduck/tag/readonly.rb

@@ -0,0 +1,14 @@
+require "jsduck/meta_tag"
+
+module JsDuck::Tag
+  # Implementation of @readonly tag
+  class Readonly < JsDuck::MetaTag
+    def initialize
+      @name = "readonly"
+      @key = :readonly
+      @signature = {:long => "readonly", :short => "R O"}
+      @boolean = true
+    end
+  end
+end
+

data/lib/jsduck/tag/required.rb

@@ -0,0 +1,21 @@
+require "jsduck/meta_tag"
+
+module JsDuck::Tag
+  # There is no @required tag.
+  # Instead the :required attribute is detected after @cfg:
+  #
+  #    @cfg {Type} someName (required)
+  #
+  # This class is only used for displaying the required attribute, not
+  # for detecting it.  The detection is done with custom logic in
+  # DocParser and Merger classes.
+  class Required < JsDuck::MetaTag
+    def initialize
+      @name = "--non-matching-requried-tag--"
+      @key = :required
+      @signature = {:long => "required", :short => "REQ"}
+      @boolean = true
+    end
+  end
+end
+

data/lib/jsduck/tag/static.rb

@@ -0,0 +1,14 @@
+require "jsduck/meta_tag"
+
+module JsDuck::Tag
+  # Implementation of @static tag
+  class Static < JsDuck::MetaTag
+    def initialize
+      @name = "static"
+      @key = :static
+      @signature = {:long => "static", :short => "STA"}
+      @boolean = true
+    end
+  end
+end
+

data/lib/jsduck/tag/template.rb

@@ -0,0 +1,23 @@
+require "jsduck/meta_tag"
+
+module JsDuck::Tag
+  # Implementation of @template tag
+  class Template < JsDuck::MetaTag
+    def initialize
+      @name = "template"
+      @key = :template
+      @signature = {:long => "template", :short => "TMP"}
+      @boolean = true
+    end
+
+    def to_html(contents)
+      <<-EOHTML
+      <div class='signature-box template'>
+      <p>This is a template method. A hook into the functionality of this class.
+         Feel free to override it in child classes.</p>
+      </div>
+      EOHTML
+    end
+  end
+end
+

data/opt/example.js

@@ -0,0 +1,149 @@
+/**
+ * An example class showcasing the features of JSDuck.
+ *
+ * **Markdown** is supported thoughout the [docs][1].
+ *
+ * Link to {@link Ext.form.field.Text external class} and
+ * {@link Ext.form.field.Text#reset its method}.
+ * Link to {@link #setSize method of this class}.
+ *
+ * {@img some/path.png Alt text}
+ *
+ * An embedded live example:
+ *
+ *     @example
+ *     Ext.create('Ext.master.Switch', {
+ *         text: 'Click me, please!',
+ *         handler: function() {
+ *             alert('You clicked me!')
+ *         }
+ *     });
+ *
+ * **Note:** this is not a fully working example. When you run it
+ * through JSDuck you will get warnings about a lot of missing classes
+ * that this example class references, additionally it doesn't make
+ * sense for singleton class to have static methods.
+ *
+ * [1]: http://docs.sencha.com/ext-js/4.0/
+ */
+Ext.define('Ext.master.Switch', {
+    // These are all detected automatically
+    // No need to use @extends, @alternateClassName, @mixin, @alias, @singleton
+    extend: 'Ext.button.Button',
+    alternateClassName: 'Ext.MasterSwitch',
+    mixins: {
+        observable: 'Ext.util.Observable',
+        floating: 'Ext.util.Floating'
+    },
+    alias: 'widget.masterswitch',
+    singleton: true,
+
+    /**
+     * @cfg {String} [text="Click Me!"]
+     * A config option with explicit type, name, and default value.
+     */
+
+    config: {
+        /**
+         * @cfg
+         * A config option with type, name, and default value
+         * auto-detected.  Additionally docs for getIcon and setIcon
+         * accessor methods are generated.
+         * @accessor
+         */
+        icon: "some/file.png"
+    },
+
+    /**
+     * @cfg {String} name (required)
+     * A very importand config option that must be specified.
+     */
+
+    /**
+     * @property {Object} size
+     * A property with explicit type name and name.
+     * It's an object containing the following fields:
+     * @property {Number} size.width The width.
+     * @property {Number} size.height The height.
+     */
+
+    /**
+     * A property with auto-detected type and name.
+     */
+    disabled: false,
+
+    /**
+     * Constructor documentation.
+     * @param {Object} [cfg] An optional config object
+     */
+    constructor: function(cfg) {
+        Ext.apply(this, cfg || {});
+        this.addEvents(
+            /**
+             * @event
+             * Fired when button clicked.
+             * @param {Ext.master.Switch} this
+             * @param {Number} times The number of times clicked.
+             */
+            "click"
+        );
+    },
+
+    /**
+     * Sets the size.
+     * @param {Object} size An object describing width and height:
+     * @param {Number} [size.width=0] The width.
+     * @param {Number} [size.height=0] The height.
+     */
+    setSize: function(size) {
+        this.size = size;
+    },
+
+    /**
+     * Returns the size of component.
+     * @return {Object} Object with properties:
+     * @return {Number} return.width The width.
+     * @return {Number} return.height The height.
+     * @method
+     */
+    getSize: (function() {
+        return function() { return this.size; };
+    })(),
+
+    statics: {
+        /**
+         * Filters out subcomponents.
+         * @param {Function} fn Callback function.
+         * @param {Ext.Component} fn.cmp The component parameter.
+         * @param {Number} fn.index Component index parameter.
+         * @param {Boolean} fn.return The return value of callback
+         * must be true to include the component, false to exclude.
+         * @param {Object} scope Scope for the callback.
+         * @return {Ext.Component[]} Array of components.
+         * @static
+         */
+        filter: function(fn, scope) {
+            return this.items.filter(fn, scope);
+        }
+    },
+
+    inheritableStatics: {
+        /**
+         * Achieves something.
+         * @static
+         * @inheritable
+         */
+        doSomething: function() {
+        }
+    }
+});
+
+Ext.apply(Ext, {
+    /**
+     * A method belonging to Ext.
+     * @member Ext
+     * @method
+     * @inheritdoc Ext.master.Switch#setSize
+     */
+    setMasterSwitchSize: Ext.master.Switch.setSize
+});

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jsduck
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 13
   prerelease: false
   segments: 
   - 3
+  - 2
   - 1
-  - 0
-  version: 3.1.0
+  version: 3.2.1
 platform: ruby
 authors: 
 - Rene Saarsoo
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-16 00:00:00 +02:00
+date: 2011-12-07 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -91,14 +91,12 @@ files:
 - lib/jsduck/app.rb
 - lib/jsduck/app_data.rb
 - lib/jsduck/app_exporter.rb
-- lib/jsduck/author_tag.rb
 - lib/jsduck/auto_categories.rb
 - lib/jsduck/categories.rb
 - lib/jsduck/class.rb
 - lib/jsduck/class_formatter.rb
 - lib/jsduck/class_writer.rb
 - lib/jsduck/css_parser.rb
-- lib/jsduck/doc_author_tag.rb
 - lib/jsduck/doc_formatter.rb
 - lib/jsduck/doc_parser.rb
 - lib/jsduck/examples.rb
@@ -119,6 +117,7 @@ files:
 - lib/jsduck/merger.rb
 - lib/jsduck/meta_tag.rb
 - lib/jsduck/meta_tag_loader.rb
+- lib/jsduck/meta_tag_registry.rb
 - lib/jsduck/null_object.rb
 - lib/jsduck/options.rb
 - lib/jsduck/os.rb
@@ -129,13 +128,22 @@ files:
 - lib/jsduck/source_file.rb
 - lib/jsduck/source_writer.rb
 - lib/jsduck/stats.rb
+- lib/jsduck/tag/abstract.rb
+- lib/jsduck/tag/author.rb
+- lib/jsduck/tag/deprecated.rb
+- lib/jsduck/tag/docauthor.rb
+- lib/jsduck/tag/markdown.rb
+- lib/jsduck/tag/preventable.rb
+- lib/jsduck/tag/protected.rb
+- lib/jsduck/tag/readonly.rb
+- lib/jsduck/tag/required.rb
+- lib/jsduck/tag/static.rb
+- lib/jsduck/tag/template.rb
 - lib/jsduck/template_dir.rb
 - lib/jsduck/type_parser.rb
 - lib/jsduck/videos.rb
 - lib/jsduck/welcome.rb
-- opt/extjs-welcome.html
-- opt/touch-iframe.html
-- opt/touch-welcome.html
+- opt/example.js
 - template-min/README.md
 - template-min/template.html
 - template-min/eg-iframe.html

data/opt/extjs-welcome.html

@@ -1,74 +0,0 @@
-<div id="extjs-welcome">
-<div class="content">
-    <header>
-        <h5 class="logo"><a href="http://www.sencha.com">Sencha</a></h5>
-    </header>
-    <section>
-        <div class="auto_columns two">
-            <div class="column">
-                <h2>Welcome to <strong>Ext JS 4</strong>!</h2>
-                <p class="intro">Ext JS 4 is a pure JavaScript application framework that works everywhere from IE6 to Chrome 11. It enables you to create the best cross-platform applications using nothing but a browser, and has a phenomenal API.</p>
-                <p class="intro">This is the biggest upgrade we've ever made to Ext JS and we think you're going to love it.</p>
-                <p class="button-group">
-                    <a href="#!/example" class="button-link">View the Examples</a>
-                    <a href="http://www.sencha.com/forum/forumdisplay.php?79-Ext-JS-Community-Forums-4.x" class="more-icon">Discuss Ext JS 4 on the forum</a>
-              </p>
-            </div>
-            <div class="column">
-                <img src="resources/images/hero-extjs4-alt.png" class="feature-img pngfix" />
-                <div class="auto_columns two right">
-                    <div class="column">
-                        <h3>What&rsquo;s New</h3>
-                        <p>We have also been posting summaries of new features and changes to <a href="http://www.sencha.com/blog/">our blog</a>:</p>
-                        <ul class="type13">
-                            <li><a href="#!/guide/drawing_and_charting">Drawing &amp; Charting</a></li>
-                            <li><a href="http://www.sencha.com/blog/ext-js-4-anatomy-of-a-model/">Anatomy of a Model</a></li>
-                            <li><a href="#!/guide/data">Data Package</a></li>
-                            <li><a href="http://www.sencha.com/blog/countdown-to-ext-js-4-dynamic-loading-and-new-class-system/">Dynamic Loading and the New Class System</a></li>
-                        </ul>
-                        <p><a href="http://www.sencha.com/products/extjs4-preview/" class="more-icon">Learn more on sencha.com</a></p>
-                        <p><a href="#!/api" class="more-icon">API Docs</a></p>
-                        <p><a href="extjs/release-notes.html" class="more-icon">Release Notes</a></p>
-                    </div>
-                    <div class="column">
-                        <h3>Upgrading</h3>
-                        <p>First, check out our <a href="#!/guide/upgrade">overview guide</a> to see what has changed.</p>
-
-                        <p>Sencha also offers <a href="http://www.sencha.com/training/">training courses</a> and <a href="http://www.sencha.com/support/services/">professional services</a> for companies wishing to use Ext JS 4.</p>
-                    </div>
-                </div>
-
-            </div>
-        </div>
-    </section>
-</div>
-<div class="news">
-    <div class="l">
-        <h1>SDK Updates</h1>
-        <div class="item"><span class="date">Oct 19</span> Ext 4.0.7 Released</div>
-        <div class="item"><span class="date">Aug 30</span> Ext 4.0.6 Released (support subscribers only)</div>
-        <div class="item"><span class="date">Jul 24</span> Ext 4.0.5 Released (support subscribers only)</div>
-        <div class="item"><span class="date">Jun 29</span> Ext 4.0.4 Released (support subscribers only)</div>
-        <div class="item"><span class="date">Jun 14</span> Ext 4.0.3 Released (support subscribers only)</div>
-        <div class="item"><span class="date">Jun 9</span> Ext 4.0.2a Released</div>
-        <div class="item"><span class="date">May 17</span> Ext 4.0.1 Released</div>
-        <div class="item"><span class="date">Apr 26</span> Ext 4.0.0 Final Released</div>
-    </div>
-    <div class="r">
-        <h1>Documentation updates</h1>
-        <div class="item"><span class="date">Oct 10</span> Grid tutorials</div>
-        <div class="item"><span class="date">Aug 22</span> JSDuck 3</div>
-        <div class="item"><span class="date">Jul 14</span> Favorite classes</div>
-        <div class="item"><span class="date">Jul 8</span> Search results pagination</div>
-        <div class="item"><span class="date">Jun 29</span> Components Guide</div>
-        <div class="item"><span class="date">Jun 26</span> Inline examples</div>
-        <div class="item"><span class="date">Jun 21</span> Forms guide</div>
-        <div class="item"><span class="date">Jun 16</span> Tree guide updates</div>
-        <div class="item"><span class="date">Jun 15</span> Layouts guide</div>
-        <div class="item"><span class="date">Jun 9</span> Grid guide updates</div>
-        <div class="item"><span class="date">Jun 6</span> Data guide updates</div>
-        <div class="item"><span class="date">Jun 2</span> MVC guide updates</div>
-        <div class="item"><span class="date">May 31</span> Getting started guide updates</div>
-    </div>
-</div>
-</div>

data/opt/touch-iframe.html

@@ -1,85 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-    <title>Sencha Examples</title>
-
-    <script type="text/javascript" src="touch/sencha-touch-all.js"></script>
-    <link rel="stylesheet" type="text/css" href="touch/resources/css/sencha-touch.css">
-
-    <style id="iframe-css" type="text/css"></style>
-    <style type="text/css" media="screen">
-        html {
-            overflow: hidden
-        }
-
-        .home {
-            text-align: center;
-        }
-
-        .home img {
-            width: 64%;
-        }
-
-        .home h1 {
-            font-weight: bold;
-            font-size: 1.2em;
-        }
-
-        .home p {
-            color: #666;
-            font-size: 0.8em;
-            line-height: 1.5em;
-            margin: 10px 20px 12px 20px;
-        }
-
-        .home h2 {
-            color: #999;
-            font-size: 0.7em;
-        }
-
-		.twitterView .x-dataview-item {
-			padding: 10px;
-			min-height: 50px;
-		}
-
-		.twitterView .x-dataview-item img {
-			float: left;
-			display: block;
-			margin-top: 36px;
-		}
-
-		.twitterView .x-dataview-item h2 {
-			font-weight: bold;
-			color: #333;
-			margin: 0px 0px 10px 60px;
-		}
-
-		.twitterView .x-dataview-item p {
-			color: #666;
-			margin-left: 60px;
-			font-size: 0.8em;
-		}
-    </style>
-
-    <script type="text/javascript">
-        function loadInlineExample(code, options) {
-            try {
-                document.body.innerHTML = '';
-                if (!options.raw) {
-                    code = "Ext.setup({onReady: function(){" + code + "}});";
-                }
-                if (options.tablet) {
-                    // Scale example down to 70% size. Default font-size is 114%
-                    Ext.get('iframe-css').update("body {font-size: 79.8% !important}");
-                }
-                eval(code);
-            } catch (e) {
-                document.body.innerHTML = e;
-            }
-        }
-    </script>
-</head>
-<body>
-</body>
-</html>