docjs 0.1.2 → 0.1.3

data/templates/resources/scss/_header.scss

@@ -92,7 +92,8 @@
         border-radius: $radius;
         padding: 0; margin: 0;
         
-        overflow-y: scroll;      
+        overflow: hidden; 
+        /*overflow-y: scroll;*/
       }    
     }
     

data/templates/resources/scss/_helpers.scss

@@ -1,11 +1,11 @@
 $golden_ratio: 1.618;
 
-@mixin transition($property, $time) {
-	-webkit-transition: $property $time ease-in-out;
-	-moz-transition: $property $time ease-in-out;
-	-o-transition: $property $time ease-in-out;
-	-ms-transition: $property $time ease-in-out;
-	transition: $property $time ease-in-out;
+@mixin transition($property, $time, $transition: ease-in-out) {
+	-webkit-transition: $property $time $transition;
+	-moz-transition: $property $time $transition;
+	-o-transition: $property $time $transition;
+	-ms-transition: $property $time $transition;
+	transition: $property $time $transition;
 }
 
 /* Kudos to http://www.colorzilla.com/gradient-editor/ */

data/templates/resources/scss/_highlighter.scss

@@ -0,0 +1,70 @@
+@mixin line-height-fix() {
+  font-size: 9pt;
+  line-height: 1.4em;
+}
+
+code.source, code.example {
+  @include code-box;
+  @include line-height-fix;
+  padding: 0.5em;
+  margin-bottom: $element-margin;  
+}
+
+/* js-replaced version */
+.syntaxhighlighter {
+  @extend code.source;
+  
+  /* revert no-js settings */
+  background: #fff;
+  padding: 0; 
+   
+  table {
+    width: 100%;
+    
+    td {
+      border: 1px solid #fff; /* rebuild double-border effect */
+    }
+  }
+  
+  .gutter {
+    background-color: $codegrey;
+    color: darken($codegrey, 20%);
+    padding: 0.5em;
+    border-right: 1px solid darken($codegrey, 10%);
+    text-align: right;
+    
+    .line {
+      @include line-height-fix;
+    }
+  }
+  
+  .code {
+    padding: 0.5em 0;
+    width: 100%;
+    
+    .line {
+      padding: 0 0.5em;
+      &:hover { background: #f5f5f5; }
+    }
+  }
+  
+  &.example {
+    background: #f3f3f3;
+    .line {
+      padding-left: 1em;
+      &:hover { background: #efefef; }
+    }
+  }
+  
+  /* syntaxhighlighting settings */
+  .spaces {}
+  .keyword { font-weight: bold; }
+  .plain {}
+  .string { color: $orange; }
+  .comments { color: #998; font-style: italic; }
+  .comments a { color: #998; }
+  .variable {}
+  .functions {}
+  .constants { color: $blue; }
+  .script {}
+}

data/templates/resources/scss/application.scss

@@ -78,6 +78,7 @@ $element-margin: 1.33em;
 @mixin code-box() {
   @include double-border(1px, #ffffff, darken($codegrey, 10%));
   @include terminal;
+  display: block;
   background: $codegrey;
 }
 
@@ -96,6 +97,7 @@ $element-margin: 1.33em;
 @import 'header';
 @import 'footer';
 @import 'tooltip';
+@import 'highlighter';
 
 body, select, input, textarea {
   @include reset-fonts;
@@ -248,13 +250,6 @@ div#main .body {
     }    
   }
   
-  code.block {
-    @include code-box;
-    display: block;      
-    padding: 0.5em;      
-    color: #555;
-    margin-bottom: $element-margin;
-  }
   
   .section {
     padding-bottom: $box-spacing;    
@@ -292,7 +287,7 @@ div#main .body {
       }    
     }
   
-  .source {
+  h3.source {
     @extend .icon.arrow_down; 
     cursor: pointer;   
     &.collapsed { 
@@ -327,6 +322,11 @@ div#main .body {
       }        
     }
   }
+  
+
+  .overload {
+    margin-bottom: 3em;
+  }
 }
 
 div#main .notification  {

data/templates/tokens/tokens.rb

@@ -13,10 +13,61 @@ module Token::Handler
   register :warn, :area => :notification
   
   register :example, :template => 'examples', :handler => :named_multiline
-  
-  register :overload, :area => :none do |token, content|
-  
-  
+   
+  # Every @overload can contain **text-documentation**, **@param**- and **@return**-tokens
+  #
+  # It may look like:
+  #
+  #     @overload
+  #       This is the documentation for a overload
+  #       It can have multiple lines of docs
+  #       
+  #       @param [String] foo please notice the optional empty 
+  #         line above and the linebreak of this param
+  #       @return [Array] something special will be returned
+  #       
+  #       Followed by some more random documentation
+  #
+  # If no return should be possible, the more simple :named_nested_shorthand handler could be used...
+  register :overload, :area => :none do |token_klass, content|  
+
+    documentation = []
+    children = []
+
+    # First remove linebreaks with 2-times intendation
+    content.gsub!(/\n((?!\n)\s){2}/, ' ')
+
+    # Then we take every line and analyse it
+    content.split(/\n/).each do |line|
+    
+    
+      # We utilize Parser's Tokenline-Regexp here
+      matches = Parser::TOKENLINE.match(line)    
+      
+      if matches.nil?
+        documentation << line
+     
+      else
+        name, content = matches.captures 
+         
+        if name == 'param'
+          children << Token::Handler.apply(:typed_with_name, Token::Token::ParamToken, content)
+        elsif name == 'return'
+          children << Token::Handler.apply(:typed, Token::Token::ReturnToken, content)
+        end
+      
+      end
+    end
+    
+    self.add_token token_klass.new :content => documentation.join("\n"), :children => children, :name => self.name
   end
   
+  # Example:
+  #     @event MyCustomEvent
+  #       This event will be triggered, if something special happens. The registered handler will be
+  #       called with the following parameters:
+  #       [Object] obj This object
+  #       [String] msg Some message 
+  register :event, :area => :body, :handler => :named_nested_shorthand
+  
 end

data/templates/views/function/_detail.html.erb

@@ -4,5 +4,5 @@
   <%= render_tokens :of => detail, :in => :body %>
     
   <h3 class="source">Source</h3>
-  <%= code detail.source %>
+  <%= code detail.source, :firstline => detail.line_start, :class => "source" %>
 </section>

data/templates/views/function/index.html.erb

@@ -20,7 +20,7 @@
       <div class="method-list">
         <h3>Methods</h3>
         <ul>
-          <% @methods.each do |child| %>
+          <% @methods.sort{|a,b| a.name <=> b.name }.each do |child| %>
           <li><%= link_to child %></li>
           <% end %>
         </ul>
@@ -41,12 +41,24 @@
     <%= to_html @function.docs %>
     
     <!--span class="flag">constructor</span-->
+   
+    <%= render_tokens :of => @function, :in => :body %>
     
-    <h2 class="signature"><%= signature @function %></h2>
-    <%= render_tokens :of => @function, :in => :body %>  
+    <%# if it has overloads, we need another template %>
+    <% if @function.tokens[:overload].nil? %>
+    
+      <h2 class="signature"><%= signature @function %></h2>
+      <%= render :partial => 'tokens/default', :locals => { :tokens => @function.params } %>
+      <%= render :partial => 'tokens/default', :locals => { :tokens => @function.returns } %>
+
+    <% else %>
+  
+      <%= render :partial => 'tokens/overload', :collection => @function.tokens[:overload] %>
+      
+    <% end %>
     
     <h3 class="source">Source</h3>
-    <%= code @function.source %>
+    <%= code @function.source, :firstline => @function.line_start, :class => "source" %>
   
   </div>
  

data/templates/views/layout/application.html.erb

@@ -58,16 +58,16 @@
     </div>
     <footer id="footer">
       <div class="wrapper">
-        Documentation created automagically with <a href="http://www.github.com/b-studios/jsdoc">JSDoc for Ruby</a>.
+        Documentation created automagically with <a href="http://www.github.com/b-studios/doc.js">Doc.js for ruby</a>.
       </div>
     </footer>
     <%= script "jcore" %>    
     <script>
-      var JSDOC = JSDOC || {};
-      JSDOC.root = "<%= to_relative(Configs.output) + '/' %>";
-      window.jQuery || document.write("<script src='"+JSDOC.root+"js/jquery.js'>\x3C/script>")
+      var J = J || {};
+      J.root = "<%= to_relative(Configs.output) + '/' %>";
+      window.jQuery || document.write("<script src='"+J.root+"js/jquery.js'>\x3C/script>")
     </script>
     <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.6/jquery.js"></script>
-    <%= script "jquery.treeview", "jquery.cookie", "jquery.tooltip", "application", "apisearch-data" %>
+    <%= script "jquery.treeview", "jquery.cookie", "jquery.tooltip", "regexpx", "shCore", "shBrushJScript", "application", "apisearch-data" %>
   <body>
 </html>

data/templates/views/layout/json.html.erb

@@ -1,3 +1,3 @@
-var JSDOC = JSDOC || {};
-JSDOC.data = JSDOC.data || {};
-JSDOC.data.<%= @varname %> = <%= @data.to_json %>
+var J = J || {};
+J.data = J.data || {};
+J.data.<%= @varname %> = <%= @data.to_json %>

data/templates/views/object/index.html.erb

@@ -13,7 +13,7 @@
       <div class="method-list">
         <h3>Methods</h3>
         <ul>
-          <% @methods.each do |child| %>
+          <% @methods.sort{|a,b| a.name <=> b.name }.each do |child| %>
           <li><%= link_to child %></li>
           <% end %>
         </ul>
@@ -31,14 +31,14 @@
 
   <div class="body">
 
-    <%= to_html @object.docs %>
+    <%=to_html @object.docs %>
 
     <!-- SUMMARY -->
     <% unless @methods.nil? or @methods.size == 0 %>
       <section>
         <h3 class="icon function">Methods</h3>
         <ul class="summary collapsed">
-          <% @methods.each do |child| %>
+          <% @methods.sort{|a,b| a.name <=> b.name }.each do |child| %>
           <li><%= link_to child %></li>
           <% end %>
         </ul>

data/templates/views/tokens/_default.html.erb

@@ -1,4 +1,5 @@
-<%
+<% unless tokens.nil? 
+
 
   opts = tokens.first.html
   opts[:class] = (opts[:class] || "") + " subsection"
@@ -8,4 +9,5 @@
   <ul>
     <%= render :partial => 'tokens/default_token', :collection => tokens %>
   </ul>
-</section>
+</section>
+<% end %>

data/templates/views/tokens/_default_token.html.erb

@@ -4,6 +4,7 @@
   <% end %>
 
   <% unless default_token.children.nil? %>
+    <%=to_html default_token.content %>
     <ul>
       <%= render :partial => 'tokens/default_token', :collection => default_token.children %>
     </ul>  
@@ -13,7 +14,7 @@
     <% unless default_token.types.nil? %>
       (<span class="types"><%= default_token.types.map {|t| link_to(t) }.join ', ' %></span>)
     <% end %>
-    <%= replace_links to_html default_token.content %>
+    <%=to_html default_token.content %>
   
   <% end %>
 </li>  

data/templates/views/tokens/_example.html.erb

@@ -1,2 +1,2 @@
 <h3>Example <%= example.name %></h3>
-<%=code example.content %>
+<%=code example.content, :class => "example" %>

data/templates/views/tokens/_overload.html.erb

@@ -0,0 +1,12 @@
+<section class="overload">
+  <h2 class="signature"><%= signature overload %></h2>
+  <%=to_html overload.content %>
+  <%
+  
+    params = overload.children.select {|t| t.token == :param }
+    returns = overload.children.select {|t| t.token == :return }
+  
+  %>
+  <%= render :partial => 'tokens/default', :locals => { :tokens => params } unless params.empty? %>
+  <%= render :partial => 'tokens/default', :locals => { :tokens => returns } unless returns.empty? %>
+</section>

data/test/interactive.rb

@@ -1,6 +1,9 @@
-require_relative '../lib/boot.rb'
+require 'pathname' 
+require Pathname.new(__FILE__).realpath + '../../lib/boot'
 
-Logger.setup :level => :debug
+Configs.set :root  => Pathname.new(__FILE__).realpath + '../..'
+
+setup_application :templates => '../templates', :output => '../out'
 
 def load_core_doc
   Processor.process_files_to_dom 'test/js-files/core-doc.js'  

data/test/js-files/core-doc.js

@@ -54,25 +54,30 @@ var Core = Core || (function(){
   var core = {
 
     /**
-     * register new {Core.extensions}
-     * 
      * @function Core.extend
+     *
+     * register new {Core.extensions}
+     * 
+     * @example Testextension
+     *   // This is some http://www.link.com
+     *   Core.extend('testextension', function() {
+     *     return {};
+     *   });
+     *
+     * @event CoreExtended
+     *   Fires, if a new Extension has been registered.
+     *   [Core.extension] ext The newly registered extension
      *
      * @param [String] id the id to register the new {Core.extensionss extension} under
      * @param [Function] constructor a callback function, which acts as
      *   constructor for {Core.extensions}
      * @param settings
+     *   This is the configuration object for {Core.extend}
      *   [String] name the name of the extension
      *   [Number] pos the position to put the extension to (Defaults to 0)
      *   [String] color the background-color of the extension
      *
-     * @return [Core.logger] the constructed extension
-     *
-     *
-     * @example Testextension
-     *   Core.extend('testextension', function() {
-     *     return {};
-     *   });
+     * @return [Core.logger] the constructed extension
      */
     extend: function(id, constructor) {
       
@@ -113,11 +118,14 @@ var Core = Core || (function(){
        *
        * @function Core.logger.log
        *
-       * @overload log(msg)
+       * @overload
        *   @param [String] msg The message to log
        *
-       * @overload log(level, msg)
-       *
+       * @overload
+       *   This is just some documentation
+       *   
+       *   @param [String] level The Loglevel
+       *   @param [String] msg The message to log
        */
       log: function(msg) {
         if(!!window.console) {

data/test/parser/intelligent_skip_until.rb

@@ -106,5 +106,5 @@ describe StringScanner, "#intelligent_skip_until" do
       end
     end     
   end
-
+  
 end

data/test/parser/parser.rb

@@ -1,4 +1,4 @@
-#encoding utf-8
+#<Encoding:UTF-8>
 
 require_relative '../../lib/parser/parser'
 
@@ -245,7 +245,7 @@ describe Parser::Parser, ".parse" do
   
   
   context "parsing multibyte character" do
-=begin
+
     before do  
 
       @parser = Parser::Parser.new("/**
@@ -264,10 +264,7 @@ Foo Bar")
     it "should find the correct source" do
       subject.source.should == "Foo Bar"
     end
-    
-=end
-    pending("There are Problems with utf-8 encoded string")
-  
+   
   end  
   
 end