Class: RDoc::Include

Inherits:

Mixin

• Object
• CodeObject
• Mixin
• RDoc::Include

Defined in:

lib/rdoc/include.rb

Overview

A Module included in a class with #include

RDoc::Include.new 'Enumerable', 'comment ...'

Constant Summary

Constants included from Text

Text::MARKUP_FORMAT, Text::SPACE_SEPARATED_LETTER_CLASS, Text::TO_HTML_CHARACTERS

Instance Attribute Summary

Attributes inherited from Mixin

#name

Attributes inherited from CodeObject

#comment, #document_children, #document_self, #done_documenting, #file, #force_documentation, #line, #metadata, #parent, #received_nodoc, #section, #store, #viewer

Attributes included from Text

#language

Method Summary

Methods inherited from Mixin

#<=>, #==, #full_name, #hash, #initialize, #inspect, #module, #store=, #to_s

Methods inherited from CodeObject

#display?, #documented?, #each_parent, #file_name, #full_name=, #ignore, #ignored?, #initialize, #initialize_visibility, #options, #parent_file_name, #parent_name, #record_location, #start_doc, #stop_doc, #suppress, #suppressed?

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

This class inherits a constructor from RDoc::Mixin