method
collect_first_comment
ruby latest stable - Class:
RDoc::RubyParser
Method deprecated or moved
This method is deprecated or moved on the latest stable version. The last existing version (v1_8_7_330) is shown here.
collect_first_comment()private
Look for the first comment in a file that isn’t a shebang line.
# File lib/rdoc/parsers/parse_rb.rb, line 1542
def collect_first_comment
skip_tkspace
res = ''
first_line = true
tk = get_tk
while tk.kind_of?(TkCOMMENT)
if first_line && /\A#!/ =~ tk.text
skip_tkspace
tk = get_tk
elsif first_line && /\A#\s*-\*-/ =~ tk.text
first_line = false
skip_tkspace
tk = get_tk
else
first_line = false
res << tk.text << "\n"
tk = get_tk
if tk.kind_of? TkNL
skip_tkspace(false)
tk = get_tk
end
end
end
unget_tk(tk)
res
end Related methods
- Instance methods
- scan
- Class methods
- new
- Private methods
-
add_token_listener -
collect_first_comment -
error -
get_bool -
get_class_or_module -
get_class_specification -
get_constant -
get_constant_with_optional_parens -
get_symbol_or_name -
get_tk -
get_tkread -
look_for_directives_in -
make_message -
parse_alias -
parse_attr -
parse_attr_accessor -
parse_call_parameters -
parse_class -
parse_constant -
parse_include -
parse_method -
parse_method_or_yield_parameters -
parse_method_parameters -
parse_module -
parse_require -
parse_statements -
parse_symbol_arg -
parse_symbol_in_arg -
parse_toplevel_statements -
parse_visibility -
parse_yield -
parse_yield_parameters -
peek_read -
peek_tk -
progress -
read_directive -
read_documentation_modifiers -
remove_private_comments -
remove_token_listener -
skip_for_variable -
skip_method -
skip_optional_do_after_expression -
skip_tkspace -
skip_tkspace_comment -
unget_tk -
warn