jsduck 2.0.pre → 2.0.pre2

data/README.md

@@ -1,7 +1,7 @@
 JsDuck
 ======
 
-Simple JavaScript Duckumentation generator.
+API documentation generator for ExtJS 4.
 
            ,~~.
           (  6 )-_,
@@ -10,46 +10,16 @@ Simple JavaScript Duckumentation generator.
        \ `-' /    hjw
     ~'`~'`~'`~'`~
 
-JsDuck aims to be a better documentation generator for [ExtJS][].
-While it tries to do everything that [ext-doc][] does, it isn't
-satisfied with it and aims to make your life much easier.
+JsDuck aims to be a better documentation generator for [ExtJS][] than
+the old [ext-doc][] was.
 
-Basically JsDuck thinks that the following doc-comment really sucks:
+The standard way to give some structure to the JavaDoc-style code
+documentation is to use HTML in doc-comments.  Although the resulting
+documentation will look pretty, this is often achieved by sacrificing
+the readability of comments - HTML can get quite ugly.
 
-    /**
-     * @class Ext.form.TextField
-     * @extends Ext.form.Field
-     * <p>Basic text field.  Can be used as a direct replacement for traditional
-     * text inputs, or as the base class for more sophisticated input controls
-     * (like {@link Ext.form.TextArea} and {@link Ext.form.ComboBox}).</p>
-     * <p><b><u>Validation</u></b></p>
-     * <p>The validation procedure is described in the documentation for
-     * {@link #validateValue}.</p>
-     * <p><b><u>Alter Validation Behavior</u></b></p>
-     * <p>Validation behavior for each field can be configured:</p>
-     * <div class="mdetail-params"><ul>
-     * <li><code>{@link Ext.form.TextField#invalidText invalidText}</code> :
-     * the default validation message to show if any validation step above does
-     * not provide a message when invalid</li>
-     * <li><code>{@link Ext.form.TextField#maskRe maskRe}</code> :
-     * filter out keystrokes before any validation occurs</li>
-     * <li><code>{@link Ext.form.TextField#stripCharsRe stripCharsRe}</code> :
-     * filter characters after being typed in, but before being validated</li>
-     * </ul></div>
-     *
-     * @constructor Creates a new TextField
-     * @param {Object} config Configuration options
-     *
-     * @xtype textfield
-     */
-    Ext.form.TextField = Ext.extend(Ext.form.Field,  {
-
-Not quite so readable is it?  The source of ExtJS is filled with
-comments just like that, and when you use ext-doc, you too are forced
-to write such comments.
-
-JsDuck does not like it.  Although it can handle comments like this,
-it would like that you wrote comments like that instead:
+JsDuck does not like it.  Although it can handle comments written in
+HTML, it prefers a friendlier [Markdown][] syntax:
 
     /**
      * Basic text field.  Can be used as a direct replacement for traditional
@@ -77,16 +47,12 @@ it would like that you wrote comments like that instead:
      *
      * @xtype textfield
      */
-    Ext.form.TextField = Ext.extend(Ext.form.Field,  {
+    Ext.define('Ext.form.field.Text', {
+        extend: 'Ext.form.field.Base',
 
-As you can see, JsDuck supports formatting comments with friendly
-[Markdown][] syntax.  And it can infer several things from the code
-(like @class and @extends in this case), so you don't have to repeat
-yourself.  Also the constructor documentation is inherited from parent
-class - so you don't have to restate that it takes a config object
-again.
-
-That's basically it.  Have fun.
+As you can see, JsDuck can infer several things from the code (like
+`@class` and `@extends` in this case), so you don't have to repeat
+yourself.
 
 [ExtJS]: http://www.sencha.com/products/js/
 [ext-doc]: http://ext-doc.org/
@@ -96,18 +62,27 @@ That's basically it.  Have fun.
 Getting it
 ----------
 
-Standard rubygems install should do:
+Standard rubygems install should do (use the `--pre` switch to get the
+latest 2.0 version which this README documents, otherwise you will get
+the stable but quite old [0.6][v0.6] version):
 
-    $ [sudo] gem install jsduck
+    $ [sudo] gem install --pre jsduck
 
-For hacking fork it from github.
+For hacking fork it from github:
 
     $ git clone git://github.com/senchalabs/jsduck.git
     $ cd jsduck
     $ rake --tasks
 
-JsDuck depends on [json][], [RDiscount][], and [parallel][] plus [RSpec][] for tests.
+JsDuck depends on [json][], [RDiscount][], and [parallel][]; plus
+[RSpec][] for tests.
+
+If you encounter errors during gem installation, you may need to
+install the header files for compiling extension modules for ruby 1.8.
+For Debian systems you'll need the `ruby1.8-dev` package.  For Red Hat
+/ CentOS / Fedora use the `ruby-devel` package.
 
+[v0.6]: https://github.com/senchalabs/jsduck/tree/v0.6
 [json]: http://flori.github.com/json/
 [RDiscount]: https://github.com/rtomayko/rdiscount
 [parallel]: https://github.com/grosser/parallel
@@ -120,37 +95,39 @@ Usage
 Just call it from command line with output directory and a directory
 containing your JavaScript files:
 
-    $ jsduck --verbose --output some/dir  your/project/js
+    $ jsduck your/project/js --verbose --output your/docs
 
 The `--verbose` flag creates a lot of output, but at least you will
 see that something is happening.
 
-You pass in both directories and JavaScript files.  For example to
-generate docs for ExtJS 3, the simplest way is the following:
 
-    $ jsduck -v -o output/ ext-3.3.1/src/
+## Generating Docs for ExtJS 4
 
-But this will give you a bunch of warnings, so you should better
-create a script that takes just the files really needed and passes
-them through `xargs` to `jsduck`:
+For the simplest test-run just pass in the src/ dir of ExtJS 4.  But
+to get more similar result to the [official ExtJS 4
+documentation][official], you should pass in some extra options and
+copy over the doc-resources directory, which contains the images
+referenced by the documentation:
 
-    $ find ext-3.3.1/src/ -name '*.js' | egrep -v 'locale/|test/|adapter/' | xargs jsduck -v -o output/
+    $ jsduck ext-4.0.2a/src --output your/docs --ignore-global --exclude Error
+    $ cp -r ext-4.0.2a/docs/doc-resources your/docs/doc-resources
 
-Here's how the resulting documentation will look (ExtJS 3.3.1):
+The `--ignore-global` will avoid the creation of a `global` class.
+The `--exclude Error` will ignore references to the `Error` class,
+which would otherwise result in several warnings.
 
-* [JsDuck generated documentation](http://triin.net/temp/jsduck/)
-* [Official ExtJS documentation](http://dev.sencha.com/deploy/dev/docs/) (for comparison)
+Still, running JSDuck with the current ext-4.0.2a release is expected
+to generate a lot of warnings.  These should be fixed in some later
+releases.
 
-Here's the same for ExtJS 4:
+[official]: http://docs.sencha.com/ext-js/4-0/
 
-* [JsDuck generated documentation](http://triin.net/temp/jsduck4/)
-* [Official ExtJS documentation](http://docs.sencha.com/ext-js/4-0/api) (for comparison)
 
+Documenting your code with JSDuck
+---------------------------------
 
-Documentation
--------------
-
-Overview of documenting your code with JsDuck:
+Here's an overview of [all the available @tags][tags], and how to use
+them:
 
 * [Class](https://github.com/senchalabs/jsduck/wiki/Class)
 * [Constructor](https://github.com/senchalabs/jsduck/wiki/Constructor)
@@ -159,75 +136,36 @@ Overview of documenting your code with JsDuck:
 * [Methods](https://github.com/senchalabs/jsduck/wiki/Method)
 * [Events](https://github.com/senchalabs/jsduck/wiki/Event)
 
-More details:
-
-* [List of supported @tags][tags]
-* [List of doc-comment errors(?) found in ExtJS source][errors]
-
 [tags]: https://github.com/senchalabs/jsduck/wiki/List-of-supported-@tags
-[errors]: https://github.com/senchalabs/jsduck/wiki/List-of-doc-comment-errors(%3F)-found-in-ExtJS-source
-
-
-Features and differences from ext-doc
--------------------------------------
-
-JsDuck has some strong opinions, so some things are intentionally
-missing.
-
-* Support for Markdown in comments
-* More things inferred from the code
-* No XML configuration file, just command line options
-* Class documentation header doesn't separately list Package and Class -
-  these are IMHO redundant.
-* Class documentation header doesn't duplicate toolbar buttons -
-  another redundancy
-* Ext.Component has a component icon too, not only its descendants
-
-
-Missing features and TODO
--------------------------
-
-* Support for custom @tags. Ext-doc supports this, I personally have
-  never used this feature, so I'm thinking it's not really needed.
 
 
 Copying
 -------
 
-JsDuck is distributed under the terms of the GNU General Public License version 3.
+JsDuck is distributed under the terms of the GNU General Public
+License version 3.
 
 JsDuck was developed by [Rene Saarsoo](http://triin.net),
-with contributions from [Ondřej Jirman](https://github.com/megous)
-and [Nick Poulden](https://github.com/nick).
+with many contributions from [Nick Poulden](https://github.com/nick).
+
+Thanks to [Ondřej Jirman](https://github.com/megous),
+[Thomas Aylott](https://github.com/subtleGradient),
+[johnnywengluu](https://github.com/johnnywengluu),
+[gevik](https://github.com/gevik),
+[ligaard](https://github.com/ligaard), and many-many others who
+reported bugs, submitted patches, and provided a lot of useful input.
 
 
 Changelog
 ---------
 
-* 2.0.pre - Prerelease of the Ext4-themed version.  Generates docs in
-    exactly the same style as the official ExtJS4 docs.  Lots and lots
-    of changes.  But also possibly several bugs.  Use the --pre option
-    to install:
-
-        $ gem install --pre jsduck
+* 2.0.pre2 - Fixes for the previous pre-release.
+  * New --stdout command line option.
+  * Fix opening links in new tabs.
+  * Few other small bugfixes and enhancements.
 
-    To run it on ExtJS4:
-
-        $ jsduck  --output your/docs/  ext-4.0.2a/src  --ignore-global
-
-    This will generate a lot of warnings.  Those should be fixed in some
-    upcoming release of ExtJS4.  You can disable them with `--no-warnings`.
-    Additionally you will need to copy over the images:
-
-        $ cp -r ext-4.0.2a/docs/doc-resources your/docs/doc-resources
-
-    You can also get the class-listing to the main page by downloading
-    [overviewData.json][] and passing it to JSDuck with:
-
-        --categories overviewData.json
-
-    This file should in the future be found inside the ExtJS4 release,
-    along with the source code for guides.
+* 2.0.pre - Completely overhauled Ext4-themed version.
+  * Currently in a pre-release state.
 
 * 0.6 - JsDuck is now used for creating the official ExtJS4 documentation.
   * Automatic linking of class names found in comments.  Instead of writing
@@ -285,5 +223,3 @@ Changelog
   * List of subclasses
 
 * 0.1 - initial version.
-
-[overviewData.json]: https://raw.github.com/senchalabs/jsduck/3ee0653554da1ddc54576e7df442d08c9a6d22fd/template/overviewData.json

data/Rakefile

@@ -74,7 +74,7 @@ def run_jsduck_export(extra_options, ext_dir)
 
   run_jsduck([
     "--title", "Ext JS 4.0.2a API Documentation",
-    "--footer", "ExtJS 4.0.2a Documentation from Sencha. Generated with <a href='https://github.com/nene/jsduck'>JSDuck</a> revison #{rev}",
+    "--footer", "ExtJS 4.0.2a Documentation from Sencha. Generated with <a href='https://github.com/senchalabs/jsduck'>JSDuck</a> revison #{rev}",
     "#{SDK_DIR}/extjs/src",
     "#{SDK_DIR}/platform/src",
     "#{SDK_DIR}/platform/core/src",

data/bin/jsduck

@@ -121,6 +121,10 @@ opts = OptionParser.new do | opts |
     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 ""
 
@@ -167,7 +171,7 @@ opts.parse!(ARGV).each do |fname|
       js_files << fname
     end
   else
-    puts "Warning: File #{fname} not found"
+    $stderr.puts "Warning: File #{fname} not found"
   end
 end
 app.input_files = js_files
@@ -175,27 +179,29 @@ 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.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)
+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()

data/jsduck.gemspec

@@ -2,8 +2,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.7"
 
   s.name = 'jsduck'
-  s.version = '2.0.pre'
-  s.date = '2011-06-30'
+  s.version = '2.0.pre2'
+  s.date = '2011-07-06'
   s.summary = "Simple JavaScript Duckumentation generator"
   s.description = "Documentation generator for ExtJS 4"
   s.homepage = "https://github.com/senchalabs/jsduck"

data/lib/jsduck/aliases.rb

@@ -1,3 +1,5 @@
+require 'jsduck/logger'
+
 module JsDuck
 
   class Aliases
@@ -27,12 +29,24 @@ module JsDuck
     # If the original also happens to be an alias, continue recursively.
     def find_original(al)
       al_def = al[:alias]
-      orig = @relations[al_def[:cls]].get_member(al_def[:member], al_def[:type] || al[:tagname])
+
+      orig = @relations[al_def[:cls]]
+      unless orig
+        Logger.instance.warn("Class #{al_def[:cls]} not found in #{al[:filename]} line #{al[:linenr]}")
+        return al
+      end
+      orig = orig.get_member(al_def[:member], al_def[:type] || al[:tagname])
+      unless orig
+        Logger.instance.warn("Member #{al_def[:cls]}##{al_def[:member]} not found in #{al[:filename]} line #{al[:linenr]}")
+        return al
+      end
+
       if orig[:alias]
         find_original(orig)
       else
         orig
       end
+
     end
   end
 

data/lib/jsduck/app.rb

@@ -109,8 +109,10 @@ module JsDuck
         end
       end
 
-      clear_dir(@output_dir)
-      if @export == :json
+      clear_dir(@output_dir) unless @export == :stdout
+      if @export == :stdout
+        @timer.time(:generating) { puts JSON.generate(relations.classes) }
+      elsif @export == :json
         FileUtils.mkdir(@output_dir)
         init_output_dirs(@output_dir)
         @timer.time(:generating) { write_src(@output_dir+"/source", parsed_files) }

data/lib/jsduck/class.rb

@@ -61,6 +61,10 @@ module JsDuck
       @doc.clone
     end
 
+    def to_json(*a)
+      to_hash.to_json(*a)
+    end
+
     # Returns true when this class inherits from the specified class.
     # Also returns true when the class itself is the one we are asking about.
     def inherits_from?(class_name)

data/lib/jsduck/guides.rb

@@ -63,9 +63,8 @@ module JsDuck
       @guides.each do |guide|
         out_dir = dir+"/"+guide[:name]
         FileUtils.cp_r(guide[:dir], out_dir)
-        # Write the JsonP file and remove the original Markdown file
+        # Write the JsonP file
         JsonP.write(out_dir+"/README.js", guide[:name], {:guide => guide[:html]})
-        FileUtils.rm(out_dir + "/README.md")
       end
     end
 

data/lib/jsduck/js_parser.rb

@@ -76,6 +76,8 @@ module JsDuck
         var_declaration
       elsif look("Ext", ".", "define", "(", :string)
         ext_define
+      elsif look("Ext", ".", "ClassManager", ".", "create", "(", :string)
+        ext_define
       elsif look(:ident, ":") || look(:string, ":")
         property_literal
       elsif look(",", :ident, ":") || look(",", :string, ":")
@@ -178,9 +180,11 @@ module JsDuck
       }
     end
 
-    # <ext-define> := "Ext" "." "define" "(" <string> "," <ext-define-cfg>
+    # <ext-define> := "Ext" "." ["define" | "ClassManager" "." "create" ] "(" <string> "," <ext-define-cfg>
     def ext_define
-      name = match("Ext", ".", "define", "(", :string)
+      match("Ext", ".");
+      look("define") ? match("define") : match("ClassManager", ".", "create");
+      name = match("(", :string)
 
       if look(",", "{")
         match(",")

data/lib/jsduck/logger.rb

@@ -27,7 +27,7 @@ module JsDuck
     # warnings greatly also when run multiple processes.
     def warn(msg)
       if @warnings && !@shown_warnings[msg]
-        puts "Warning: " + msg
+        $stderr.puts "Warning: " + msg
         @shown_warnings[msg] = true
       end
     end

data/template/app/controller/Classes.js

@@ -133,7 +133,7 @@ Ext.define('Docs.controller.Classes', {
         url = url.replace(/.*#/, "");
 
         if (this.opensNewWindow(event)) {
-            window.open(url);
+            window.open("#"+url);
             view && view.selectUrl(this.activeUrl ? this.activeUrl : "");
         }
         else {

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

@@ -26,7 +26,7 @@ Ext.define('Docs.view.cls.Overview', {
             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, true);
+            docContent.scrollTo('top', currentScroll + scrollOffset);
 
             if (isMember && el.down(".expandable")) {
                 el.addCls('open');

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

@@ -8,7 +8,7 @@ Ext.define('Docs.view.index.Container', {
     cls: 'class-list',
 
     initComponent: function() {
-        var tpl = new Ext.XTemplate(
+        this.tpl = new Ext.XTemplate(
             '<h1 class="top">{title}</h1>',
             '<tpl if="notice">',
                 '<div class="notice">{notice}</div>',
@@ -34,8 +34,7 @@ Ext.define('Docs.view.index.Container', {
             '</tpl>',
             '{categories}'
         );
-
-        this.html = tpl.apply(this.extractData());
+        this.data = this.extractData();
         
         this.callParent(arguments);
     },

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jsduck
 version: !ruby/object:Gem::Version 
-  hash: 961915908
+  hash: -1876988255
   prerelease: true
   segments: 
   - 2
   - 0
-  - pre
-  version: 2.0.pre
+  - pre2
+  version: 2.0.pre2
 platform: ruby
 authors: 
 - Rene Saarsoo
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-30 00:00:00 +03:00
+date: 2011-07-06 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -160,11 +160,11 @@ files:
 - template/resources/images/x.png
 - template/resources/images/x12.png
 - template/extjs/ext-all.js
-- template/resources/css/style.css
+- template/resources/css/docs-ext.css
 - template/resources/css/scrollbars.css
-- template/resources/css/viewport.css
 - template/resources/css/reset.css
-- template/resources/css/docs-ext.css
+- template/resources/css/style.css
+- template/resources/css/viewport.css
 has_rdoc: true
 homepage: https://github.com/senchalabs/jsduck
 licenses: []