RubyGems - jsduck - Versions diffs - 2.0.pre4 → 3.0.pre - Mend

jsduck 2.0.pre4 → 3.0.pre

Files changed (485) hide show

data/bin/jsduck CHANGED Viewed

@@ -18,200 +18,8 @@
 $:.unshift File.dirname(File.dirname(__FILE__)) + "/lib"
 require 'jsduck/app'
-require 'optparse'
+require 'jsduck/options'
-app = JsDuck::App.new
-app.template_dir = File.dirname(File.dirname(__FILE__)) + "/template"
-opts = OptionParser.new do | opts |
-  opts.banner = "Usage: jsduck [options] files/dirs...\n\n"
-  opts.on('-o', '--output=PATH',
-    "Directory to output all this amazing documentation.",
-    "This option MUST be specified.", " ") do |path|
-    app.output_dir = path
-  end
-  opts.on('--ignore-global', "Turns off the creation of global class.", " ") do
-    app.ignore_global = true
-  end
-  opts.on('--private-classes', "Include private classes to docs.", " ") do
-    app.show_private_classes = true
-  end
-  opts.on('--external=CLASSNAME',
-    "Declares an external class.  When declared as",
-    "external, inheriting from this class will not",
-    "trigger warnings.  Useful when you are extending",
-    "a class for which you can not supply source code.", " ") do |classname|
-    app.external_classes << classname
-  end
-  opts.on('--no-warnings', "Turns off warnings.", " ") do
-    app.warnings = false
-  end
-  opts.on('-v', '--verbose', "This will fill up your console.", " ") do
-    app.verbose = true
-  end
-  opts.separator "Customizing output:"
-  opts.separator ""
-  opts.on('--title=TEXT',
-    "Custom title for the documentation app.",
-    "Defaults to 'ExtJS API Documentation'", " ") do |text|
-    app.title = text
-  end
-  opts.on('--footer=TEXT',
-    "Custom footer text for the documentation app.",
-    "Defaults to: 'Generated with JSDuck.'", " ") do |text|
-    app.footer = text
-  end
-  opts.on('--head-html=HTML', "HTML to append to the <head> section of index.html.", " ") do |html|
-    app.head_html = html
-  end
-  opts.on('--body-html=HTML', "HTML to append to the <body> section index.html.", " ") do |html|
-    app.body_html = html
-  end
-  opts.on('--guides=PATH', "Path to guides directory.",
-    "Each subdirectory of that is treated as a guide",
-    "and is expectd to contain a REAME.md file,",
-    "which will be converted into a README.js.", " ") do |path|
-    app.guides_dir = path
-  end
-  opts.on('--guides-order=a,b,c', Array,
-    "The order in which the guides should appear. When",
-    "a guide name is not specified here, it will be excluded.",
-    "You don't have to write the whole name of the guide,",
-    "just the beginning of it, as long as it's unique.", " ") do |list|
-    app.guides_order = list
-  end
-  opts.on('--categories=PATH',
-    "Path to JSON file which defines categories for classes.", " ") do |path|
-    app.categories_path = path
-  end
-  opts.on('--link=TPL',
-    "HTML template for replacing {@link}.",
-    "Possible placeholders:",
-    "%c - full class name (e.g. 'Ext.Panel')",
-    "%m - class member name prefixed with member type",
-    "     (e.g. 'method-urlEncode')",
-    "%# - inserts '#' if member name present",
-    "%- - inserts '-' if member name present",
-    "%a - anchor text for link",
-    "Default is: '<a href=\"#/api/%c%-%m\" rel=\"%c%-%m\" class=\"docClass\">%a</a>'", " ") do |tpl|
-    app.link_tpl = tpl
-  end
-  opts.on('--img=TPL',
-    "HTML template for replacing {@img}.",
-    "Possible placeholders:",
-    "%u - URL from @img tag (e.g. 'some/path.png')",
-    "%a - alt text for image",
-    "Default is: '<p><img src=\"doc-resources/%u\" alt=\"%a\"></p>'", " ") do |tpl|
-    app.img_tpl = tpl
-  end
-  opts.on('--json', "Produces JSON export instead of HTML documentation.", " ") do
-    app.export = :json
-  end
-  opts.on('--stdout', "Writes JSON export to STDOUT instead of writing to the filesystem", " ") do
-    app.export = :stdout
-  end
-  opts.separator "Debugging:"
-  opts.separator ""
-  # For debugging it's often useful to set --processes=0 to get deterministic results.
-  opts.on('-p', '--processes=COUNT',
-    "The number of parallel processes to use.",
-    "Defaults to the number of processors/cores.",
-    "Set to 0 to disable parallel processing completely.", " ") do |count|
-    app.processes = count.to_i
-  end
-  opts.on('--template=PATH',
-    "Directory containing doc-browser UI template.", " ") do |path|
-    app.template_dir = path
-  end
-  opts.on('--template-links',
-    "Instead of copying template files, create symbolic",
-    "links.  Useful for template files development.",
-    "Only works on platforms supporting symbolic links.", " ") do
-    app.template_links = true
-  end
-  opts.on('--extjs-path=PATH',
-    "Path for main ExtJS JavaScript file.  Useful for specifying",
-    "something different than extjs/ext-all.js", " ") do |path|
-    app.extjs_path = path
-  end
-  opts.on('--local-storage-db=NAME',
-    "Prefix for LocalStorage database names.",
-    "Defaults to 'docs'.", " ") do |name|
-    app.local_storage_db = name
-  end
-  opts.on('-h', '--help', "Prints this help message", " ") do
-    puts opts
-    exit
-  end
-end
-js_files = []
-# scan directories for .js files
-opts.parse!(ARGV).each do |fname|
-  if File.exists?(fname)
-    if File.directory?(fname)
-      Dir[fname+"/**/*.{js,css,scss}"].each {|f| js_files << f }
-    else
-      js_files << fname
-    end
-  else
-    $stderr.puts "Warning: File #{fname} not found"
-  end
-end
-app.input_files = js_files
-if app.input_files.length == 0
-  puts "You should specify some input files, otherwise there's nothing I can do :("
-  exit(1)
-elsif app.export != :stdout
-  if !app.output_dir
-    puts "You should also specify an output directory, where I could write all this amazing documentation."
-    exit(1)
-  elsif File.exists?(app.output_dir) && !File.directory?(app.output_dir)
-    puts "Oh noes!  The output directory is not really a directory at all :("
-    exit(1)
-  elsif !File.exists?(File.dirname(app.output_dir))
-    puts "Oh noes!  The parent directory for #{app.output_dir} doesn't exist."
-    exit(1)
-  elsif !File.exists?(app.template_dir + "/extjs")
-    puts "Oh noes!  The template directory does not contain extjs/ directory :("
-    puts "Please copy ExtJS over to template/extjs or create symlink."
-    puts "For example:"
-    puts "    $ cp -r /path/to/ext-4.0.0 " + app.template_dir + "/extjs"
-    exit(1)
-  elsif !File.exists?(app.template_dir + "/resources/css")
-    puts "Oh noes!  CSS files for custom ExtJS theme missing :("
-    puts "Please compile SASS files in template/resources/sass with compass."
-    puts "For example:"
-    puts "    $ compass compile " + app.template_dir + "/resources/sass"
-    exit(1)
-  end
-end
-app.run()
+opts = JsDuck::Options.new
+opts.parse!(ARGV)
+JsDuck::App.new(opts).run

