Method: RDoc::Parser::Ruby#look_for_directives_in

Defined in:
lib/rdoc/parser/ruby.rb

#look_for_directives_in(container, comment) ⇒ Object

Look for directives in a normal comment block:

# :stopdoc:
# Don't display comment from this point forward

This routine modifies its comment parameter.



643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
 
# File 'lib/rdoc/parser/ruby.rb', line 643

def look_for_directives_in container, comment
  @preprocess.handle comment, container do |directive, param|
    case directive
    when 'method', 'singleton-method',
         'attr', 'attr_accessor', 'attr_reader', 'attr_writer' then
      false # handled elsewhere
    when 'section' then
      break unless container.kind_of?(RDoc::Context)
      container.set_current_section param, comment.dup
      comment.text = ''
      break
    end
  end

  comment.remove_private
end