jsduck 3.11.1 → 3.11.2

data/Rakefile

@@ -220,7 +220,6 @@ task :ext4 => :sass do
   runner = JsDuckRunner.new
   runner.add_ext4
   runner.add_debug
-  runner.add_options("--tests")
   runner.run
 
   system("cp -r #{EXT_BUILD} #{OUT_DIR}/extjs-build")
@@ -233,8 +232,7 @@ task :sdk => :sass do
     "--output", OUT_DIR,
     "--config", "#{SDK_DIR}/extjs/docs/config.json",
     "--examples-base-url", "extjs-build/examples/",
-    "--seo",
-    "--tests"
+    "--seo"
   )
   runner.add_debug
   runner.add_comments('ext-js', '4')
@@ -250,8 +248,7 @@ task :touch2 => :sass do
     "--output", OUT_DIR,
     "--config", "#{SDK_DIR}/touch/docs/config.json",
     "--examples-base-url", "touch-build/examples/production/",
-    "--seo",
-    "--tests"
+    "--seo"
   )
 
   runner.add_debug

data/js-classes/String.js

@@ -949,7 +949,7 @@
  *
  * The following example displays the string "sencha":
  *
- *     var upperText="sencha";
+ *     var upperText="SENCHA";
  *     document.write(upperText.toLocaleLowerCase());
  *
  * @return {String} Returns value of the string in lowercase.

data/jsduck.gemspec

@@ -2,8 +2,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.5"
 
   s.name = 'jsduck'
-  s.version = '3.11.1'
-  s.date = '2012-07-26'
+  s.version = '3.11.2'
+  s.date = '2012-08-07'
   s.summary = "Simple JavaScript Duckumentation generator"
   s.description = "Documentation generator for Sencha JS frameworks"
   s.homepage = "https://github.com/senchalabs/jsduck"

data/lib/jsduck/aggregator.rb

@@ -205,10 +205,7 @@ module JsDuck
     end
 
     # Appends Ext4 options parameter to each event parameter list.
-    # But only when we are dealing with Ext4 codebase.
     def append_ext4_event_options
-      return unless ext4?
-
       options = {
         :tagname => :param,
         :name => "eOpts",

data/lib/jsduck/app.rb

@@ -124,7 +124,9 @@ module JsDuck
       agr.create_global_class
       agr.remove_ignored_classes
       agr.create_accessors
-      agr.append_ext4_event_options
+      if @opts.ext4_events == true || (@opts.ext4_events == nil && agr.ext4?)
+        agr.append_ext4_event_options
+      end
       agr.result
     end
 
@@ -163,14 +165,15 @@ module JsDuck
       class_formatter.include_types = !@opts.export
       # Format all doc-objects in parallel
       formatted_classes = @parallel.map(@relations.classes) do |cls|
-        Logger.instance.log("Markdown formatting #{cls[:name]}")
+        files = cls[:files].map {|f| f[:filename] }.join(" ")
+        Logger.instance.log("Markdown formatting #{cls[:name]}", files)
         begin
           {
             :doc => class_formatter.format(cls.internal_doc),
             :images => doc_formatter.images
           }
         rescue
-          Logger.instance.fatal("Error while formatting #{cls[:name]}", $!)
+          Logger.instance.fatal("Error while formatting #{cls[:name]} #{files}", $!)
           exit(1)
         end
       end

data/lib/jsduck/options.rb

@@ -12,6 +12,7 @@ module JsDuck
     attr_accessor :output_dir
     attr_accessor :ignore_global
     attr_accessor :external_classes
+    attr_accessor :ext4_events
 
     # Customizing output
     attr_accessor :title
@@ -73,9 +74,10 @@ module JsDuck
         # Special anything-goes type
         "Mixed",
       ]
+      @ext4_events = nil
       @meta_tag_paths = []
 
-      @version = "3.11.1"
+      @version = "3.11.2"
 
       # Customizing output
       @title = "Ext JS - Sencha Docs"
@@ -157,6 +159,14 @@ module JsDuck
           @external_classes += classes
         end
 
+        opts.on('--[no-]ext4-events',
+          "Appends extra options parameter that all Ext events have.",
+          "The default is to auto-detect if we're using Ext JS 4",
+          "based on whether the code uses Ext.define.",
+          "Use this option to override the auto-detection.", " ") do |e|
+          @ext4_events = e
+        end
+
         opts.on('--builtin-classes',
           "Includes docs for JavaScript builtin classes.", " ") do
           read_filenames(@root_dir + "/js-classes")

data/lib/jsduck/tag/chainable.rb

@@ -0,0 +1,14 @@
+require "jsduck/meta_tag"
+
+module JsDuck::Tag
+  # Implementation of @chainable tag
+  class Chainable < JsDuck::MetaTag
+    def initialize
+      @name = "chainable"
+      @key = :chainable
+      @signature = {:long => "chainable", :short => "&gt;"} # show small right-arrow
+      @boolean = true
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsduck
 version: !ruby/object:Gem::Version
-  version: 3.11.1
+  version: 3.11.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-26 00:00:00.000000000 Z
+date: 2012-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdiscount
@@ -117,8 +117,6 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - COPYING
-- Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - bin/compare
@@ -189,6 +187,7 @@ files:
 - lib/jsduck/tag/abstract.rb
 - lib/jsduck/tag/aside.rb
 - lib/jsduck/tag/author.rb
+- lib/jsduck/tag/chainable.rb
 - lib/jsduck/tag/deprecated.rb
 - lib/jsduck/tag/docauthor.rb
 - lib/jsduck/tag/hide.rb

data/Gemfile

@@ -1,4 +0,0 @@
-source :rubygems
-
-gemspec
-

data/Gemfile.lock

@@ -1,41 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jsduck (3.10.5)
-      json
-      parallel
-      rdiscount
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    chunky_png (1.2.5)
-    compass (0.12.1)
-      chunky_png (~> 1.2)
-      fssm (>= 0.2.7)
-      sass (~> 3.1)
-    diff-lcs (1.1.3)
-    fssm (0.2.9)
-    json (1.7.3)
-    parallel (0.5.16)
-    rake (0.9.2.2)
-    rdiscount (1.6.8)
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.0)
-    rspec-expectations (2.10.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.1)
-    sass (3.1.18)
-
-PLATFORMS
-  ruby
-  x86-mingw32
-
-DEPENDENCIES
-  compass
-  jsduck!
-  rake
-  rspec