method

read_documentation_modifiers

Importance_0
v1_8_7_72 - Show latest stable - 0 notes - Class: RDoc::RubyParser
read_documentation_modifiers(context, allow) private

No documentation

This method has no description. You can help the Ruby community by adding new notes.

Hide source 
# File lib/rdoc/parsers/parse_rb.rb, line 2272
    def read_documentation_modifiers(context, allow)
      dir = read_directive(allow)

      case dir[0]

      when "notnew", "not_new", "not-new"
        context.dont_rename_initialize = true

      when "nodoc"
        context.document_self = false
        if dir[1].downcase == "all"
          context.document_children = false
        end

      when "doc"
        context.document_self = true
        context.force_documentation = true

      when "yield", "yields"
        unless context.params.nil?
          context.params.sub!(/(,|)\s*&\w+/,'') # remove parameter &proc
        end
        context.block_params = dir[1]

      when "arg", "args"
        context.params = dir[1]
      end if dir
    end
Register or log in to add new notes.