method

read_directive

v1_9_1_378 - Show latest stable - 0 notes - Class: Ruby

1_8_6_287
1_8_7_72
1_8_7_330
1_9_1_378 (0)
1_9_2_180 (0)
1_9_3_125 (0)
1_9_3_392 (0)
2_1_10 (11)
2_2_9 (0)
2_4_6
2_5_5
2_6_3
What's this?

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

Show source

# File lib/rdoc/parser/ruby.rb, line 2640
  def read_directive(allowed)
    tk = get_tk
    result = nil
    if TkCOMMENT === tk
      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

Flowdock - Team Inbox With Chat