Class: RDoc::CodeObject

Inherits:
Object
  • Object
show all
Includes:
Generator::Markup, Text
Defined in:
lib/rdoc/code_object.rb,
lib/rdoc/generator/markup.rb

Overview

Base class for the RDoc code tree.

We contain the common stuff for contexts (which are containers) and other elements (methods, attributes and so on)

Here’s the tree of the CodeObject subclasses:

  • RDoc::Context

    • RDoc::TopLevel

    • RDoc::ClassModule

      • RDoc::AnonClass (never used so far)

      • RDoc::NormalClass

      • RDoc::NormalModule

      • RDoc::SingleClass

  • RDoc::MethodAttr

    • RDoc::Attr

    • RDoc::AnyMethod

      • RDoc::GhostMethod

      • RDoc::MetaMethod

  • RDoc::Alias

  • RDoc::Constant

  • RDoc::Require

  • RDoc::Mixin

    • RDoc::Include

    • RDoc::Extend

Direct Known Subclasses

Alias, Constant, Context, MethodAttr, Mixin, Require

Constant Summary

Constants included from Text

Text::MARKUP_FORMAT, Text::SPACE_SEPARATED_LETTER_CLASS, Text::TO_HTML_CHARACTERS

Instance Attribute Summary collapse

Attributes included from Text

#language

Instance Method Summary collapse

Methods included from Generator::Markup

#aref_to, #as_href, #canonical_url, #cvs_url, #description, #formatter

Methods included from Text

encode_fallback, #expand_tabs, #flush_left, #markup, #normalize_comment, #parse, #snippet, #strip_hashes, #strip_newlines, #strip_stars, #to_html, #wrap

Constructor Details

#initialize ⇒ CodeObject

Creates a new CodeObject that will document itself and its children



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/rdoc/code_object.rb', line 101

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

Instance Attribute Details

#comment ⇒ Object

Our comment



36
37
38
 
# File 'lib/rdoc/code_object.rb', line 36

def comment
  @comment
end

#document_children ⇒ Object

Do we document our children?



41
42
43
 
# File 'lib/rdoc/code_object.rb', line 41

def document_children
  @document_children
end

#document_self ⇒ Object

Do we document ourselves?



46
47
48
 
# File 'lib/rdoc/code_object.rb', line 46

def document_self
  @document_self
end

#done_documenting ⇒ Object

Are we done documenting (ie, did we come across a :enddoc:)?



51
52
53
 
# File 'lib/rdoc/code_object.rb', line 51

def done_documenting
  @done_documenting
end

#file ⇒ Object (readonly)

Which file this code object was defined in



56
57
58
 
# File 'lib/rdoc/code_object.rb', line 56

def file
  @file
end

#force_documentation ⇒ Object

Force documentation of this CodeObject



61
62
63
 
# File 'lib/rdoc/code_object.rb', line 61

def force_documentation
  @force_documentation
end

#line ⇒ Object

Line in #file where this CodeObject was defined



66
67
68
 
# File 'lib/rdoc/code_object.rb', line 66

def line
  @line
end

#metadata ⇒ Object (readonly)

Hash of arbitrary metadata for this CodeObject



71
72
73
 
# File 'lib/rdoc/code_object.rb', line 71

def metadata
  @metadata
end

#mixin_from ⇒ Object

When mixed-in to a class, this points to the Context in which it was originally defined.



96
97
98
 
# File 'lib/rdoc/code_object.rb', line 96

def mixin_from
  @mixin_from
end

#parent ⇒ Object

Our parent CodeObject. The parent may be missing for classes loaded from legacy RI data stores.



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/rdoc/code_object.rb', line 290

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

#received_nodoc ⇒ Object (readonly)

Did we ever receive a :nodoc: directive?



81
82
83
 
# File 'lib/rdoc/code_object.rb', line 81

def received_nodoc
  @received_nodoc
end

#section ⇒ Object

The section this CodeObject is in. Sections allow grouping of constants, attributes and methods inside a class or module.



329
330
331
332
333
 
# File 'lib/rdoc/code_object.rb', line 329

def section
  return @section if @section

  @section = parent.add_section @section_title if parent
end

#store ⇒ Object

The RDoc::Store for this object.



91
92
93
 
# File 'lib/rdoc/code_object.rb', line 91

def store
  @store
end

Instance Method Details

#display? ⇒ Boolean

Should this CodeObject be displayed in output?

