Class: RDoc::CodeObject

Inherits:

Object

• Object
• RDoc::CodeObject

show all

Includes:

Text

Defined in:

lib/rdoc/code_object.rb

Overview

Constant Summary

Constant Summary

Constants included from Text

Text::TO_HTML_CHARACTERS

Instance Attribute Summary (collapse)

• - (Object) comment

  Our comment.

• - (Object) document_children

  Do we document our children?.

• - (Object) document_self

  Do we document ourselves?.

• - (Object) done_documenting

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

• - (Object) file readonly

  Which file this code object was defined in.

• - (Object) force_documentation

  Force documentation of this CodeObject.

• - (Object) line

  Line in #file where this CodeObject was defined.

• - (Object) metadata readonly

  Hash of arbitrary metadata for this CodeObject.

• - (Object) offset

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

• - (Object) parent

  Our parent CodeObject.

• - (Object) received_nodoc readonly

  Did we ever receive a :nodoc: directive?.

• - (Object) section

  Which section are we in.

• - (Object) viewer

  We are the model of the code, but we know that at some point we will be worked on by viewers.

Instance Method Summary (collapse)

• - (Boolean) documented?

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

• - (Object) full_name=(full_name)

  Sets the full_name overriding any computed full name.

• - (CodeObject) initialize constructor

  Creates a new CodeObject that will document itself and its children.

• - (Object) parent_file_name

  File name of our parent.

• - (Object) parent_name

  Name of our parent.

• - (Object) record_location(top_level)

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

• - (Object) start_doc

  Enable capture of documentation unless documentation has been turned off by :endoc:.

• - (Object) stop_doc

  Disable capture of documentation.

Methods included from Text

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

105
106
107
108
109
110
111
112
113
114
115
116
117

# File 'lib/rdoc/code_object.rb', line 105

def initialize
  @metadata  = {}
  @comment   = ''
  @parent    = nil
  @file      = nil
  @full_name = nil

  @document_children   = true
  @document_self       = true
  @done_documenting    = false
  @force_documentation = false
  @received_nodoc      = false
end

36
37
38

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

def comment
  @comment
end

41
42
43

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

def document_children
  @document_children
end

46
47
48

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

def document_self
  @document_self
end

51
52
53

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

def done_documenting
  @done_documenting
end

56
57
58

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

def file
  @file
end

61
62
63

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

def force_documentation
  @force_documentation
end

66
67
68

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

def line
  @line
end

71
72
73

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

def metadata
  @metadata
end

78
79
80

# File 'lib/rdoc/code_object.rb', line 78

def offset
  @offset
end

83
84
85

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

def parent
  @parent
end

88
89
90

# File 'lib/rdoc/code_object.rb', line 88

def received_nodoc
  @received_nodoc
end

93
94
95

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

def section
  @section
end

100
101
102

# File 'lib/rdoc/code_object.rb', line 100

def viewer
  @viewer
end

164
165
166

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

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

198
199
200

# File 'lib/rdoc/code_object.rb', line 198

def full_name= full_name
  @full_name = full_name
end

205
206
207

# File 'lib/rdoc/code_object.rb', line 205

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

212
213
214

# File 'lib/rdoc/code_object.rb', line 212

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

219
220
221

# File 'lib/rdoc/code_object.rb', line 219

def record_location top_level
  @file = top_level
end

227
228
229
230
231
232

# File 'lib/rdoc/code_object.rb', line 227

def start_doc
  return if @done_documenting

  @document_self = true
  @document_children = true
end

237
238
239
240

# File 'lib/rdoc/code_object.rb', line 237

def stop_doc
  @document_self = false
  @document_children = false
end