docjs 0.1.5 → 0.2

data/templates/resources/js/jcore.js

@@ -69,7 +69,27 @@ var J = J || jCore;
     };
   
   /**
-   * @function jCore.create
+   * @function J.create
+   *
+   * @example
+   *   J.create("Person", {
+   *     constructor: function(name) {
+   *       this.name = name;
+   *     }, 
+   *     say_name: function() { return this.name; }
+   *   });
+   *
+   * @example Using revealing module pattern
+   *   J.create("Person", {
+   *     constructor: function(name) {
+   *       return {
+   *         say_name: function() { return name; }
+   *       };
+   *     }
+   *   });
+   *
+   * @example Extending an object
+   *   J.create("Student", Person
    *
    * Also mitigates the problem of using 'new' to create new instances. After 
    * creating the class Foo with creat, the following versions of instantiation 
@@ -78,7 +98,22 @@ var J = J || jCore;
    *     Foo("bar");
    *     new Foo("bar");
    *
-   * @overload J.create(path, options) 
+   * @overload
+   *   Creates a class called `path` and extends it with the given options
+   *   
+   *   @param [String] path
+   *   @param options
+   *     All options will be added as property to the object
+   *     [Function] constructor The constructor of the class, which will be called, when
+   *       instantiating a new object
+   * 
+   * @overload
+   *   Creates a class `path`, that inherits from `parent` and will be extended with the given
+   *   options
+   *   
+   *   @param [String] path
+   *   @param [Object] parent
+   *   @param [Hash] options (see other overload)
    */
   J.create = function(path, inherited, options) {   
     

data/templates/resources/scss/_header.scss

@@ -34,7 +34,7 @@
     }
     
     input#search {
-      border-radius: $radius;
+      @include border-radius($radius);
       outline: none;
       padding: 0.2em 0.5em;
     }
@@ -48,8 +48,8 @@
         @include float(left);
         
         /* rounded corners */
-        &:first-child a { border-radius: 0 0 0 $radius; }
-        &:last-child a { border-radius: 0 0 $radius 0; }        
+        &:first-child a { @include border-radius(0 0 0 $radius); }
+        &:last-child a { @include border-radius(0 0 $radius 0); }        
       }
             
       a {
@@ -87,9 +87,8 @@
       
       > ul {
         @include scrollbars; 
-        
+        @include border-radius($radius);
         border: 1px solid #eee;
-        border-radius: $radius;
         padding: 0; margin: 0;
         
         overflow: hidden; 

data/templates/resources/scss/_helpers.scss

@@ -85,6 +85,12 @@ $golden_ratio: 1.618;
   }
 }
 
