method
look_for_directives_in
v1_8_7_330 -
Show latest stable
- Class:
RDoc::RubyParser
look_for_directives_in(context, comment)private
Look for directives in a normal comment block:
#-- - don't display comment from this point forward
This routine modifies it’s parameter
# File lib/rdoc/parsers/parse_rb.rb, line 2309
def look_for_directives_in(context, comment)
preprocess = SM::PreProcess.new(@input_file_name,
@options.rdoc_include)
preprocess.handle(comment) do |directive, param|
case directive
when "stopdoc"
context.stop_doc
""
when "startdoc"
context.start_doc
context.force_documentation = true
""
when "enddoc"
#context.done_documenting = true
#""
throw :enddoc
when "main"
options = Options.instance
options.main_page = param
""
when "title"
options = Options.instance
options.title = param
""
when "section"
context.set_current_section(param, comment)
comment.replace("") # 1.8 doesn't support #clear
break
else
warn "Unrecognized directive '#{directive}'"
break
end
end
remove_private_comments(comment)
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