record_location(top_level) Instance Public methods Records the RDoc::TopLevel (file) where this code object was defined

section() Instance Public methods The section this CodeObject is in. Sections allow grouping of constants, attributes and methods inside a class or module.

start_doc() Instance Public methods Enable capture of documentation unless documentation has been turned off by :enddoc:

stop_doc() Instance Public methods Disable capture of documentation

new(text = nil, location = nil) Class Public methods Creates a new comment with text that is found in the RDoc::TopLevel location.

empty?() Instance Public methods A comment is empty if its text String is empty.

extract_call_seq(method) Instance Public methods Look for a 'call-seq' in the comment to override the normal parameter handling. The :call-seq: is indented from the baseline. All lines of the same indentation level and prefix are consumed. For example, all of the following will be used as the :call-seq: # :call-seq: # ARGF.readlines(sep=$/) -> array # ARGF.readlines(limit) -> array # ARGF.readlines(sep, limit) -> array # # ARGF.to_a(sep=$/) -> arr

force_encoding(encoding) Instance Public methods HACK dubious

format=(format) Instance Public methods Sets the format of this comment and resets any parsed document

normalize() Instance Public methods Normalizes the text. See RDoc::Text#normalize_comment for details