A code object should be displayed if:

  • The item didn’t have a nodoc or wasn’t in a container that had nodoc

  • The item wasn’t ignored

  • The item has documentation and was not suppressed

Returns:

  • (Boolean) 


162
163
164
165
 
# File 'lib/rdoc/code_object.rb', line 162

def display?
  @document_self and not @ignored and
    (documented? or not @suppressed)
end

#documented? ⇒ Boolean

Does this object have a comment with content or is #received_nodoc true?

Returns:

  • (Boolean) 


193
194
195
 
# File 'lib/rdoc/code_object.rb', line 193

def documented?
  @received_nodoc or !@comment.empty?
end

#file_name ⇒ Object

File name where this CodeObject was found.

See also RDoc::Context#in_files



218
219
220
221
222
 
# File 'lib/rdoc/code_object.rb', line 218

def file_name
  return unless @file

  @file.absolute_name
end

#full_name=(full_name) ⇒ Object

Sets the full_name overriding any computed full name.

Set to nil to clear RDoc’s cached value



239
240
241
 
# File 'lib/rdoc/code_object.rb', line 239

def full_name=(full_name)
  @full_name = full_name
end

#ignore ⇒ Object

Use this to ignore a CodeObject and all its children until found again (#record_location is called). An ignored item will not be displayed in documentation.

See github issue #55

The ignored status is temporary in order to allow implementation details to be hidden. At the end of processing a file RDoc allows all classes and modules to add new documentation to previously created classes.

If a class was ignored (via stopdoc) then reopened later with additional documentation it should be displayed. If a class was ignored and never reopened it should not be displayed. The ignore flag allows this to occur.



259
260
261
262
263
264
265
 
# File 'lib/rdoc/code_object.rb', line 259

def ignore
  return unless @track_visibility

  @ignored = true

  stop_doc
end

#ignored? ⇒ Boolean

Has this class been ignored?

See also #ignore

Returns:

  • (Boolean) 


272
273
274
 
# File 'lib/rdoc/code_object.rb', line 272

def ignored?
  @ignored
end

#initialize_visibility ⇒ Object

Initializes state for visibility of this CodeObject and its children.



121
122
123
124
125
126
127
128
129
130
 
# File 'lib/rdoc/code_object.rb', line 121

def initialize_visibility # :nodoc:
  @document_children   = true
  @document_self       = true
  @done_documenting    = false
  @force_documentation = false
  @received_nodoc      = false
  @ignored             = false
  @suppressed          = false
  @track_visibility    = true
end

#options ⇒ Object

The options instance from the store this CodeObject is attached to, or a default options instance if the CodeObject is not attached.

This is used by Text#snippet



282
283
284
 
# File 'lib/rdoc/code_object.rb', line 282

def options
  @store&.options || RDoc::Options.new
end

#parent_name ⇒ Object

Name of our parent



312
313
314
 
# File 'lib/rdoc/code_object.rb', line 312

def parent_name
  @parent ? @parent.full_name : '(unknown)'
end

#record_location(top_level) ⇒ Object

Records the RDoc::TopLevel (file) where this code object was defined



319
320
321
322
323
 
# File 'lib/rdoc/code_object.rb', line 319

def record_location(top_level)
  @ignored    = false
  @suppressed = false
  @file       = top_level
end

#start_doc ⇒ Object

Enable capture of documentation unless documentation has been turned off by :enddoc:



339
340
341
342
343
344
345
346
 
# File 'lib/rdoc/code_object.rb', line 339

def start_doc
  return if @done_documenting

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

#stop_doc ⇒ Object

Disable capture of documentation



351
352
353
354
355
356
 
# File 'lib/rdoc/code_object.rb', line 351

def stop_doc
  return unless @track_visibility

  @document_self = false
  @document_children = false
end

#suppress ⇒ Object

Use this to suppress a CodeObject and all its children until the next file it is seen in or documentation is discovered. A suppressed item with documentation will be displayed while an ignored item with documentation may not be displayed.



378
379
380
381
382
383
384
 
# File 'lib/rdoc/code_object.rb', line 378

def suppress
  return unless @track_visibility

  @suppressed = true

  stop_doc
end

#suppressed? ⇒ Boolean

Has this class been suppressed?

See also #suppress

Returns:

  • (Boolean) 


391
392
393
 
# File 'lib/rdoc/code_object.rb', line 391

def suppressed?
  @suppressed
end