Module Pry::Helpers::DocumentationHelpers
In: lib/pry/helpers/documentation_helpers.rb

This class contains methods useful for extracting documentation from methods and classes.

Methods

get_comment_content   process_comment_markup   process_rdoc   process_yardoc   process_yardoc_tag   strip_comments_from_c_code   strip_leading_whitespace  

Public Instance methods

get_comment_content(comment)

Given a string that makes up a comment in a source-code file parse out the content that the user is intended to read. (i.e. without leading indentation, #-characters or shebangs)

@param [String] comment @return [String]

strip_comments_from_c_code(code)

@param [String] code @return [String]

strip_leading_whitespace(text)

@param [String] text @return [String]

[Validate]