method

read_directive

v1_8_7_330 - Show latest stable - Class: RDoc::RubyParser

read_directive(allowed)

private

Directives are modifier comments that can appear after class, module, or method names. For example

def fred    # :yields:  a, b

class SM  # :nodoc:

we return the directive name and any parameters as a two element array

# File lib/rdoc/parsers/parse_rb.rb, line 2254
    def read_directive(allowed)
      tk = get_tk
      puts "directive: #{tk.inspect}" if $DEBUG
      result = nil
      if tk.kind_of?(TkCOMMENT) 
        if tk.text =~ /\s*:?(\w+):\s*(.*)/
          directive = $1.downcase
          if allowed.include?(directive)
            result = [directive, $2]
          end
        end
      else
        unget_tk(tk)
      end
      result
    end

read_directive

Related methods