Class: RDoc::Include

Creates a new Mixin for name with comment

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

Name of included module.

Sets the store for this class or module and its contained code objects.

Our comment.

Replaces our comment with comment, unless it is empty.

Should this CodeObject be displayed in output?

Do we document our children?

Enables or disables documentation of this CodeObject’s children unless it has been turned off by :enddoc:

Do we document ourselves?

Enables or disables documentation of this CodeObject unless it has been turned off by :enddoc:.

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

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

Turns documentation on/off, and turns on/off #document_self and #document_children.

Which file this code object was defined in.

Force documentation of this CodeObject.

Force the documentation of this object unless documentation has been turned off by :enddoc:

Sets the full_name overriding any computed full name.

Has this class been ignored?

Line in #file where this CodeObject was defined.

Hash of arbitrary metadata for this CodeObject.

Our parent CodeObject.

Sets the parent CodeObject.

Did we ever receive a :nodoc: directive?

The section this CodeObject is in.

Set the section this CodeObject is in.

The Store for this object.

Sets the store that contains this CodeObject.

Has this class been suppressed?

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

Mixins are sorted by name.

Full name based on #module

Attempts to locate the included module object.

Alias for Mixin#==.

Yields each parent of this CodeObject.

File name where this CodeObject was found.

Use this to ignore a CodeObject and all its children until found again (#record_location is called).

The options instance from the store this CodeObject is attached to, or a default options instance if the CodeObject is not attached.

File name of our parent.

Name of our parent.

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

Enable capture of documentation unless documentation has been turned off by :enddoc:

Disable capture of documentation.

Use this to suppress a CodeObject and all its children until the next file it is seen in or documentation is discovered.

Initializes state for visibility of this CodeObject and its children.

Generates a relative URL from this object’s path to target_path

Generates a relative URL from from_path to this object’s path.

Build a webcvs URL starting for the given url with full_path appended as the destination path.

Handy wrapper for marking up this object’s comment.

Creates an Markup::ToHtmlCrossref formatter.

Expands tab characters in text to eight spaces.

Flush text left based on the shortest line.

Convert a string in markup format into HTML.

Strips hashes, expands tabs then flushes text to the left.

Normalizes text then builds a Markup::Document from it.

The first limit characters of text as HTML.

Strips leading # characters from text

Strips leading and trailing n characters from text

Strips /* */ style comments.

Converts ampersand, dashes, ellipsis, quotes, copyright and registered trademark symbols in text to properly encoded characters.

Wraps txt to line_len