method

read_directive

v1_9_2_180 - Show latest stable - Class: RDoc::Parser::Ruby

read_directive(allowed)

public

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

def fred # :yields: a, b

or:

class MyClass # :nodoc:

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

# File lib/rdoc/parser/ruby.rb, line 1424
  def read_directive(allowed)
    tk = get_tk
    result = nil

    if TkCOMMENT === tk then
      if tk.text =~ /\s*:?(\w+):\s*(.*)/ then
        directive = $1.downcase
        if allowed.include? directive then
          result = [directive, $2]
        end
      end
    else
      unget_tk tk
    end

    result
  end

read_directive

Related methods