jsduck 4.6.0 → 4.6.1

data/js-classes/RegExp.js

@@ -90,7 +90,7 @@
  * |                  |
  * |                  | `/\d+(?!\.)/.exec("3.141")` matches 141 but not 3.141.
  * |                  |
- * | `x|y`            | Matches either `x` or `y`.
+ * |<code>x&#124;y</code>| Matches either `x` or `y`.
  * |                  |
  * |                  | For example, `/green|red/` matches 'green' in "green apple" and 'red' in "red apple."
  * |                  |

data/js-classes/String.js

@@ -1033,4 +1033,22 @@
  *     alert(x.valueOf())          // Displays "Hello world"
  *
  * @return {String} Returns value of string.
- */
+ */
+
+// ECMAScript 5 methods
+
+/**
+ * @method trim
+ * Removes whitespace from both ends of the string.
+ *
+ * Does not affect the value of the string itself.
+ *
+ * The following example displays the lowercase string `"foo"`:
+ *
+ *     var orig = "   foo  ";
+ *     alert(orig.trim());
+ *
+ * **NOTE:** This method is part of the ECMAScript 5 standard.
+ *
+ * @return {String} A string stripped of whitespace on both ends.
+ */

data/jsduck.gemspec

@@ -2,8 +2,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.5"
 
   s.name = 'jsduck'
-  s.version = '4.6.0'
-  s.date = '2013-01-09'
+  s.version = '4.6.1'
+  s.date = '2013-01-17'
   s.summary = "Simple JavaScript Duckumentation generator"
   s.description = "Documentation generator for Sencha JS frameworks"
   s.homepage = "https://github.com/senchalabs/jsduck"

data/lib/jsduck/assets.rb

@@ -30,7 +30,7 @@ module JsDuck
       doc_formatter.relations = @relations
 
       @images = Images.new(@opts.images)
-      @welcome = Welcome.create(@opts.welcome)
+      @welcome = Welcome.create(@opts.welcome, doc_formatter)
       @guides = Guides.create(@opts.guides, doc_formatter, @opts)
       @videos = Videos.create(@opts.videos)
       @examples = Examples.create(@opts.examples, @opts)

data/lib/jsduck/class.rb

@@ -152,9 +152,9 @@ module JsDuck
         ms = @members_index.global_by_name[query[:name]] || []
         ms = ms.find_all {|m| m[:owner] == @doc[:name]} if query[:local]
       elsif query[:local]
-        ms = @members_index.local_by_id.values
+        ms = @members_index.all_local
       else
-        ms = @members_index.global_by_id.values
+        ms = @members_index.all_global
       end
 
       if query[:tagname]

data/lib/jsduck/members_index.rb

@@ -31,6 +31,30 @@ module JsDuck
       @global_map_by_name
     end
 
+    # Returns array of all members (including inherited ones)
+    def all_global
+      global_by_id.values
+    end
+
+    # Returns array of all local members (excludes inherited ones)
+    def all_local
+      local_by_id.values.reject {|m| m[:meta] && m[:meta][:hide] }
+    end
+
+    # Clears the search cache.
+    # Using this is REALLY BAD - try to get rid of it.
+    def invalidate!
+      @map_by_id = nil
+      @global_map_by_id = nil
+      @global_map_by_name = nil
+
+      @cls.parent.members_index.invalidate! if @cls.parent
+
+      @cls.mixins.each {|mix| mix.members_index.invalidate! }
+    end
+
+    protected
+
     # Returns hash of all members by ID (including inherited ones)
     def global_by_id
       unless @global_map_by_id
@@ -64,18 +88,6 @@ module JsDuck
       @map_by_id
     end
 
-    # Clears the search cache.
-    # Using this is REALLY BAD - try to get rid of it.
-    def invalidate!
-      @map_by_id = nil
-      @global_map_by_id = nil
-      @global_map_by_name = nil
-
-      @cls.parent.members_index.invalidate! if @cls.parent
-
-      @cls.mixins.each {|mix| mix.members_index.invalidate! }
-    end
-
     private
 
     # merges second members hash into first one

data/lib/jsduck/options.rb

@@ -91,7 +91,7 @@ module JsDuck
       @ext4_events = nil
       @meta_tag_paths = []
 
-      @version = "4.6.0"
+      @version = "4.6.1"
 
       # Customizing output
       @title = "Documentation - JSDuck"
@@ -292,9 +292,11 @@ module JsDuck
         end
 
         opts.on('--welcome=PATH',
-          "HTML file with content for welcome page.",
+          "File with content for welcome page.",
           "",
-          "It should only contain the <body> part of a HTML page.",
+          "Either HTML or Markdown file with content for welcome page.",
+          "HTML file must only contain the <body> part of the page.",
+          "Markdown file must have a .md or .markdown extension.",
           "",
           "See also: https://github.com/senchalabs/jsduck/wiki/Welcome-page") do |path|
           @welcome = canonical(path)

data/lib/jsduck/welcome.rb

@@ -5,17 +5,20 @@ module JsDuck
 
   class Welcome
     # Creates Welcome object from filename.
-    def self.create(filename)
+    def self.create(filename, doc_formatter)
       if filename
-        Welcome.new(filename)
+        Welcome.new(filename, doc_formatter)
       else
         Util::NullObject.new(:to_html => "")
       end
     end
 
-    # Parses welcome HTML file with content for welcome page.
-    def initialize(filename)
+    # Parses welcome HTML or Markdown file with content for welcome page.
+    def initialize(filename, doc_formatter)
       @html = Util::IO.read(filename)
+      if filename =~ /\.(md|markdown)\Z/i
+        @html = '<div class="markdown">' + doc_formatter.format(@html) + '</div>'
+      end
     end
 
     # Returns the HTML

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsduck
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 4.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-09 00:00:00.000000000 Z
+date: 2013-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdiscount
@@ -259,6 +259,7 @@ files:
 - lib/jsduck/videos.rb
 - lib/jsduck/web_writer.rb
 - lib/jsduck/welcome.rb
+- template-min/app-1c3b39672c292d36e4a5ff05c1bb7035.js
 - template-min/README.md
 - template-min/template.html
 - template-min/index-template.html
@@ -312,10 +313,9 @@ files:
 - template-min/resources/images/header.png
 - template-min/resources/images/print.png
 - template-min/resources/images/tablet-l.jpg
-- template-min/resources/css/app-5403b0fb4441869ecc224f0c35223d19.css
+- template-min/resources/css/app-88de2e4b4aaefeb72bd4003a88ad5c26.css
 - template-min/resources/prettify/prettify.js
 - template-min/resources/prettify/prettify.css
-- template-min/app-164f134c52b6dc87188110504cc189e5.js
 - template-min/print-template.html
 - template-min/favicon.ico
 - template-min/extjs/resources/themes/images/default/tab/tab-default-bottom-sides.gif