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::Include

Direct Known Subclasses

Alias, Constant, Context, Extend, Include, MethodAttr, Require

Constant Summary

Constants included from Text

Text::MARKUP_FORMAT, Text::TO_HTML_CHARACTERS

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Generator::Markup

#aref_to, #as_href, #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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# 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

  initialize_visibility
end

Instance Attribute Details

#comment ⇒ Object

Our comment



33
34
35
 
# File 'lib/rdoc/code_object.rb', line 33

def comment
  @comment
end

#document_children ⇒ Object

Do we document our children?



38
39
40
 
# File 'lib/rdoc/code_object.rb', line 38

def document_children
  @document_children
end

#document_self ⇒ Object

Do we document ourselves?



43
44
45
 
# File 'lib/rdoc/code_object.rb', line 43

def document_self
  @document_self
end

#done_documenting ⇒ Object

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



48
49
50
 
# File 'lib/rdoc/code_object.rb', line 48

def done_documenting
  @done_documenting
end

#file ⇒ Object (readonly)

Which file this code object was defined in



53
54
55
 
# File 'lib/rdoc/code_object.rb', line 53

def file
  @file
end

#force_documentation ⇒ Object

Force documentation of this CodeObject



58
59
60
 
# File 'lib/rdoc/code_object.rb', line 58

def force_documentation
  @force_documentation
end

#line ⇒ Object

Line in #file where this CodeObject was defined



63
64
65
 
# File 'lib/rdoc/code_object.rb', line 63

def line
  @line
end

#metadata ⇒ Object (readonly)

Hash of arbitrary metadata for this CodeObject



68
69
70
 
# File 'lib/rdoc/code_object.rb', line 68

def metadata
  @metadata
end

#offset ⇒ Object

Offset in #file where this CodeObject was defined – TODO character or byte?



75
76
77
 
# File 'lib/rdoc/code_object.rb', line 75

def offset
  @offset
end

#parent ⇒ Object

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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/rdoc/code_object.rb', line 282

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?



85
86
87
 
# File 'lib/rdoc/code_object.rb', line 85

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.



327
328
329
330
331
 
# File 'lib/rdoc/code_object.rb', line 327

def section
  return @section if @section

  @section = parent.add_section @section_title if parent
end

#store ⇒ Object

The RDoc::Store for this object.



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

def store
  @store
end

#viewer ⇒ Object

We are the model of the code, but we know that at some point we will be worked on by viewers. By implementing the Viewable protocol, viewers can associated themselves with these objects.



102
103
104
 
# File 'lib/rdoc/code_object.rb', line 102

def viewer
  @viewer
end

Instance Method Details

#display? ⇒ Boolean

Should this CodeObject be shown in documentation?

Returns:

  • (Boolean) 


160
161
162
 
# File 'lib/rdoc/code_object.rb', line 160

def display?
  @document_self and not @ignored
end

#documented? ⇒ Boolean

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

Returns:

  • (Boolean) 


187
188
189
 
# File 'lib/rdoc/code_object.rb', line 187

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

#each_parent ⇒ Object

Yields each parent of this CodeObject. See also RDoc::ClassModule#each_ancestor



210
211
212
213
214
215
216
217
218
 
# File 'lib/rdoc/code_object.rb', line 210

def each_parent
  code_object = self

  while code_object = code_object.parent do
    yield code_object
  end

  self
end

#file_name ⇒ Object

File name where this CodeObject was found.

See also RDoc::Context#in_files



225
226
227
228
229
 
# File 'lib/rdoc/code_object.rb', line 225

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



246
247
248
 
# File 'lib/rdoc/code_object.rb', line 246

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 shown 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 shown. If a class was ignored and never reopened it should not be shown. The ignore flag allows this to occur.



265
266
267
268
269
 
# File 'lib/rdoc/code_object.rb', line 265

def ignore
  @ignored = true

  stop_doc
end

#ignored? ⇒ Boolean

Has this class been ignored?

Returns:

  • (Boolean) 


274
275
276
 
# File 'lib/rdoc/code_object.rb', line 274

def ignored?
  @ignored
end

#initialize_visibility ⇒ Object

Initializes state for visibility of this CodeObject and its children.



125
126
127
128
129
130
131
132
 
# File 'lib/rdoc/code_object.rb', line 125

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

#parent_file_name ⇒ Object

File name of our parent



304
305
306
 
# File 'lib/rdoc/code_object.rb', line 304

def parent_file_name
  @parent ? @parent.base_name : '(unknown)'
end

#parent_name ⇒ Object

Name of our parent



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

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



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

def record_location top_level
  @ignored = false
  @file = top_level
end

#start_doc ⇒ Object

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



337
338
339
340
341
342
343
 
# File 'lib/rdoc/code_object.rb', line 337

def start_doc
  return if @done_documenting

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

#stop_doc ⇒ Object

Disable capture of documentation



348
349
350
351
 
# File 'lib/rdoc/code_object.rb', line 348

def stop_doc
  @document_self = false
  @document_children = false
end