Class RDoc::CodeObject
In: lib/rdoc/code_objects.rb
Parent: Object

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

Methods

attr_overridable   comment=   document_children=   document_self=   new   remove_classes_and_modules   remove_methods_etc   start_doc   stop_doc  

Attributes

comment  [R]  Access the code object‘s comment
document_children  [R]  do we document ourselves and our children
document_self  [R]  do we document ourselves?
done_documenting  [RW]  are we done documenting (ie, did we come across a :enddoc:)?
force_documentation  [RW]  Do we force documentation, even is we wouldn‘t normally show the entity
parent  [RW] 
section  [RW]  Which section are we in
viewer  [RW]  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.

Public Class methods

attr_overridable(name, *aliases)

There‘s a wee trick we pull. Comment blocks can have directives that override the stuff we extract during the parse. So, we have a special class method, attr_overridable, that lets code objects list those directives. Wehn a comment is assigned, we then extract out any matching directives and update our object

Public Instance methods

comment=(comment)

Update the comment, but don‘t overwrite a real comment with an empty one

remove_classes_and_modules()

Default callbacks to nothing, but this is overridden for classes and modules

start_doc()

set and cleared by :startdoc: and :enddoc:, this is used to toggle the capturing of documentation

[Validate]

ruby-doc.org is a service of James Britt and Neurogami, a Ruby application development company in Phoenix, AZ.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.