method

done_documenting=

ruby latest stable - Class: RDoc::CodeObject

done_documenting=(value)

public

Turns documentation on/off, and turns on/off #document_self and #document_children.

Once documentation has been turned off (by :enddoc:), the object will refuse to turn #document_self or #document_children on, so :doc: and :start_doc: directives will have no effect in the current file.

# File lib/rdoc/code_object.rb, line 207
  def done_documenting=(value)
    return unless @track_visibility
    @done_documenting  = value
    @document_self     = !value
    @document_children = @document_self
  end

done_documenting=

Related methods