From a0f5af8c43fd64afdc7c9cbe1bf9b16f8f5cb20d Mon Sep 17 00:00:00 2001 From: Tobie Langel Date: Sun, 23 Aug 2009 04:56:49 +0200 Subject: [PATCH] doc: Update PDoc. Empty the ruby helpers which are again part of PDoc. --- templates/html/helpers.rb | 164 -------------------------------------- vendor/pdoc | 2 +- 2 files changed, 1 insertion(+), 165 deletions(-) diff --git a/templates/html/helpers.rb b/templates/html/helpers.rb index f8af6b6..1769b9d 100644 --- a/templates/html/helpers.rb +++ b/templates/html/helpers.rb @@ -3,179 +3,15 @@ module PDoc module Html module Helpers module BaseHelper - def content_tag(tag_name, content, attributes = {}) - "<#{tag_name}#{attributes_to_html(attributes)}>#{content}" - end - - def img_tag(filename, attributes = {}) - attributes.merge! :src => "#{path_prefix}images/#{filename}" - tag(:img, attributes) - end - - def tag(tag_name, attributes = {}) - "<#{tag_name}#{attributes_to_html(attributes)} />" - end - - def link_to(name, path, attributes={}) - content_tag(:a, name, attributes.merge(:href => path)) - end - - def htmlize(markdown) - BlueCloth.new(markdown).to_html - end - - # Gah, what an ugly hack. - def inline_htmlize(markdown) - htmlize(markdown).gsub(/^

/, '').gsub(/<\/p>$/, '') - end - - def javascript_include_tag(*names) - names.map do |name| - attributes = { - :src => "#{path_prefix}javascripts/#{name}.js", - :type => "text/javascript", - :charset => "utf-8" - } - content_tag(:script, "", attributes) - end.join("\n") - end - - def stylesheet_link_tag(*names) - names.map do |name| - attributes = { - :href => "#{path_prefix}stylesheets/#{name}.css", - :type => "text/css", - :media => "screen, projection", - :charset => "utf-8", - :rel => "stylesheet" - } - tag(:link, attributes) - end.join("\n") - end - - private - def attributes_to_html(attributes) - attributes.map { |k, v| v ? " #{k}=\"#{v}\"" : "" }.join - end end module LinkHelper - def path_prefix - "../" * depth - end - - def path_to(obj) - return path_to_section(obj) if obj.is_a?(Documentation::Section) - path = path_prefix << [obj.section.name.downcase].concat(obj.namespace_string.downcase.split('.')).join("/") - has_own_page?(obj) ? "#{path}/#{obj.id.downcase}.html" : "#{path}.html##{dom_id(obj)}" - end - - def path_to_section(obj) - "#{path_prefix}#{obj.id.gsub(/\s/, '_')}.html" - end - - def section_from_name(name) - root.sections.find { |section| section.name == name } - end - - def auto_link(obj, short = true, attributes = {}) - if obj.is_a?(String) && obj =~ /\ssection$/ - obj = section_from_name(obj.gsub(/\ssection$/, '')) - end - obj.sub!('...', '…') if obj.is_a?(String) - if obj.is_a?(String) && obj.strip =~ /^\[.+\]$|\|/ - return obj.gsub(/[^\],.…\s\|\[]+/) { |item| auto_link(item, short, attributes) } - end - obj = root.find_by_name(obj) || obj if obj.is_a?(String) - return nil if obj.nil? - return obj if obj.is_a?(String) - name = short ? obj.name : obj.full_name - link_to(name, path_to(obj), { :title => "#{obj.full_name} (#{obj.type})" }.merge(attributes)) - end - - def auto_link_code(obj, short = true, attributes = {}) - return "#{auto_link(obj, short, attributes)}" - end - - def auto_link_content(content) - content.gsub!(/\[\[([a-zA-Z]+)\s+section\]\]/) do |m| - result = auto_link(section_from_name($1), false) - result - end - content.gsub(/\[\[([a-zA-Z$\.#]+)(?:\s+([^\]]+))?\]\]/) do |m| - if doc_instance = root.find_by_name($1) - $2 ? link_to($2, path_to(doc_instance)) : - auto_link_code(doc_instance, false) - else - $1 - end - end - end - - def dom_id(obj) - "#{obj.id}-#{obj.type.gsub(/\s+/, '_')}" - end - - private - def has_own_page?(obj) - obj.is_a?(Documentation::Namespace) || obj.is_a?(Documentation::Utility) - end end module CodeHelper - def method_synopsis(object) - result = [] - result << '

'
-            if object.is_a?(Documentation::Property)
-              result << "#{object.signature}"
-            else
-              ebnfs = object.ebnf_expressions.dup
-              if object.is_a?(Documentation::KlassMethod) && object.methodized?
-                result << "#{object.static_signature} ⇒ #{auto_link(object.returns, false)}
"
-                result << "#{object.signature} ⇒ #{auto_link(object.returns, false)}"
-                ebnfs.shift
-                result.last << '
' unless ebnfs.empty?
-              end
-              ebnfs.each do |ebnf|
-                result << "#{ebnf.signature} ⇒ #{auto_link(ebnf.returns, false)}"
-              end
-            end
-            result << '
' - result.join('') - end end module MenuHelper - def menu(obj) - class_names = menu_class_name(obj) - html = <<-EOS -
- #{auto_link(obj, false, :class => class_names_for(obj))} -
- EOS - unless obj.children.empty? - html << content_tag(:ul, obj.children.map { |n|menu(n) }.join("\n")) - end - content_tag(:li, html, :class => class_names) - end - - def menu_class_name(obj) - if !doc_instance - nil - elsif obj == doc_instance - "current" - elsif obj.descendants.include?(doc_instance) - "current-parent" - else - nil - end - end - - def class_names_for(obj) - classes = [obj.type.gsub(/\s+/, '-')] - classes << "deprecated" if obj.deprecated? - classes.join(" ") - end end end end diff --git a/vendor/pdoc b/vendor/pdoc index 6fc6b35..285f6c4 160000 --- a/vendor/pdoc +++ b/vendor/pdoc @@ -1 +1 @@ -Subproject commit 6fc6b3510554801fb300068a51562c9959b5b46c +Subproject commit 285f6c47a73ea5eb1bd70c4496feddefad6ff901