yard-js 0.1.1

data/templates/default/tags/callback.erb

@@ -0,0 +1,21 @@
+<% if object.tags(:callback).size == 1 %>
+  <% callback = object.tag(:callback) %>
+  <p class="tag_title">Callback (<tt><%= callback.param_name %></tt>):</p>
+  <ul class="callback">
+    <li class="callback_item">
+      <span class="signature"><%= signature(callback, false, false) %></span>
+      <%= yieldall :object => callback %>
+    </li>
+  </ul>
+<% elsif object.has_tag?(:callback) && object.tags(:callback).any? {|o| !o.docstring.blank? } %>
+  <p class="tag_title">Callbacks:</p>
+  <ul class="callback">
+    <% object.tags(:callback).each do |callback| %>
+      <% next if callback.docstring.blank? %>
+      <li class="callback_item">
+        <span class="signature"><%= signature(callback, false, false) %></span>
+        <%= yieldall :object => callback %>
+      </li>
+    <% end %>
+  </ul>
+<% end %>

data/templates/default/tags/setup.rb

@@ -0,0 +1,24 @@
+def init
+  super
+  sections.place(:callback, [T('docstring')]).after_any(:param)
+end
+
+def return
+  if object.type == :property
+    return if object.property_type == :literal
+    return if object.constructor?
+    return if object.tags(:return).size == 1 && object.tag(:return).text.empty?
+  end
+  tag(:return)
+end
+
+def param
+  tag(:param) if object.type == :property || object.type == :event
+end
+
+def value
+  return if object.tag(:constant)
+  if object.has_tag?(:value) && !object.tag(:value).text.empty?
+    erb(@name = :value)
+  end
+end

data/templates/default/tags/value.erb

@@ -0,0 +1,6 @@
+<p class="tag_title"><%= @label ? @label : YARD::Tags::Library.labels[@name] %>:</p>
+<div class="examples">
+<% object.tags(@name).each do |tag| %>
+  <pre class="example code value_tag"><code><%= object.path %> = <%= h(tag.text) %></code></pre>
+<% end %>
+</div>

data/yard-js.gemspec

@@ -0,0 +1,15 @@
+require File.expand_path('../lib/yard-js/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = "yard-js"
+  s.summary       = "YARD plugin for documenting JavaScript source code"
+  s.version       = YARDJS::VERSION
+  s.date          = Time.now.strftime('%Y-%m-%d')
+  s.author        = "Loren Segal"
+  s.email         = "lsegal@soen.ca"
+  s.homepage      = "http://github.com/lsegal/yard-js"
+  s.platform      = Gem::Platform::RUBY
+  s.files         = Dir.glob("{lib,templates}/**/*") +
+                    ['LICENSE.txt', 'README.md', __FILE__]
+  s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: yard-js
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Loren Segal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-07 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: lsegal@soen.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/yard-js/code_objects/event_object.rb
+- lib/yard-js/code_objects/property_object.rb
+- lib/yard-js/code_objects.rb
+- lib/yard-js/core_ext/parsejs.rb
+- lib/yard-js/core_ext/yard/code_objects.rb
+- lib/yard-js/core_ext/yard/registry.rb
+- lib/yard-js/core_ext/yard/tags.rb
+- lib/yard-js/core_ext/yard/templates.rb
+- lib/yard-js/core_ext/yard/yardoc.rb
+- lib/yard-js/core_ext/yard.rb
+- lib/yard-js/handlers/base.rb
+- lib/yard-js/handlers/class_handler.rb
+- lib/yard-js/handlers/comment_handler.rb
+- lib/yard-js/handlers/constant_handler.rb
+- lib/yard-js/handlers/instance_method_handler.rb
+- lib/yard-js/handlers/mixin_handler.rb
+- lib/yard-js/handlers/module_handler.rb
+- lib/yard-js/handlers.rb
+- lib/yard-js/parser.rb
+- lib/yard-js/plugin.rb
+- lib/yard-js/tags.rb
+- lib/yard-js/version.rb
+- lib/yard-js.rb
+- templates/default/class/setup.rb
+- templates/default/fulldoc/html/css/highlight.github.css
+- templates/default/fulldoc/html/css/style.css
+- templates/default/fulldoc/html/full_list_property.erb
+- templates/default/fulldoc/html/js/highlight.pack.js
+- templates/default/fulldoc/html/setup.rb
+- templates/default/layout/html/headers.erb
+- templates/default/layout/html/setup.rb
+- templates/default/method_details/setup.rb
+- templates/default/module/html/constructor_summary.erb
+- templates/default/module/html/events_details.erb
+- templates/default/module/html/events_summary.erb
+- templates/default/module/html/inherited_methods.erb
+- templates/default/module/html/inherited_properties.erb
+- templates/default/module/html/item_summary.erb
+- templates/default/module/html/method_summary.erb
+- templates/default/module/html/methods_details.erb
+- templates/default/module/html/properties_details.erb
+- templates/default/module/html/properties_summary.erb
+- templates/default/module/setup.rb
+- templates/default/tags/callback.erb
+- templates/default/tags/setup.rb
+- templates/default/tags/value.erb
+- LICENSE.txt
+- README.md
+- yard-js.gemspec
+homepage: http://github.com/lsegal/yard-js
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: YARD plugin for documenting JavaScript source code
+test_files: []
+has_rdoc: