From 77ffe7844674a25720c6fd5cb5df8a15cca17102 Mon Sep 17 00:00:00 2001
From: Rene Saarsoo <nene@triin.net>
Date: Wed, 16 Nov 2011 15:28:18 +0200
Subject: [PATCH] Re-introduce example.js file.

---
 README.md      |   2 +
 opt/example.js | 144 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 146 insertions(+)
 create mode 100644 opt/example.js

diff --git a/README.md b/README.md
index b670dab0..e3d109e4 100644
--- a/README.md
+++ b/README.md
@@ -100,7 +100,9 @@ Documenting your code
 ---------------------
 
 All the supported syntax is described in the [Guide][].
+For quick overview take a look at [example.js][example].
 
+[example]: https://github.com/senchalabs/jsduck/blob/master/opt/example.js
 
 Copying
 -------
diff --git a/opt/example.js b/opt/example.js
new file mode 100644
index 00000000..beb5d6fa
--- /dev/null
+++ b/opt/example.js
@@ -0,0 +1,144 @@
+/**
+ * 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!')
+ *         }
+ *     });
+ *
+ * [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
+});
-- 
GitLab