jsduck 0.1 → 0.2

data/README.md

@@ -165,7 +165,7 @@ JsDuck has some strong opinions, so some things are intentionally
 missing.
 
 * Support for Markdown in comments
-* More things infered from the code
+* 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.
@@ -174,18 +174,17 @@ missing.
 * Ext.Component has a component icon too, not only its descendants
 
 
-Missing features
-----------------
+Missing features and TODO
+-------------------------
 
-It's still in early beta, so several things supported by ext-doc are
-currently missing:
+* Search, not just searching from official ExtJS documentation.
 
-* Links from documentation to source code
-* List of subclasses
-* Tree of parent classes
-* Syntax highlighting of code examples
-* Search, not just searching from official ExtJS documentation
-* Support for custom @tags
+* Support for custom @tags. Ext-doc supports this, I personally have
+  never used this feature, so I'm thinking it's not really needed.
+
+* Speed improvements. JsDuck is clearly slower than ext-doc, but I
+  haven't so far done almost no optimizations, so there should be some
+  pretty low-hanging fruits to pick.
 
 
 Copying
@@ -195,3 +194,14 @@ JsDuck is distributed under the terms of the GNU General Public License version
 
 JsDuck was developed by [Rene Saarsoo](http://triin.net).
 
+
+Changelog
+---------
+
+* 0.2 - most features of ext-doc supported.
+  * Links from documentation to source code
+  * Syntax highlighting of code examples
+  * Tree of parent classes
+  * List of subclasses
+
+* 0.1 - initial version.

data/jsduck.gemspec

@@ -2,8 +2,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.7"
 
   s.name = 'jsduck'
-  s.version = '0.1'
-  s.date = '2010-12-27'
+  s.version = '0.2'
+  s.date = '2011-01-10'
   s.summary = "Simple JavaScript Duckumentation generator"
   s.description = "Better ext-doc like JavaScript documentation generator for ExtJS"
   s.homepage = "https://github.com/nene/jsduck"

data/lib/jsduck/aggregator.rb

@@ -16,13 +16,34 @@ module JsDuck
       @merger = Merger.new
     end
 
-    def parse(input)
+    # Parses chunk of JavaScript.  The resulting documentation is
+    # accumulated inside this class and can be later accessed through
+    # #result method.
+    #
+    # - input  the JavaScript source
+    # - filename  name of the JS file where it came from
+    # - html_filename  name of the HTML file where the source was saved.
+    #
+    def parse(input, filename="", html_filename="")
       @current_class = nil
       Parser.new(input).parse.each do |docset|
         doc = @doc_parser.parse(docset[:comment])
         code = docset[:code]
-        register(@merger.merge(doc, code))
+        href = html_filename + "#line-" + docset[:linenr].to_s
+        register(add_href(@merger.merge(doc, code), href, filename))
+      end
+    end
+
+    # Tags doc-object with link to source code where it came from.
+    # For class we also store the name of the JavaScript file.
+    def add_href(doc, href, filename)
+      doc[:href] = href
+      if doc[:tagname] == :class
+        doc[:filename] = filename
+        doc[:cfg].each {|cfg| cfg[:href] = href }
+        doc[:method].each {|method| method[:href] = href }
       end
+      doc
     end
 
     # Registers documentation node either as class or as member of

data/lib/jsduck/app.rb

@@ -1,8 +1,10 @@
 require 'rubygems'
 require 'jsduck/aggregator'
+require 'jsduck/source_formatter'
 require 'jsduck/class'
 require 'jsduck/tree'
 require 'jsduck/tree_icons'
+require 'jsduck/subclasses'
 require 'jsduck/page'
 require 'json'
 require 'fileutils'
@@ -26,8 +28,8 @@ module JsDuck
 
     # Call this after input parameters set
     def run
-      classes = filter_classes(parse_files(@input_files))
       copy_template(@template_dir, @output_dir)
+      classes = filter_classes(parse_files(@input_files))
       write_tree(@output_dir+"/output/tree.js", classes)
       write_pages(@output_dir+"/output", classes)
     end
@@ -36,9 +38,12 @@ module JsDuck
     # documented items in all of those files.
     def parse_files(filenames)
       agr = Aggregator.new
-      filenames.each do |name|
-        puts "Parsing #{name} ..." if @verbose
-        agr.parse(IO.read(name))
+      src = SourceFormatter.new(@output_dir + "/source")
+      filenames.each do |fname|
+        puts "Parsing #{fname} ..." if @verbose
+        code = IO.read(fname)
+        src_fname = src.write(code, fname)
+        agr.parse(code, File.basename(fname), File.basename(src_fname))
       end
       agr.result
     end
@@ -69,10 +74,11 @@ module JsDuck
 
     # Writes documentation page for each class
     def write_pages(path, docs)
+      subclasses = Subclasses.new(docs)
       docs.each do |cls|
         filename = path + "/" + cls[:name] + ".html"
         puts "Writing to #{filename} ..." if @verbose
-        File.open(filename, 'w') {|f| f.write( Page.new(cls).to_html ) }
+        File.open(filename, 'w') {|f| f.write( Page.new(cls, subclasses).to_html ) }
       end
     end
 
@@ -83,6 +89,7 @@ module JsDuck
       end
       FileUtils.cp_r(template_dir, dir)
       FileUtils.mkdir(dir + "/output")
+      FileUtils.mkdir(dir + "/source")
     end
   end
 

data/lib/jsduck/inheritance_tree.rb

@@ -0,0 +1,51 @@
+module JsDuck
+
+  # Creates the inheritance tree shown on class documentation page.
+  class InheritanceTree
+    def initialize(cls)
+      @cls = cls
+    end
+
+    # Renders the tree using HTML <pre> element
+    def to_html
+      i = -1
+      html = ancestors(@cls).reverse.collect do |cls|
+        i += 1
+        make_indent(i) + make_link(cls)
+      end.join("\n")
+
+      return <<-EOHTML
+        <div class="inheritance res-block">
+          <pre class="res-block-inner">#{html}</pre>
+        </div>
+      EOHTML
+    end
+
+    # Returns array of the names of ancestor classes for given class.
+    # Including the name of the class itself.
+    # Example result when ascing ancestors of MyPanel might be:
+    #
+    #   [MyPanel, Ext.Panel, Ext.Component, Ext.util.Observable]
+    #
+    def ancestors(cls)
+      cls.parent ? [cls] + ancestors(cls.parent) : [cls]
+    end
+
+    def make_indent(level)
+      if level > 0
+        ("  " * level) + "<img src='resources/elbow-end.gif' alt=''>"
+      else
+        ""
+      end
+    end
+
+    def make_link(cls)
+      if cls == @cls
+        cls.short_name
+      else
+        "<a href='output/#{cls.full_name}.html' ext:cls='#{cls.full_name}'>#{cls.short_name}</a>"
+      end
+    end
+  end
+
+end

data/lib/jsduck/lexer.rb

@@ -53,6 +53,9 @@ module JsDuck
     #
     #     {:type => :ident, :value => "foo"}
     #
+    # For doc-comments the full token also contains the field :linenr,
+    # pointing to the line where the doc-comment began.
+    #
     def next(full=false)
       tok = @tokens.shift
       full ? tok : tok[:value]
@@ -82,6 +85,8 @@ module JsDuck
         elsif @input.check(/\/\*\*/) then
           @tokens << {
             :type => :doc_comment,
+            # Calculate current line number, starting with 1
+            :linenr => @input.string[0...@input.pos].count("\n") + 1,
             :value => @input.scan_until(/\*\/|\Z/)
           }
         elsif @input.check(/"/) then

data/lib/jsduck/page.rb

@@ -1,4 +1,5 @@
 require 'jsduck/doc_formatter'
+require 'jsduck/inheritance_tree'
 require 'jsduck/cfg_table'
 require 'jsduck/property_table'
 require 'jsduck/method_table'
@@ -8,14 +9,16 @@ module JsDuck
 
   # Creates HTML documentation page for one class.
   class Page
-    def initialize(cls)
+    def initialize(cls, subclasses = {})
       @cls = cls
+      @subclasses = subclasses
       @formatter = DocFormatter.new(cls.full_name)
     end
 
     def to_html
       [
        '<div class="body-wrap">',
+       inheritance_tree,
        heading,
        abstract,
        description,
@@ -28,20 +31,37 @@ module JsDuck
       ].join("\n")
     end
 
+    # only render the tree if class has at least one ancestor
+    def inheritance_tree
+      @cls.parent ? InheritanceTree.new(@cls).to_html : ""
+    end
+
     def heading
-      "<h1>Class <a href='source/sample.html#cls-#{@cls.full_name}'>#{@cls.full_name}</a></h1>"
+      "<h1>Class <a href='source/#{@cls[:href]}'>#{@cls.full_name}</a></h1>"
     end
 
     def abstract
       [
        "<table cellspacing='0'>",
         abstract_row("Extends:", @cls.parent ? class_link(@cls.parent.full_name) : "Object"),
+        abstract_row("Defind In:", file_link),
+        @subclasses[@cls] ? abstract_row("Subclasses:", subclasses) : "",
        "</table>",
       ].join("\n")
     end
 
-    def class_link(name)
-      "<a href='output/#{name}.html' ext:cls='#{name}'>#{name}</a>"
+    def class_link(class_name, label=nil)
+      label = label || class_name
+      "<a href='output/#{class_name}.html' ext:cls='#{class_name}'>#{label}</a>"
+    end
+
+    def file_link
+      "<a href='source/#{@cls[:href]}'>#{@cls[:filename]}</a>"
+    end
+
+    def subclasses
+      subs = @subclasses[@cls].sort {|a, b| a.short_name <=> b.short_name }
+      subs.collect {|cls| class_link(cls.full_name, cls.short_name) }.join(", ")
     end
 
     def abstract_row(label, info)

data/lib/jsduck/parser.rb

@@ -9,9 +9,10 @@ module JsDuck
     end
 
     # Parses the whole JavaScript block and returns array where for
-    # each doc-comment there is a hash of two values: the comment
-    # itself as string and parsed structure of the code that
-    # immediately follows the comment.
+    # each doc-comment there is a hash of three values: the comment
+    # itself as string, number of the line where the comment starts,
+    # and parsed structure of the code that immediately follows the
+    # comment.
     #
     # For example with the following JavaScript input:
     #
@@ -26,6 +27,7 @@ module JsDuck
     # [
     #   {
     #     :comment => "/**\n * @param {String} foo\n */",
+    #     :linenr => 1,
     #     :code => {
     #       :type => :assignment,
     #       :left => ["MyClass", "doIt"],
@@ -44,8 +46,10 @@ module JsDuck
     def parse
       while !@lex.empty? do
         if look(:doc_comment) then
+          comment = @lex.next(true)
           @docs << {
-            :comment => match(:doc_comment),
+            :comment => comment[:value],
+            :linenr => comment[:linenr],
             :code => code_block
           }
         else

data/lib/jsduck/source_formatter.rb

@@ -0,0 +1,76 @@
+require "cgi"
+
+module JsDuck
+
+  # Formats JavaScript source into HTML page.  Inside the HTML every
+  # source code line will be marked with ID, so that it can be linked
+  # from documentation.
+  class SourceFormatter
+
+    # Initializes SourceFormatter to the directory where
+    # HTML-formatted source files will be placed
+    def initialize(output_dir)
+      @output_dir = output_dir
+    end
+
+    # Converts source to HTML and writes into file in output
+    # directory.  It returns the name of the file that it wrote.
+    def write(source, filename)
+      fname = uniq_html_filename(filename)
+      File.open(fname, 'w') {|f| f.write(format(source)) }
+      fname
+    end
+
+    def uniq_html_filename(filename)
+      fname = html_filename(filename)
+      nr = 1
+      while File.exists?(fname)
+        nr += 1
+        fname = html_filename(filename, nr)
+      end
+      fname
+    end
+
+    def html_filename(filename, nr=0)
+      @output_dir + "/" + File.basename(filename, ".js") + (nr > 0 ? nr.to_s : "") + ".html"
+    end
+
+    # Returns full source for HTML page
+    def format(source)
+      return <<-EOHTML
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>The source code</title>
+  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+  <style type="text/css">
+    .highlight { display: block; background-color: #ddd; }
+  </style>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js">#{format_pre(source)}</pre>
+</body>
+</html>
+      EOHTML
+    end
+
+    # Formats the contents of <pre>, wrapping each source code line
+    # inside <span>.
+    def format_pre(source)
+      i = 0
+      return source.lines.collect do |line|
+        i += 1
+        "<span id='line-#{i}'>#{CGI.escapeHTML(line)}</span>"
+      end.join()
+    end
+
+  end
+
+end

data/lib/jsduck/subclasses.rb

@@ -0,0 +1,27 @@
+module JsDuck
+
+  # Provides information about direct descendants of particular class.
+  #
+  # The constructor is initialized with array of all available
+  # classes.  Then through [] method subclasses of particlular class
+  # can be asked for.
+  class Subclasses
+    def initialize(classes)
+      @subs = {}
+      classes.each do |cls|
+        if !cls.parent
+          # do nothing
+        elsif @subs[cls.parent.full_name]
+          @subs[cls.parent.full_name] << cls
+        else
+          @subs[cls.parent.full_name] = [cls]
+        end
+      end
+    end
+
+    def [](cls)
+      @subs[cls.full_name]
+    end
+  end
+
+end

data/lib/jsduck/table.rb

@@ -55,7 +55,7 @@ module JsDuck
 
     def signature(item)
       id = @cls.full_name+ "-" + item[:name]
-      src = "source/sample.html#" + id
+      src = "source/#{item[:href]}"
       return "<a id='#{id}'></a><b><a href='#{src}'>#{item[:name]}</a></b>" + signature_suffix(item)
     end
 

data/template/index.html

@@ -7,11 +7,13 @@
 <link rel="stylesheet" type="text/css" href="resources/css/xtheme-gray.css" />
 <link rel="stylesheet" type="text/css" href="resources/docs.css" />
 <link rel="stylesheet" type="text/css" href="resources/style.css" />
+<link rel="stylesheet" type="text/css" href="resources/prettify/prettify.css" />
 <link rel="shortcut icon" href="resources/favicon.ico" />
 <link rel="icon" href="resources/favicon.ico" />
 <script type="text/javascript" src="resources/ext-base.js"></script>
 <script type="text/javascript" src="resources/ext-all.js"></script>
 <script type="text/javascript" src="resources/TabCloseMenu.js"></script>
+<script type="text/javascript" src="resources/prettify/prettify.js"></script>
 <script type="text/javascript" src="resources/docs.js"></script>
 <script type="text/javascript" src="output/tree.js"></script>
 </head>

data/template/resources/docs.js

@@ -209,10 +209,16 @@ DocPanel = Ext.extend(Ext.Panel, {
     hlMember : function(member){
         var el = Ext.fly(this.cclass + '-' + member);
         if(el){
-            if (tr = el.up('tr')) {
-                tr.highlight('#cadaf9');
-            }
+            var tr = el.up('tr');
+            tr && tr.highlight('#cadaf9');
         }
+    },
+
+    // Marks all code examples with "prettyprint" class.
+    // Then runs the prettify library on the whole document.
+    prettyPrint : function(){
+        Ext.select("pre > code", this.el).addClass("prettyprint lang-js");
+        prettyPrint();
     }
 });
 
@@ -314,12 +320,14 @@ Ext.extend(MainPanel, Ext.TabPanel, {
                 tab.scrollToMember(member);
             }
         }else{
-            var autoLoad = {url: href};
-            if(member){
-                autoLoad.callback = function(){
-                    Ext.getCmp(id).scrollToMember(member);
+            var autoLoad = {
+                url: href,
+                callback: function(){
+                    var tab = Ext.getCmp(id);
+                    tab.prettyPrint();
+                    member && tab.scrollToMember(member);
                 }
-            }
+            };
             var p = this.add(new DocPanel({
                 id: id,
                 cclass : cls,

data/template/resources/prettify/prettify.css

@@ -0,0 +1 @@
+.str{color:#080}.kwd{color:#008}.com{color:#800}.typ{color:#606}.lit{color:#066}.pun{color:#660}.pln{color:#000}.tag{color:#008}.atn{color:#606}.atv{color:#080}.dec{color:#606}pre.prettyprint{padding:2px;border:1px solid #888}ol.linenums{margin-top:0;margin-bottom:0}li.L0,li.L1,li.L2,li.L3,li.L5,li.L6,li.L7,li.L8{list-style:none}li.L1,li.L3,li.L5,li.L7,li.L9{background:#eee}@media print{.str{color:#060}.kwd{color:#006;font-weight:bold}.com{color:#600;font-style:italic}.typ{color:#404;font-weight:bold}.lit{color:#044}.pun{color:#440}.pln{color:#000}.tag{color:#006;font-weight:bold}.atn{color:#404}.atv{color:#060}}

data/template/resources/prettify/prettify.js

@@ -0,0 +1,33 @@
+window.PR_SHOULD_USE_CONTINUATION=true;window.PR_TAB_WIDTH=8;window.PR_normalizedHtml=window.PR=window.prettyPrintOne=window.prettyPrint=void 0;window._pr_isIE6=function(){var y=navigator&&navigator.userAgent&&navigator.userAgent.match(/\bMSIE ([678])\./);y=y?+y[1]:false;window._pr_isIE6=function(){return y};return y};
+(function(){function y(b){return b.replace(L,"&amp;").replace(M,"&lt;").replace(N,"&gt;")}function H(b,f,i){switch(b.nodeType){case 1:var o=b.tagName.toLowerCase();f.push("<",o);var l=b.attributes,n=l.length;if(n){if(i){for(var r=[],j=n;--j>=0;)r[j]=l[j];r.sort(function(q,m){return q.name<m.name?-1:q.name===m.name?0:1});l=r}for(j=0;j<n;++j){r=l[j];r.specified&&f.push(" ",r.name.toLowerCase(),'="',r.value.replace(L,"&amp;").replace(M,"&lt;").replace(N,"&gt;").replace(X,"&quot;"),'"')}}f.push(">");
+for(l=b.firstChild;l;l=l.nextSibling)H(l,f,i);if(b.firstChild||!/^(?:br|link|img)$/.test(o))f.push("</",o,">");break;case 3:case 4:f.push(y(b.nodeValue));break}}function O(b){function f(c){if(c.charAt(0)!=="\\")return c.charCodeAt(0);switch(c.charAt(1)){case "b":return 8;case "t":return 9;case "n":return 10;case "v":return 11;case "f":return 12;case "r":return 13;case "u":case "x":return parseInt(c.substring(2),16)||c.charCodeAt(1);case "0":case "1":case "2":case "3":case "4":case "5":case "6":case "7":return parseInt(c.substring(1),
+8);default:return c.charCodeAt(1)}}function i(c){if(c<32)return(c<16?"\\x0":"\\x")+c.toString(16);c=String.fromCharCode(c);if(c==="\\"||c==="-"||c==="["||c==="]")c="\\"+c;return c}function o(c){var d=c.substring(1,c.length-1).match(RegExp("\\\\u[0-9A-Fa-f]{4}|\\\\x[0-9A-Fa-f]{2}|\\\\[0-3][0-7]{0,2}|\\\\[0-7]{1,2}|\\\\[\\s\\S]|-|[^-\\\\]","g"));c=[];for(var a=[],k=d[0]==="^",e=k?1:0,h=d.length;e<h;++e){var g=d[e];switch(g){case "\\B":case "\\b":case "\\D":case "\\d":case "\\S":case "\\s":case "\\W":case "\\w":c.push(g);
+continue}g=f(g);var s;if(e+2<h&&"-"===d[e+1]){s=f(d[e+2]);e+=2}else s=g;a.push([g,s]);if(!(s<65||g>122)){s<65||g>90||a.push([Math.max(65,g)|32,Math.min(s,90)|32]);s<97||g>122||a.push([Math.max(97,g)&-33,Math.min(s,122)&-33])}}a.sort(function(v,w){return v[0]-w[0]||w[1]-v[1]});d=[];g=[NaN,NaN];for(e=0;e<a.length;++e){h=a[e];if(h[0]<=g[1]+1)g[1]=Math.max(g[1],h[1]);else d.push(g=h)}a=["["];k&&a.push("^");a.push.apply(a,c);for(e=0;e<d.length;++e){h=d[e];a.push(i(h[0]));if(h[1]>h[0]){h[1]+1>h[0]&&a.push("-");
+a.push(i(h[1]))}}a.push("]");return a.join("")}function l(c){for(var d=c.source.match(RegExp("(?:\\[(?:[^\\x5C\\x5D]|\\\\[\\s\\S])*\\]|\\\\u[A-Fa-f0-9]{4}|\\\\x[A-Fa-f0-9]{2}|\\\\[0-9]+|\\\\[^ux0-9]|\\(\\?[:!=]|[\\(\\)\\^]|[^\\x5B\\x5C\\(\\)\\^]+)","g")),a=d.length,k=[],e=0,h=0;e<a;++e){var g=d[e];if(g==="(")++h;else if("\\"===g.charAt(0))if((g=+g.substring(1))&&g<=h)k[g]=-1}for(e=1;e<k.length;++e)if(-1===k[e])k[e]=++n;for(h=e=0;e<a;++e){g=d[e];if(g==="("){++h;if(k[h]===undefined)d[e]="(?:"}else if("\\"===
+g.charAt(0))if((g=+g.substring(1))&&g<=h)d[e]="\\"+k[h]}for(h=e=0;e<a;++e)if("^"===d[e]&&"^"!==d[e+1])d[e]="";if(c.ignoreCase&&r)for(e=0;e<a;++e){g=d[e];c=g.charAt(0);if(g.length>=2&&c==="[")d[e]=o(g);else if(c!=="\\")d[e]=g.replace(/[a-zA-Z]/g,function(s){s=s.charCodeAt(0);return"["+String.fromCharCode(s&-33,s|32)+"]"})}return d.join("")}for(var n=0,r=false,j=false,q=0,m=b.length;q<m;++q){var t=b[q];if(t.ignoreCase)j=true;else if(/[a-z]/i.test(t.source.replace(/\\u[0-9a-f]{4}|\\x[0-9a-f]{2}|\\[^ux]/gi,
+""))){r=true;j=false;break}}var p=[];q=0;for(m=b.length;q<m;++q){t=b[q];if(t.global||t.multiline)throw Error(""+t);p.push("(?:"+l(t)+")")}return RegExp(p.join("|"),j?"gi":"g")}function Y(b){var f=0;return function(i){for(var o=null,l=0,n=0,r=i.length;n<r;++n)switch(i.charAt(n)){case "\t":o||(o=[]);o.push(i.substring(l,n));l=b-f%b;for(f+=l;l>=0;l-=16)o.push("                ".substring(0,l));l=n+1;break;case "\n":f=0;break;default:++f}if(!o)return i;o.push(i.substring(l));return o.join("")}}function I(b,
+f,i,o){if(f){b={source:f,c:b};i(b);o.push.apply(o,b.d)}}function B(b,f){var i={},o;(function(){for(var r=b.concat(f),j=[],q={},m=0,t=r.length;m<t;++m){var p=r[m],c=p[3];if(c)for(var d=c.length;--d>=0;)i[c.charAt(d)]=p;p=p[1];c=""+p;if(!q.hasOwnProperty(c)){j.push(p);q[c]=null}}j.push(/[\0-\uffff]/);o=O(j)})();var l=f.length;function n(r){for(var j=r.c,q=[j,z],m=0,t=r.source.match(o)||[],p={},c=0,d=t.length;c<d;++c){var a=t[c],k=p[a],e=void 0,h;if(typeof k==="string")h=false;else{var g=i[a.charAt(0)];
+if(g){e=a.match(g[1]);k=g[0]}else{for(h=0;h<l;++h){g=f[h];if(e=a.match(g[1])){k=g[0];break}}e||(k=z)}if((h=k.length>=5&&"lang-"===k.substring(0,5))&&!(e&&typeof e[1]==="string")){h=false;k=P}h||(p[a]=k)}g=m;m+=a.length;if(h){h=e[1];var s=a.indexOf(h),v=s+h.length;if(e[2]){v=a.length-e[2].length;s=v-h.length}k=k.substring(5);I(j+g,a.substring(0,s),n,q);I(j+g+s,h,Q(k,h),q);I(j+g+v,a.substring(v),n,q)}else q.push(j+g,k)}r.d=q}return n}function x(b){var f=[],i=[];if(b.tripleQuotedStrings)f.push([A,/^(?:\'\'\'(?:[^\'\\]|\\[\s\S]|\'{1,2}(?=[^\']))*(?:\'\'\'|$)|\"\"\"(?:[^\"\\]|\\[\s\S]|\"{1,2}(?=[^\"]))*(?:\"\"\"|$)|\'(?:[^\\\']|\\[\s\S])*(?:\'|$)|\"(?:[^\\\"]|\\[\s\S])*(?:\"|$))/,
+null,"'\""]);else b.multiLineStrings?f.push([A,/^(?:\'(?:[^\\\']|\\[\s\S])*(?:\'|$)|\"(?:[^\\\"]|\\[\s\S])*(?:\"|$)|\`(?:[^\\\`]|\\[\s\S])*(?:\`|$))/,null,"'\"`"]):f.push([A,/^(?:\'(?:[^\\\'\r\n]|\\.)*(?:\'|$)|\"(?:[^\\\"\r\n]|\\.)*(?:\"|$))/,null,"\"'"]);b.verbatimStrings&&i.push([A,/^@\"(?:[^\"]|\"\")*(?:\"|$)/,null]);if(b.hashComments)if(b.cStyleComments){f.push([C,/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\r\n]*)/,null,"#"]);i.push([A,/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,
+null])}else f.push([C,/^#[^\r\n]*/,null,"#"]);if(b.cStyleComments){i.push([C,/^\/\/[^\r\n]*/,null]);i.push([C,/^\/\*[\s\S]*?(?:\*\/|$)/,null])}b.regexLiterals&&i.push(["lang-regex",RegExp("^"+Z+"(/(?=[^/*])(?:[^/\\x5B\\x5C]|\\x5C[\\s\\S]|\\x5B(?:[^\\x5C\\x5D]|\\x5C[\\s\\S])*(?:\\x5D|$))+/)")]);b=b.keywords.replace(/^\s+|\s+$/g,"");b.length&&i.push([R,RegExp("^(?:"+b.replace(/\s+/g,"|")+")\\b"),null]);f.push([z,/^\s+/,null," \r\n\t\u00a0"]);i.push([J,/^@[a-z_$][a-z_$@0-9]*/i,null],[S,/^@?[A-Z]+[a-z][A-Za-z_$@0-9]*/,
+null],[z,/^[a-z_$][a-z_$@0-9]*/i,null],[J,/^(?:0x[a-f0-9]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+\-]?\d+)?)[a-z]*/i,null,"0123456789"],[E,/^.[^\s\w\.$@\'\"\`\/\#]*/,null]);return B(f,i)}function $(b){function f(D){if(D>r){if(j&&j!==q){n.push("</span>");j=null}if(!j&&q){j=q;n.push('<span class="',j,'">')}var T=y(p(i.substring(r,D))).replace(e?d:c,"$1&#160;");e=k.test(T);n.push(T.replace(a,s));r=D}}var i=b.source,o=b.g,l=b.d,n=[],r=0,j=null,q=null,m=0,t=0,p=Y(window.PR_TAB_WIDTH),c=/([\r\n ]) /g,
+d=/(^| ) /gm,a=/\r\n?|\n/g,k=/[ \r\n]$/,e=true,h=window._pr_isIE6();h=h?b.b.tagName==="PRE"?h===6?"&#160;\r\n":h===7?"&#160;<br>\r":"&#160;\r":"&#160;<br />":"<br />";var g=b.b.className.match(/\blinenums\b(?::(\d+))?/),s;if(g){for(var v=[],w=0;w<10;++w)v[w]=h+'</li><li class="L'+w+'">';var F=g[1]&&g[1].length?g[1]-1:0;n.push('<ol class="linenums"><li class="L',F%10,'"');F&&n.push(' value="',F+1,'"');n.push(">");s=function(){var D=v[++F%10];return j?"</span>"+D+'<span class="'+j+'">':D}}else s=h;
+for(;;)if(m<o.length?t<l.length?o[m]<=l[t]:true:false){f(o[m]);if(j){n.push("</span>");j=null}n.push(o[m+1]);m+=2}else if(t<l.length){f(l[t]);q=l[t+1];t+=2}else break;f(i.length);j&&n.push("</span>");g&&n.push("</li></ol>");b.a=n.join("")}function u(b,f){for(var i=f.length;--i>=0;){var o=f[i];if(G.hasOwnProperty(o))"console"in window&&console.warn("cannot override language handler %s",o);else G[o]=b}}function Q(b,f){b&&G.hasOwnProperty(b)||(b=/^\s*</.test(f)?"default-markup":"default-code");return G[b]}
+function U(b){var f=b.f,i=b.e;b.a=f;try{var o,l=f.match(aa);f=[];var n=0,r=[];if(l)for(var j=0,q=l.length;j<q;++j){var m=l[j];if(m.length>1&&m.charAt(0)==="<"){if(!ba.test(m))if(ca.test(m)){f.push(m.substring(9,m.length-3));n+=m.length-12}else if(da.test(m)){f.push("\n");++n}else if(m.indexOf(V)>=0&&m.replace(/\s(\w+)\s*=\s*(?:\"([^\"]*)\"|'([^\']*)'|(\S+))/g,' $1="$2$3$4"').match(/[cC][lL][aA][sS][sS]=\"[^\"]*\bnocode\b/)){var t=m.match(W)[2],p=1,c;c=j+1;a:for(;c<q;++c){var d=l[c].match(W);if(d&&
+d[2]===t)if(d[1]==="/"){if(--p===0)break a}else++p}if(c<q){r.push(n,l.slice(j,c+1).join(""));j=c}else r.push(n,m)}else r.push(n,m)}else{var a;p=m;var k=p.indexOf("&");if(k<0)a=p;else{for(--k;(k=p.indexOf("&#",k+1))>=0;){var e=p.indexOf(";",k);if(e>=0){var h=p.substring(k+3,e),g=10;if(h&&h.charAt(0)==="x"){h=h.substring(1);g=16}var s=parseInt(h,g);isNaN(s)||(p=p.substring(0,k)+String.fromCharCode(s)+p.substring(e+1))}}a=p.replace(ea,"<").replace(fa,">").replace(ga,"'").replace(ha,'"').replace(ia," ").replace(ja,
+"&")}f.push(a);n+=a.length}}o={source:f.join(""),h:r};var v=o.source;b.source=v;b.c=0;b.g=o.h;Q(i,v)(b);$(b)}catch(w){if("console"in window)console.log(w&&w.stack?w.stack:w)}}var A="str",R="kwd",C="com",S="typ",J="lit",E="pun",z="pln",P="src",V="nocode",Z=function(){for(var b=["!","!=","!==","#","%","%=","&","&&","&&=","&=","(","*","*=","+=",",","-=","->","/","/=",":","::",";","<","<<","<<=","<=","=","==","===",">",">=",">>",">>=",">>>",">>>=","?","@","[","^","^=","^^","^^=","{","|","|=","||","||=",
+"~","break","case","continue","delete","do","else","finally","instanceof","return","throw","try","typeof"],f="(?:^^|[+-]",i=0;i<b.length;++i)f+="|"+b[i].replace(/([^=<>:&a-z])/g,"\\$1");f+=")\\s*";return f}(),L=/&/g,M=/</g,N=/>/g,X=/\"/g,ea=/&lt;/g,fa=/&gt;/g,ga=/&apos;/g,ha=/&quot;/g,ja=/&amp;/g,ia=/&nbsp;/g,ka=/[\r\n]/g,K=null,aa=RegExp("[^<]+|<!--[\\s\\S]*?--\>|<!\\[CDATA\\[[\\s\\S]*?\\]\\]>|</?[a-zA-Z](?:[^>\"']|'[^']*'|\"[^\"]*\")*>|<","g"),ba=/^<\!--/,ca=/^<!\[CDATA\[/,da=/^<br\b/i,W=/^<(\/?)([a-zA-Z][a-zA-Z0-9]*)/,
+la=x({keywords:"break continue do else for if return while auto case char const default double enum extern float goto int long register short signed sizeof static struct switch typedef union unsigned void volatile catch class delete false import new operator private protected public this throw true try typeof alignof align_union asm axiom bool concept concept_map const_cast constexpr decltype dynamic_cast explicit export friend inline late_check mutable namespace nullptr reinterpret_cast static_assert static_cast template typeid typename using virtual wchar_t where break continue do else for if return while auto case char const default double enum extern float goto int long register short signed sizeof static struct switch typedef union unsigned void volatile catch class delete false import new operator private protected public this throw true try typeof abstract boolean byte extends final finally implements import instanceof null native package strictfp super synchronized throws transient as base by checked decimal delegate descending event fixed foreach from group implicit in interface internal into is lock object out override orderby params partial readonly ref sbyte sealed stackalloc string select uint ulong unchecked unsafe ushort var break continue do else for if return while auto case char const default double enum extern float goto int long register short signed sizeof static struct switch typedef union unsigned void volatile catch class delete false import new operator private protected public this throw true try typeof debugger eval export function get null set undefined var with Infinity NaN caller delete die do dump elsif eval exit foreach for goto if import last local my next no our print package redo require sub undef unless until use wantarray while BEGIN END break continue do else for if return while and as assert class def del elif except exec finally from global import in is lambda nonlocal not or pass print raise try with yield False True None break continue do else for if return while alias and begin case class def defined elsif end ensure false in module next nil not or redo rescue retry self super then true undef unless until when yield BEGIN END break continue do else for if return while case done elif esac eval fi function in local set then until ",
+hashComments:true,cStyleComments:true,multiLineStrings:true,regexLiterals:true}),G={};u(la,["default-code"]);u(B([],[[z,/^[^<?]+/],["dec",/^<!\w[^>]*(?:>|$)/],[C,/^<\!--[\s\S]*?(?:-\->|$)/],["lang-",/^<\?([\s\S]+?)(?:\?>|$)/],["lang-",/^<%([\s\S]+?)(?:%>|$)/],[E,/^(?:<[%?]|[%?]>)/],["lang-",/^<xmp\b[^>]*>([\s\S]+?)<\/xmp\b[^>]*>/i],["lang-js",/^<script\b[^>]*>([\s\S]*?)(<\/script\b[^>]*>)/i],["lang-css",/^<style\b[^>]*>([\s\S]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]),["default-markup",
+"htm","html","mxml","xhtml","xml","xsl"]);u(B([[z,/^[\s]+/,null," \t\r\n"],["atv",/^(?:\"[^\"]*\"?|\'[^\']*\'?)/,null,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w.:-]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^>\'\"\s]*(?:[^>\'\"\s\/]|\/(?=\s)))/],[E,/^[=<>\/]+/],["lang-js",/^on\w+\s*=\s*\"([^\"]+)\"/i],["lang-js",/^on\w+\s*=\s*\'([^\']+)\'/i],["lang-js",/^on\w+\s*=\s*([^\"\'>\s]+)/i],["lang-css",/^style\s*=\s*\"([^\"]+)\"/i],["lang-css",/^style\s*=\s*\'([^\']+)\'/i],
+["lang-css",/^style\s*=\s*([^\"\'>\s]+)/i]]),["in.tag"]);u(B([],[["atv",/^[\s\S]+/]]),["uq.val"]);u(x({keywords:"break continue do else for if return while auto case char const default double enum extern float goto int long register short signed sizeof static struct switch typedef union unsigned void volatile catch class delete false import new operator private protected public this throw true try typeof alignof align_union asm axiom bool concept concept_map const_cast constexpr decltype dynamic_cast explicit export friend inline late_check mutable namespace nullptr reinterpret_cast static_assert static_cast template typeid typename using virtual wchar_t where ",
+hashComments:true,cStyleComments:true}),["c","cc","cpp","cxx","cyc","m"]);u(x({keywords:"null true false"}),["json"]);u(x({keywords:"break continue do else for if return while auto case char const default double enum extern float goto int long register short signed sizeof static struct switch typedef union unsigned void volatile catch class delete false import new operator private protected public this throw true try typeof abstract boolean byte extends final finally implements import instanceof null native package strictfp super synchronized throws transient as base by checked decimal delegate descending event fixed foreach from group implicit in interface internal into is lock object out override orderby params partial readonly ref sbyte sealed stackalloc string select uint ulong unchecked unsafe ushort var ",
+hashComments:true,cStyleComments:true,verbatimStrings:true}),["cs"]);u(x({keywords:"break continue do else for if return while auto case char const default double enum extern float goto int long register short signed sizeof static struct switch typedef union unsigned void volatile catch class delete false import new operator private protected public this throw true try typeof abstract boolean byte extends final finally implements import instanceof null native package strictfp super synchronized throws transient ",
+cStyleComments:true}),["java"]);u(x({keywords:"break continue do else for if return while case done elif esac eval fi function in local set then until ",hashComments:true,multiLineStrings:true}),["bsh","csh","sh"]);u(x({keywords:"break continue do else for if return while and as assert class def del elif except exec finally from global import in is lambda nonlocal not or pass print raise try with yield False True None ",hashComments:true,multiLineStrings:true,tripleQuotedStrings:true}),["cv","py"]);
+u(x({keywords:"caller delete die do dump elsif eval exit foreach for goto if import last local my next no our print package redo require sub undef unless until use wantarray while BEGIN END ",hashComments:true,multiLineStrings:true,regexLiterals:true}),["perl","pl","pm"]);u(x({keywords:"break continue do else for if return while alias and begin case class def defined elsif end ensure false in module next nil not or redo rescue retry self super then true undef unless until when yield BEGIN END ",hashComments:true,
+multiLineStrings:true,regexLiterals:true}),["rb"]);u(x({keywords:"break continue do else for if return while auto case char const default double enum extern float goto int long register short signed sizeof static struct switch typedef union unsigned void volatile catch class delete false import new operator private protected public this throw true try typeof debugger eval export function get null set undefined var with Infinity NaN ",cStyleComments:true,regexLiterals:true}),["js"]);u(B([],[[A,/^[\s\S]+/]]),
+["regex"]);window.PR_normalizedHtml=H;window.prettyPrintOne=function(b,f){var i={f:b,e:f};U(i);return i.a};window.prettyPrint=function(b){function f(){for(var t=window.PR_SHOULD_USE_CONTINUATION?j.now()+250:Infinity;q<o.length&&j.now()<t;q++){var p=o[q];if(p.className&&p.className.indexOf("prettyprint")>=0){var c=p.className.match(/\blang-(\w+)\b/);if(c)c=c[1];for(var d=false,a=p.parentNode;a;a=a.parentNode)if((a.tagName==="pre"||a.tagName==="code"||a.tagName==="xmp")&&a.className&&a.className.indexOf("prettyprint")>=
+0){d=true;break}if(!d){a=p;if(null===K){d=document.createElement("PRE");d.appendChild(document.createTextNode('<!DOCTYPE foo PUBLIC "foo bar">\n<foo />'));K=!/</.test(d.innerHTML)}if(K){d=a.innerHTML;if("XMP"===a.tagName)d=y(d);else{a=a;if("PRE"===a.tagName)a=true;else if(ka.test(d)){var k="";if(a.currentStyle)k=a.currentStyle.whiteSpace;else if(window.getComputedStyle)k=window.getComputedStyle(a,null).whiteSpace;a=!k||k==="pre"}else a=true;a||(d=d.replace(/(<br\s*\/?>)[\r\n]+/g,"$1").replace(/(?:[\r\n]+[ \t]*)+/g,
+" "))}d=d}else{d=[];for(a=a.firstChild;a;a=a.nextSibling)H(a,d);d=d.join("")}d=d.replace(/(?:\r\n?|\n)$/,"");m={f:d,e:c,b:p};U(m);if(p=m.a){c=m.b;if("XMP"===c.tagName){d=document.createElement("PRE");for(a=0;a<c.attributes.length;++a){k=c.attributes[a];if(k.specified)if(k.name.toLowerCase()==="class")d.className=k.value;else d.setAttribute(k.name,k.value)}d.innerHTML=p;c.parentNode.replaceChild(d,c)}else c.innerHTML=p}}}}if(q<o.length)setTimeout(f,250);else b&&b()}for(var i=[document.getElementsByTagName("pre"),
+document.getElementsByTagName("code"),document.getElementsByTagName("xmp")],o=[],l=0;l<i.length;++l)for(var n=0,r=i[l].length;n<r;++n)o.push(i[l][n]);i=null;var j=Date;j.now||(j={now:function(){return(new Date).getTime()}});var q=0,m;f()};window.PR={combinePrefixPatterns:O,createSimpleLexer:B,registerLangHandler:u,sourceDecorator:x,PR_ATTRIB_NAME:"atn",PR_ATTRIB_VALUE:"atv",PR_COMMENT:C,PR_DECLARATION:"dec",PR_KEYWORD:R,PR_LITERAL:J,PR_NOCODE:V,PR_PLAIN:z,PR_PUNCTUATION:E,PR_SOURCE:P,PR_STRING:A,
+PR_TAG:"tag",PR_TYPE:S}})()

data/template/resources/style.css

@@ -120,6 +120,8 @@
     margin: 5px 0;
     overflow: hidden;
     line-height: 1px;
+    /* Force the line always below inheritance tree */
+    clear: both;
 }
 
 
@@ -251,22 +253,9 @@
     color: #000;
     line-height: 16px !important;
 }
-    .body-wrap pre code b {
-        font-weight: normal;
-        color: #800080;
-    }
-    .body-wrap pre code em {
-        font-weight: normal;
-        color: #008080;
-        background-color:#eee;
-    }
-    .body-wrap pre code i,
-    .body-wrap pre code i b,
-    .body-wrap pre code i em {
-        font-weight: normal;
-        font-style: normal;
-        color: #999;
-    }
+.body-wrap pre code a {
+    text-decoration: underline !important;
+}
 
 /* Hide long descriptions initially */
 /* When "expanded" class set, hide short and show long */

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: jsduck
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 1
-  version: "0.1"
+  - 2
+  version: "0.2"
 platform: ruby
 authors: 
 - Rene Saarsoo
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-27 00:00:00 +02:00
+date: 2011-01-10 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,6 +67,7 @@ files:
 - lib/jsduck/doc_formatter.rb
 - lib/jsduck/doc_parser.rb
 - lib/jsduck/event_table.rb
+- lib/jsduck/inheritance_tree.rb
 - lib/jsduck/lexer.rb
 - lib/jsduck/long_params.rb
 - lib/jsduck/merger.rb
@@ -75,6 +76,8 @@ files:
 - lib/jsduck/parser.rb
 - lib/jsduck/property_table.rb
 - lib/jsduck/short_params.rb
+- lib/jsduck/source_formatter.rb
+- lib/jsduck/subclasses.rb
 - lib/jsduck/table.rb
 - lib/jsduck/tree.rb
 - lib/jsduck/tree_icons.rb
@@ -91,6 +94,7 @@ files:
 - template/resources/docs.css
 - template/resources/docs.gif
 - template/resources/docs.js
+- template/resources/elbow-end.gif
 - template/resources/event.gif
 - template/resources/expand-all.gif
 - template/resources/expand-bg-over.gif
@@ -436,6 +440,8 @@ files:
 - template/resources/pkg-closed.gif
 - template/resources/pkg-open.gif
 - template/resources/pkg.gif
+- template/resources/prettify/prettify.css
+- template/resources/prettify/prettify.js
 - template/resources/prop.gif
 - template/resources/s.gif
 - template/resources/static.gif