method
read_documentation_modifiers
v1_9_1_378 -
Show latest stable
- Class:
RDoc::Parser::Ruby
read_documentation_modifiers(context, allow)public
No documentation available.
# File lib/rdoc/parser/ruby.rb, line 2656
def read_documentation_modifiers(context, allow)
dir = read_directive(allow)
case dir[0]
when "notnew", "not_new", "not-new" then
context.dont_rename_initialize = true
when "nodoc" then
context.document_self = false
if dir[1].downcase == "all"
context.document_children = false
end
when "doc" then
context.document_self = true
context.force_documentation = true
when "yield", "yields" then
unless context.params.nil?
context.params.sub!(/(,|)\s*&\w+/,'') # remove parameter &proc
end
context.block_params = dir[1]
when "arg", "args" then
context.params = dir[1]
end if dir
end