+@mixin border-radius($radius) {
+  -moz-border-radius: $radius; /* Firefox */
+  -webkit-border-radius: $radius; /* Safari, Chrome */
+  border-radius: $radius; /* CSS3 */  
+}
+
 @mixin float($direction) {
   display: block;
   float: $direction;

data/templates/resources/scss/_highlighter.scss

@@ -1,11 +1,7 @@
-@mixin line-height-fix() {
-  font-size: 9pt;
-  line-height: 1.4em;
-}
-
 code.source, code.example {
   @include code-box;
-  @include line-height-fix;
+  font-size: 9pt;
+  line-height: 1.6em;
   padding: 0.5em;
   margin-bottom: $element-margin;  
 }
@@ -34,7 +30,7 @@ code.source, code.example {
     text-align: right;
     
     .line {
-      @include line-height-fix;
+      height: 1.6em;
     }
   }
   
@@ -43,7 +39,8 @@ code.source, code.example {
     width: 100%;
     
     .line {
-      padding: 0 0.5em;
+      height: 1.6em;
+      padding: 0 0.5em;      
       &:hover { background: #f5f5f5; }
     }
   }

data/templates/resources/scss/_tooltip.scss

@@ -2,7 +2,8 @@
   /*@include double-border(1px, #fff, #ccc);*/
   @include gradient(#333, #555);
   @include reset-fonts;
-    
+  @include border-radius($radius/2);
+   
   display: none;
   position: absolute;
   padding: 0.5em;
@@ -12,7 +13,6 @@
   font-size: 9pt;
   color: #eee;
   border: 1px solid #fff;
-  border-radius: $radius/2;
   box-shadow: 0 0 10px rgba(0,0,0,0.15);
   
   a {

data/templates/resources/scss/application.scss

@@ -86,11 +86,12 @@ $element-margin: 1.33em;
   @if $terminal == true {
     @include terminal;
   }
+  @include border-radius($radius/2);
   display: block;
   background: $color;
   border: 1px solid darken($color, 8%);
   color: darken($fontcolor, 40%);
-  border-radius: $radius/2;
+  
   padding: 0.4em 1em;
 }
 
@@ -140,10 +141,11 @@ div#main {
   @include page-center;
   @include typography;
   @include clearfix;
+  @include border-radius(10px 10px 0 0);
 
   margin-top: -$page-indent;
 
-  border-radius: 10px 10px 0 0;
+  
   box-shadow: 0px -0px 5px rgba(0,0,0,0.1);
 
   border-top: 1px solid #eee;
@@ -169,10 +171,10 @@ div#main nav.sidebar {
 
   @include float(right);
   @include code-box;
+  @include border-radius(5px);
       
   margin: 2*$page-padding 0 $box-spacing $box-spacing;
-  padding: 0;
-  border-radius: 5px;
+  padding: 0;  
   font-size: 8pt;
   color: #999;
   

data/templates/tokens/tokens.rb

@@ -1,19 +1,50 @@
 module Token::Handler
 
-  register :author, :area => :sidebar
-  register :public, :area => :sidebar
+  # @group Metainfo-Tokens
+  register :author,  :area => :sidebar
+  register :public,  :area => :sidebar
   register :private, :area => :sidebar
   register :version, :area => :sidebar
   
-  register :see, :area => :footnote
-
+  # @group Notification Tokens
   register :deprecated, :area => :notification  
-  register :todo, :area => :notification
-  register :note, :area => :notification
-  register :warn, :area => :notification
-  
-  register :example, :template => :examples, :handler => :named_multiline
+  register :todo,       :area => :notification
+  register :note,       :area => :notification
+  register :warn,       :area => :notification
+    
+  # @group Function specific Tokens
+
+  # We want to support either named-typed-tokens like
+  #  @param [Foo] barname some description
+  #
+  # or multiline tokens like:
+  #  @param configs
+  #    Some configuration Object with following properties:
+  #    [String] foo some string
+  #    [Bar] bar and another one
+  register :param, 
+            :area => :none, 
+            :description => "Token for Function-Parameters like '@param [String] name your name'" do |tokenklass, content|
+
+    # it's @param [String] name some content
+    if content.lines.first.match Token::Handler::TOKEN_W_TYPE_NAME
+      self.add_token Token::Handler.apply(:typed_with_name, Token::Token::ParamToken, content)
+    
+    # it maybe a multiline
+    else
+      self.add_token Token::Handler.apply(:named_nested_shorthand, Token::Token::ParamToken, content)
+    end   
+  end
+
+  register :return, :handler => :typed, :area => :none, :description => "Returnvalue of a Function"
+  register :throws, :handler => :typed
    
+  # MethodAlias
+  register :method, :handler => :noop, :area => :none, :type => CodeObject::Function
+
+  # ConstructorAlias
+  register(:constructor, :type => CodeObject::Function) { |token, content| @constructor = true }
+  
   # Every @overload can contain **text-documentation**, **@param**- and **@return**-tokens
   #
   # It may look like:
@@ -62,6 +93,9 @@ module Token::Handler
     self.add_token token_klass.new :content => documentation.join("\n"), :children => children, :name => self.name
   end
   
+  
+  # @group Miscellaneous Tokens
+  
   # Example:
   #     @event MyCustomEvent
   #       This event will be triggered, if something special happens. The registered handler will be
@@ -69,5 +103,9 @@ module Token::Handler
   #       [Object] obj This object
   #       [String] msg Some message 
   register :event, :area => :body, :handler => :named_nested_shorthand
+  register :example, :template => :examples, :handler => :named_multiline    
+  register :prop, :handler => :typed_with_name
+  register :see, :area => :footnote
   
 end
+

data/templates/types/function.rb

@@ -1,63 +1,25 @@
-module CodeObject
-
-  class Function < CodeObject::Object
-   
-    token_reader :params, :param
-    token_reader :returns, :return
-  
-    def constructor?
-      @constructor || false
-    end
-    
-    # @todo i need a @prototype token in object
-    def prototype
-      children[:prototype]
-    end
+class CodeObject::Function < CodeObject::Object
+ 
+  token_reader :params, :param
+  token_reader :returns, :return
+
+  def constructor?
+    @constructor || false
+  end
   
-    def display_name
-      @name + '()'
-    end
-    
-  end 
+  # @todo i need a @prototype token in object
+  def prototype
+    children[:prototype]
+  end
+
+  def display_name
+    @name + '()'
+  end
   
-end
+end 
 
 Token::Handler.register :function, 
          :handler => :noop, 
          :area => :none,
-         :description => "Type-Token to categorize all kind of JavaScript-Functions"
-
-
-# We want to support either named-typed-tokens like
-#  @param [Foo] barname some description
-#
-# or multiline tokens like:
-#  @param configs
-#    Some configuration Object with following properties:
-#    [String] foo some string
-#    [Bar] bar and another one
-#
-# @note this can also be utilized for JavaScript-Event-Triggers or Callbacks with Parameters
-Token::Handler.register :param, :area => :none, :description => "Token for Function-Parameters like '@param [String] name your name'" do |tokenklass, content|
-
-  # it's @param [String] name some content
-  if content.lines.first.match Token::Handler::TOKEN_W_TYPE_NAME
-    self.add_token Token::Handler.apply(:typed_with_name, Token::Token::ParamToken, content)
-  
-  # it maybe a multiline
-  else
-    self.add_token Token::Handler.apply(:named_nested_shorthand, Token::Token::ParamToken, content)
-  end   
-end
-
-
-Token::Handler.register :return, :handler => :typed, :area => :none, :description => "Returnvalue of a Function"
-Token::Handler.register :throws, :handler => :typed
-
-# MethodAlias
-class CodeObject::Method < CodeObject::Function; end
-Token::Handler.register :method, :handler => :noop, :area => :none
-
-# ConstructorAlias
-class CodeObject::Constructor < CodeObject::Function; end
-Token::Handler.register(:constructor) { |token, content| @constructor = true }
+         :type => CodeObject::Function,         
+         :description => "Type-Token to categorize all kind of JavaScript-Functions"

data/templates/types/object.rb

@@ -1,12 +1,5 @@
-module CodeObject
-
-  class Object < CodeObject::Base
-    
-    token_reader :props, :prop
-    
-  end
-    
+class CodeObject::Object < CodeObject::Base
+  token_reader :props, :prop
 end
 
-Token::Handler.register :object, :handler => :noop, :area => :none
-Token::Handler.register :prop, :handler => :typed_with_name
+Token::Handler.register :object, :handler => :noop, :area => :none, :type => CodeObject::Object

data/templates/types/prototype.rb

@@ -11,4 +11,4 @@ class CodeObject::Prototype < CodeObject::Object
   
 end
 
-Token::Handler.register :prototype, :handler => :noop, :area => :none
+Token::Handler.register :prototype, :handler => :noop, :area => :none, :type => CodeObject::Prototype

data/test/docs/README.md

@@ -1,14 +1,35 @@
-jsdoc
-=====
-After total dataloss i have to rewrite the Readme's and Test's, so please be patient.
-jsdoc is currently **not a bit** stable. Stay tuned. {doc:README.CONCEPT#Function} oder {doc:README}
-
-For some more information about the architecture see:
-
-  - {Core Kern}  
-  - {CodeObject}
-  - {Token}
-  - {Dom}  
-  - {Renderer}
-  
-The 'executable' is {JsDoc}
+Beautiful, flexible JavaScript Documentation
+============================================
+Doc.js automatically creates beautiful documentation from your JavaScript-Source. 
+
+Features
+--------
+- One command to install
+- Use markdown in your documentation
+- Easy to customize (Create your own DSL in a sec!)
+- Nice and clean default template
+- Integrates well with your existing deployment
+- For ruby lovers - it's written in ruby
+
+Installation
+------------
+If you have Ruby 1.9 and rubygems installed you only need to type
+
+    gem install docjs
+
+That's Your Part
+----------------
+Because Doc.js basically is language unaware, you have to tell it what to do. This example shows how 
+your documentation could look like
+
+    /**
+     * @function medianight.create_poster
+     *
+     * This function creates a poster, which can be used at the MediaNight
+     * @param [String] term Something like "SS2011"
+     * @param [Numeric] dpi The target-resolution of the poster
+     * @return [Poster] The finished poster
+     */
+     medianight.create_poster = function(term, dpi) {
+        ...
+     }

metadata

@@ -2,7 +2,7 @@
 name: docjs
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.5
+  version: "0.2"
 platform: ruby
 authors: 
 - "Jonathan Brachth\xC3\xA4user"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-25 00:00:00 +02:00
+date: 2011-06-28 00:00:00 +02:00
 default_executable: bin/docjs
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,7 +35,7 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id002
-description: Create beautyful Javascript documentations with this ruby-gem. It's pretty easy to customize and add your own tokens/DSL.
+description: Create beautiful Javascript documentations with this ruby-gem. It's pretty easy to customize and add your own tokens/DSL.
 email: jonathan@b-studios.de
 executables: 
 - docjs
@@ -49,9 +49,6 @@ files:
 - bin/docjs
 - bin/docjs.rb
 - docjs.gemspec
-- docs/ARCHITECTURE.md
-- docs/CONCEPT.md
-- docs/DOCUMENTATION.md
 - docs/PATTERNS.md
 - docs/guides/CUSTOMIZE.md
 - docs/guides/TRY.md
@@ -126,7 +123,6 @@ files:
 - templates/views/doc_page.html.erb
 - templates/views/function/_detail.html.erb
 - templates/views/function/index.html.erb
-- templates/views/index.html.erb
 - templates/views/layout/application.html.erb
 - templates/views/layout/json.html.erb
 - templates/views/object/index.html.erb