voloko-sdoc 0.2.9 → 0.2.10

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :minor: 2
-:patch: 9
+:patch: 10
 :major: 0

data/lib/sdoc/generator/shtml.rb

@@ -21,8 +21,12 @@ require 'sdoc/templatable'
 require 'sdoc/helpers'
 
 class RDoc::ClassModule
+  def document_self_or_methods
+    document_self || method_list.any?{ |m| m.document_self }
+  end
+  
   def with_documentation?
-    document_self || classes_and_modules.any?{ |c| c.with_documentation? }
+    document_self_or_methods || classes_and_modules.any?{ |c| c.with_documentation? }
   end
 end
 
@@ -127,7 +131,7 @@ class RDoc::Generator::SHtml
     classes.select{|c| c.with_documentation? }.sort.each do |klass|
       item = [
         klass.name, 
-        klass.document_self ? klass.path : '',
+        klass.document_self_or_methods ? klass.path : '',
         klass.module? ? '' : (klass.superclass ? " < #{String === klass.superclass ? klass.superclass : klass.superclass.full_name}" : ''), 
         generate_class_tree_level(klass.classes_and_modules)
       ]
@@ -164,8 +168,8 @@ class RDoc::Generator::SHtml
   def add_file_search_index(index)
     debug_msg "  generating file search index"
     
-    @files.select { |method| 
-      method.document_self 
+    @files.select { |file| 
+      file.document_self 
     }.sort.each do |file|
       index[:searchIndex].push( search_string(file.name) )
       index[:longSearchIndex].push( search_string(file.path) )
@@ -184,8 +188,8 @@ class RDoc::Generator::SHtml
   def add_class_search_index(index)
     debug_msg "  generating class search index"
     
-    @classes.select { |method| 
-      method.document_self 
+    @classes.select { |klass| 
+      klass.document_self_or_methods
     }.sort.each do |klass|
       index[:searchIndex].push( search_string(klass.name) )
       index[:longSearchIndex].push( search_string(klass.parent.name) )
@@ -205,7 +209,7 @@ class RDoc::Generator::SHtml
     debug_msg "  generating method search index"
     
     list = @classes.map { |klass| 
-      klass.method_list 
+      klass.method_list
     }.flatten.sort{ |a, b| a.name == b.name ? a.parent.full_name <=> b.parent.full_name : a.name <=> b.name }.select { |method| 
       method.document_self 
     }

data/lib/sdoc/generator/template/direct/_context.rhtml

@@ -1,6 +1,8 @@
 <div id="content">
     <% unless (desc = context.description).empty? %>
-    <div class="description"><%= desc %></div>
+    <div class="description">
+        <%= desc %>
+    </div>
     <% end %>
 
     <% unless context.requires.empty? %>
@@ -116,7 +118,7 @@
         next if visibilities.empty?
         visibilities.each do |visibility, methods|
             next if methods.empty? 
-            next unless visibility == :public || visibility == :protected || methods.any? {|m| m.force_documentation }
+            next unless @options.show_all || visibility == :public || visibility == :protected || methods.any? {|m| m.force_documentation }
             %>
             <div class="sectiontitle"><%= type.capitalize %> <%= visibility.to_s.capitalize %> methods</div>
             <% methods.each do |method| %>
@@ -130,8 +132,7 @@
                 </div>
                 <% unless (description = method.description).empty? %>
                 <div class="description">
-                  <%# TODO delete this dirty hack when documentation for example for JavaScriptHelper will not be cutted off by <script> tag %>
-                  <%= description.gsub('<script>'){ |m| h(m) } %>
+                  <%= description %>
                 </div>
                 <% end %>
                 <% unless method.aliases.empty? %>

data/lib/sdoc/generator/template/shtml/_context.rhtml

@@ -109,7 +109,7 @@
         next if visibilities.empty?
         visibilities.each do |visibility, methods|
             next if methods.empty? 
-            next unless visibility == :public || visibility == :protected || methods.any? {|m| m.force_documentation }
+            next unless @options.show_all || visibility == :public || visibility == :protected || methods.any? {|m| m.force_documentation }
             %>
             <div class="sectiontitle"><%= type.capitalize %> <%= visibility.to_s.capitalize %> methods</div>
             <% methods.each do |method| %>

data/lib/sdoc/templatable.rb

@@ -32,6 +32,10 @@ module SDoc::Templatable
 	### Both +templatefile+ and +outfile+ should be Pathname-like objects.
 	def render_template( templatefile, context, outfile )
     output = eval_template(templatefile, context)
+    
+    # TODO delete this dirty hack when documentation for example for GeneratorMethods will not be cutted off by <script> tag
+    output = output.gsub('<script>', '&lt;script;&gt;')
+    
 		unless $dryrun
 			outfile.dirname.mkpath
 			outfile.open( 'w', 0644 ) do |file|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: voloko-sdoc
 version: !ruby/object:Gem::Version 
-  version: 0.2.9
+  version: 0.2.10
 platform: ruby
 authors: 
 - Volodya Kolesnikov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-15 00:00:00 -07:00
+date: 2009-04-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency