Class: Chiridion::Engine::DocumentModel::MethodDoc
- Inherits:
-
Data
- Object
- Data
- Chiridion::Engine::DocumentModel::MethodDoc
- Defined in:
- lib/chiridion/engine/document_model.rb
Overview
Method documentation - comprehensive capture of all method info.
Instance Attribute Summary collapse
-
#abstract ⇒ Object
readonly
Returns the value of attribute abstract.
-
#api ⇒ Object
readonly
Returns the value of attribute api.
-
#attr_type ⇒ Object
readonly
Returns the value of attribute attr_type.
-
#deprecated ⇒ Object
readonly
Returns the value of attribute deprecated.
-
#docstring ⇒ Object
readonly
Returns the value of attribute docstring.
-
#examples ⇒ Object
readonly
Returns the value of attribute examples.
-
#file ⇒ Object
readonly
Returns the value of attribute file.
-
#line ⇒ Object
readonly
Returns the value of attribute line.
-
#name ⇒ Object
readonly
Returns the value of attribute name.
-
#notes ⇒ Object
readonly
Returns the value of attribute notes.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
-
#overloads ⇒ Object
readonly
Returns the value of attribute overloads.
-
#params ⇒ Object
readonly
Returns the value of attribute params.
-
#raises ⇒ Object
readonly
Returns the value of attribute raises.
-
#rbs_signature ⇒ Object
readonly
Returns the value of attribute rbs_signature.
-
#returns ⇒ Object
readonly
Returns the value of attribute returns.
-
#scope ⇒ Object
readonly
Returns the value of attribute scope.
-
#see_also ⇒ Object
readonly
Returns the value of attribute see_also.
-
#signature ⇒ Object
readonly
Returns the value of attribute signature.
-
#since ⇒ Object
readonly
Returns the value of attribute since.
-
#source ⇒ Object
readonly
Returns the value of attribute source.
-
#source_body_lines ⇒ Object
readonly
Returns the value of attribute source_body_lines.
-
#spec_behaviors ⇒ Object
readonly
Returns the value of attribute spec_behaviors.
-
#spec_examples ⇒ Object
readonly
Returns the value of attribute spec_examples.
-
#todo ⇒ Object
readonly
Returns the value of attribute todo.
-
#visibility ⇒ Object
readonly
Returns the value of attribute visibility.
-
#yields ⇒ Object
readonly
Returns the value of attribute yields.
Instance Attribute Details
#abstract ⇒ Object (readonly)
Returns the value of attribute abstract
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def abstract @abstract end |
#api ⇒ Object (readonly)
Returns the value of attribute api
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def api @api end |
#attr_type ⇒ Object (readonly)
Returns the value of attribute attr_type
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def attr_type @attr_type end |
#deprecated ⇒ Object (readonly)
Returns the value of attribute deprecated
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def deprecated @deprecated end |
#docstring ⇒ Object (readonly)
Returns the value of attribute docstring
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def docstring @docstring end |
#examples ⇒ Object (readonly)
Returns the value of attribute examples
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def examples @examples end |
#file ⇒ Object (readonly)
Returns the value of attribute file
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def file @file end |
#line ⇒ Object (readonly)
Returns the value of attribute line
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def line @line end |
#name ⇒ Object (readonly)
Returns the value of attribute name
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def name @name end |
#notes ⇒ Object (readonly)
Returns the value of attribute notes
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def notes @notes end |
#options ⇒ Object (readonly)
Returns the value of attribute options
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def @options end |
#overloads ⇒ Object (readonly)
Returns the value of attribute overloads
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def overloads @overloads end |
#params ⇒ Object (readonly)
Returns the value of attribute params
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def params @params end |
#raises ⇒ Object (readonly)
Returns the value of attribute raises
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def raises @raises end |
#rbs_signature ⇒ Object (readonly)
Returns the value of attribute rbs_signature
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def rbs_signature @rbs_signature end |
#returns ⇒ Object (readonly)
Returns the value of attribute returns
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def returns @returns end |
#scope ⇒ Object (readonly)
Returns the value of attribute scope
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def scope @scope end |
#see_also ⇒ Object (readonly)
Returns the value of attribute see_also
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def see_also @see_also end |
#signature ⇒ Object (readonly)
Returns the value of attribute signature
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def signature @signature end |
#since ⇒ Object (readonly)
Returns the value of attribute since
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def since @since end |
#source ⇒ Object (readonly)
Returns the value of attribute source
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def source @source end |
#source_body_lines ⇒ Object (readonly)
Returns the value of attribute source_body_lines
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def source_body_lines @source_body_lines end |
#spec_behaviors ⇒ Object (readonly)
Returns the value of attribute spec_behaviors
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def spec_behaviors @spec_behaviors end |
#spec_examples ⇒ Object (readonly)
Returns the value of attribute spec_examples
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def spec_examples @spec_examples end |
#todo ⇒ Object (readonly)
Returns the value of attribute todo
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def todo @todo end |
#visibility ⇒ Object (readonly)
Returns the value of attribute visibility
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def visibility @visibility end |
#yields ⇒ Object (readonly)
Returns the value of attribute yields
132 133 134 |
# File 'lib/chiridion/engine/document_model.rb', line 132 def yields @yields end |