class RDoc::CodeObject

# File lib/rdoc/code_object.rb, line 107
def initialize
  @metadata         = {}
  @comment          = ''
  @parent           = nil
  @parent_name      = nil # for loading
  @parent_class     = nil # for loading
  @section          = nil
  @section_title    = nil # for loading
  @file             = nil
  @full_name        = nil
  @store            = nil
  @track_visibility = true
  @mixin_from       = nil

  initialize_visibility
end

# File lib/rdoc/code_object.rb, line 141
def comment=(comment)
  @comment = case comment
             when NilClass               then ''
             when RDoc::Markup::Document then comment
             when RDoc::Comment          then comment.normalize
             else
               if comment and not comment.empty? then
                 normalize_comment comment
               else
                 # HACK correct fix is to have #initialize create @comment
                 #      with the correct encoding
                 if String === @comment and @comment.empty? then
                   @comment = RDoc::Encoding.change_encoding @comment, comment.encoding
                 end
                 @comment
               end
             end
end

# File lib/rdoc/code_object.rb, line 169
def display?
  @document_self and not @ignored and
    (documented? or not @suppressed)
end

# File lib/rdoc/code_object.rb, line 178
def document_children=(document_children)
  return unless @track_visibility

  @document_children = document_children unless @done_documenting
end

# File lib/rdoc/code_object.rb, line 189
def document_self=(document_self)
  return unless @track_visibility
  return if @done_documenting

  @document_self = document_self
  @received_nodoc = true if document_self.nil?
end

# File lib/rdoc/code_object.rb, line 200
def documented?
  @received_nodoc or !@comment.empty?
end

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

# File lib/rdoc/code_object.rb, line 224
def each_parent
  code_object = self

  while code_object = code_object.parent do
    yield code_object
  end

  self
end

# File lib/rdoc/code_object.rb, line 239
def file_name
  return unless @file

  @file.absolute_name
end

# File lib/rdoc/code_object.rb, line 251
def force_documentation=(value)
  @force_documentation = value unless @done_documenting
end

# File lib/rdoc/code_object.rb, line 260
def full_name= full_name
  @full_name = full_name
end

# File lib/rdoc/code_object.rb, line 280
def ignore
  return unless @track_visibility

  @ignored = true

  stop_doc
end

# File lib/rdoc/code_object.rb, line 293
def ignored?
  @ignored
end

# File lib/rdoc/code_object.rb, line 303
def options
  if @store and @store.rdoc then
    @store.rdoc.options
  else
    RDoc::Options.new
  end
end

# File lib/rdoc/code_object.rb, line 315
def parent
  return @parent if @parent
  return nil unless @parent_name

  if @parent_class == RDoc::TopLevel then
    @parent = @store.add_file @parent_name
  else
    @parent = @store.find_class_or_module @parent_name

    return @parent if @parent

    begin
      @parent = @store.load_class @parent_name
    rescue RDoc::Store::MissingFileError
      nil
    end
  end
end

# File lib/rdoc/code_object.rb, line 337
def parent_file_name
  @parent ? @parent.base_name : '(unknown)'
end

# File lib/rdoc/code_object.rb, line 344
def parent_name
  @parent ? @parent.full_name : '(unknown)'
end

# File lib/rdoc/code_object.rb, line 351
def record_location top_level
  @ignored    = false
  @suppressed = false
  @file       = top_level
end

# File lib/rdoc/code_object.rb, line 361
def section
  return @section if @section

  @section = parent.add_section @section_title if parent
end

# File lib/rdoc/code_object.rb, line 371
def start_doc
  return if @done_documenting

  @document_self = true
  @document_children = true
  @ignored    = false
  @suppressed = false
end

# File lib/rdoc/code_object.rb, line 383
def stop_doc
  return unless @track_visibility

  @document_self = false
  @document_children = false
end

# File lib/rdoc/code_object.rb, line 393
def store= store
  @store = store

  return unless @track_visibility

  if :nodoc == options.visibility then
    initialize_visibility
    @track_visibility = false
  end
end

# File lib/rdoc/code_object.rb, line 410
def suppress
  return unless @track_visibility

  @suppressed = true

  stop_doc
end

# File lib/rdoc/code_object.rb, line 423
def suppressed?
  @suppressed
end