This class contains methods useful for extracting documentation from methods and classes.
# File lib/pry/helpers/documentation_helpers.rb, line 39 def process_comment_markup(comment) process_yardoc process_rdoc(comment) end
# File lib/pry/helpers/documentation_helpers.rb, line 7 def process_rdoc(comment) comment = comment.dup comment.gsub(/<code>(?:\s*\n)?(.*?)\s*<\/code>/) { Pry.color ? CodeRay.scan($1, :ruby).term : $1 }. gsub(/<em>(?:\s*\n)?(.*?)\s*<\/em>/) { Pry.color ? "\e[1m#{$1}\e[0m": $1 }. gsub(/<i>(?:\s*\n)?(.*?)\s*<\/i>/) { Pry.color ? "\e[1m#{$1}\e[0m" : $1 }. gsub(/\B\+(\w*?)\+\B/) { Pry.color ? "\e[32m#{$1}\e[0m": $1 }. gsub(/((?:^[ \t]+.+(?:\n+|\Z))+)/) { Pry.color ? CodeRay.scan($1, :ruby).term : $1 }. gsub(/`(?:\s*\n)?([^\e]*?)\s*`/) { "`#{Pry.color ? CodeRay.scan($1, :ruby).term : $1}`" } end
# File lib/pry/helpers/documentation_helpers.rb, line 32 def process_yardoc(comment) yard_tags = ["param", "return", "option", "yield", "attr", "attr_reader", "attr_writer", "deprecate", "example", "raise"] (yard_tags - ["example"]).inject(comment) { |a, v| process_yardoc_tag(a, v) }. gsub(/^@(#{yard_tags.join("|")})/) { Pry.color ? "\e[33m#{$1}\e[0m": $1 } end
# File lib/pry/helpers/documentation_helpers.rb, line 17 def process_yardoc_tag(comment, tag) in_tag_block = nil comment.lines.map do |v| if in_tag_block && v !~ /^\S/ Pry::Helpers::Text.strip_color Pry::Helpers::Text.strip_color(v) elsif in_tag_block in_tag_block = false v else in_tag_block = true if v =~ /^@#{tag}/ v end end.join end
@param [String] code @return [String]
# File lib/pry/helpers/documentation_helpers.rb, line 45 def strip_comments_from_c_code(code) code.sub(/\A\s*\/\*.*?\*\/\s*/, '') end
@param [String] comment @return [String]
# File lib/pry/helpers/documentation_helpers.rb, line 51 def strip_leading_hash_and_whitespace_from_ruby_comments(comment) comment = comment.dup comment.gsub!(/\A\#+?$/, '') comment.gsub!(/^\s*#/, '') strip_leading_whitespace(comment) end
Generated with the Darkfish Rdoc Generator 2.