method
parse_comment
v2_1_10 -
Show latest stable
- Class:
RDoc::Parser::Ruby
parse_comment(container, tk, comment)public
Generates an RDoc::Method or RDoc::Attr from comment by looking for :method: or :attr: directives in comment.
# File lib/rdoc/parser/ruby.rb, line 949
def parse_comment container, tk, comment
return parse_comment_tomdoc container, tk, comment if @markup == 'tomdoc'
column = tk.char_no
offset = tk.seek
line_no = tk.line_no
text = comment.text
singleton = !!text.sub!(/(^# +:?)(singleton-)(method:)/, '\1\3')
co =
if text.sub!(/^# +:?method: *(\S*).*?\n/, '') then
parse_comment_ghost container, text, $1, column, line_no, comment
elsif text.sub!(/# +:?(attr(_reader|_writer|_accessor)?): *(\S*).*?\n/, '') then
parse_comment_attr container, $1, $3, comment
end
if co then
co.singleton = singleton
co.offset = offset
co.line = line_no
end
true
end Related methods
- Instance methods
- collect_first_comment
- consume_trailing_spaces
- create_attr
- create_module_alias
- error
- get_bool
- get_class_or_module
- get_class_specification
- get_constant
- get_constant_with_optional_parens
- get_end_token
- get_method_container
- get_symbol_or_name
- get_tkread_clean
- get_visibility_information
- look_for_directives_in
- make_message
- new_comment
- parse_alias
- parse_attr
- parse_attr_accessor
- parse_call_parameters
- parse_class
- parse_class_regular
- parse_class_singleton
- parse_comment
- parse_comment_attr
- parse_comment_ghost
- parse_comment_tomdoc
- parse_constant
- parse_constant_body
- parse_extend_or_include
- parse_identifier
- parse_meta_attr
- parse_meta_method
- parse_meta_method_name
- parse_meta_method_params
- parse_method
- parse_method_dummy
- parse_method_name
- parse_method_name_regular
- parse_method_name_singleton
- parse_method_or_yield_parameters
- parse_method_parameters
- parse_method_params_and_body
- parse_module
- parse_require
- parse_rescue
- parse_statements
- parse_symbol_arg
- parse_symbol_arg_paren
- parse_symbol_arg_space
- parse_symbol_in_arg
- parse_top_level_statements
- parse_visibility
- parse_yield
- read_directive
- read_documentation_modifiers
- record_location
- remove_private_comments
- scan
- skip_for_variable
- skip_method
- skip_optional_do_after_expression
- skip_tkspace_comment
- stop_at_EXPR_END
- suppress_parents
- update_visibility
- warn
- Class methods
- new