data/example.js ADDED Viewed

@@ -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/
+ *
+ * @author Rene Saarsoo <rene@example.com>
+ * @docauthor John Smith <john@example.com>
+ */
+Ext.define('Ext.master.Switch', {
+    // These are all detected automatically
+    // No need to use @extends, @alternateClassName, @mixin, @singleton
+    extend: 'Ext.button.Button',
+    alternateClassName: 'Ext.MasterSwitch',
+    mixins: {
+        observable: 'Ext.util.Observable',
+        floating: 'Ext.util.Floating'
+    },
+    singleton: true,
+    // The same as: @xtype masterswitch
+    alias: 'widget.masterswitch',
+    /**
+     * @cfg {String} [text="Click Me!"]
+     * A config option with explicit type, name, and default value.
+     */
+    /**
+     * @cfg
+     * A config option with type (String), name (icon), and default value
+     * ("some/file.png") auto-detected.
+     */
+    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.
+     * An object containing the following fields:
+     * @property {Number} size.width The width.
+     * @property {Number} size.height The height.
+     */
+    /**
+     * @property
+     * A property with auto-detected type (Boolean) and name (disabled).
+     */
+    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
+             */
+            "click"
+        );
+    },
+    /**
+     * Sets the size.
+     * @param {Object} size An object describing width and height.
+     * If either of them is left unspecified, it defaults to `0`.
+     * @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.
+         * @param {Number} fn.index Component index.
+         * @param {Boolean} fn.return 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
+     * @alias Ext.master.Switch#setSize
+     */
+    setMasterSwitchSize: Ext.master.Switch.setSize
+});

data/jsduck.gemspec CHANGED Viewed

@@ -2,8 +2,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.7"
   s.name = 'jsduck'
-  s.version = '2.0.pre4'
-  s.date = '2011-07-15'
+  s.version = '3.0.pre'
+  s.date = '2011-09-08'
   s.summary = "Simple JavaScript Duckumentation generator"
   s.description = "Documentation generator for ExtJS 4"
   s.homepage = "https://github.com/senchalabs/jsduck"
@@ -12,15 +12,10 @@ Gem::Specification.new do |s|
   s.rubyforge_project = s.name
   s.files = `git ls-files`.split("\n").find_all do |file|
-    file !~ /spec.rb$/ && file !~ /benchmark/ && file !~ /resources\/sass/
+    file !~ /spec.rb$/ && file !~ /benchmark/ && file !~ /template\//
   end
   # Add files not in git
-  s.files += ['template/extjs/ext-all.js']
-  s.files += ['template/extjs/resources/themes/images/default/tree/arrows.gif']
-  s.files += ['template/extjs/resources/themes/images/default/grid/loading.gif']
-  s.files += ['template/extjs/resources/themes/images/default/form/text-bg.gif']
-  s.files += ['template/extjs/resources/themes/images/default/form/checkbox.gif']
-  s.files += Dir['template/resources/css/*.css']
+  s.files += Dir['template-min/**/*']
   s.executables = ["jsduck"]

data/lib/jsduck/aggregator.rb CHANGED Viewed

@@ -153,7 +153,7 @@ module JsDuck
       options = {
         :tagname => :param,
-        :name => "options",
+        :name => "eOpts",
         :type => "Object",
         :doc => "The options object passed to {@link Ext.util.Observable#addListener}."
       }