Class RDoc::CodeObject
In: lib/rdoc/code_objects.rb
Parent: Object
CodeObject Include Context Alias Attr AnyMethod Constant Require ClassModule NormalModule SingleClass AnonClass NormalClass TopLevel RubyParser RubyToken RuntimeError Error Error AttributeFormatter AnsiFormatter OverstrikeFormatter HtmlFormatter DefaultDisplay NamedThing IncludedModule Attribute Constant MethodSummary AliasName ClassEntry TopLevelEntry Description MethodDescription ModuleDescription ClassDescription Formatter SimpleFormatter HTML HTMLInOne XML CHM Context Method Class File Element Edge Node Subgraph Digraph SimpleElement Port Options Diagram Fortran95parser RDoc SimpleParser Token Markup TemplatePage Stats C_Parser NameDescriptor Cache Reader Writer Driver MethodEntry RI AllReferences Display Paths RI MarkUp Generator TokenStream ParserFactory DOT RDoc dot/f_4.png

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  

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]