Class: RDoc::MetaMethod

Creates a new AnyMethod with a token stream text and name

Creates a new MethodAttr from token stream text and method or attribute name name.

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

The C function that implements this method (if it was defined in a C file).

Different ways to call this method.

Sets the different ways you can call this method.

If true this method uses super to call a superclass version.

Don’t rename #initialize to ::new.

Whether the method has a call-seq.

Parameters for this method.

The section title of the method (if defined in a C file via :category:).

Whether to skip the method description, true for methods that have aliases with a call-seq that doesn’t include the method name.

Sets the store for this method and its referenced code objects.

Array of other names for this method/attribute.

The call_seq or the param_seq with method name, if there is no call_seq.

Parameters yielded by the called block.

Attempts to sanitize the content passed by the Ruby parser: remove outer parentheses, etc.

Different ways to call this method.

A method/attribute is documented if any of the following is true: - it was marked with :nodoc:; - it has a comment; - it is an alias for a documented method; - it has a #see method that is documented.

The method/attribute we’re aliasing.

Name of this method/attribute.

Pretty parameter list for this method.

Parameters for this method.

Is this a singleton method/attribute?

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

Source file token stream.

public, protected, private.

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.

When mixed-in to a class, this points to the Context in which it was originally defined.

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.

The language for this text.

Adds an_alias as an alias for this method in context.

Prefix for aref is ‘method’.

The call_seq or the param_seq with method name, if there is no call_seq.

Dumps this AnyMethod for use by ri.

Loads this AnyMethod from array.

Method name.

A list of this method’s method and yield parameters.

Pretty parameter list for this method.

For methods that super, find the superclass method that would be called.

call_seq without deduplication and alias lookup.

call_seq with alias examples information removed, if this method is an alias method.

Loads is_alias_for from the internal name.

Adds one token to the collected tokens.

Adds tokens to the collected tokens.

Starts collecting tokens.

Remove the last token from the collected tokens.

Alias for TokenStream#collect_tokens.

Current token stream.

Returns a string representation of the token stream.

Order by #singleton then #name

Abstract method.

Prepend src with line numbers.

HTML fragment reference for this method.

Prefix for aref, defined by subclasses.

Full method/attribute name including namespace.

HTML id-friendly method/attribute name.

Turns the method’s token stream into HTML.

‘::’ for a class method/attribute, ‘#’ for an instance method.

Name for output to HTML.

Name of our parent with special handling for un-marshaled methods.

Path to this method for use with HTML generator output.

Method/attribute name with class/instance indicator.

Used by Generator::JsonIndex to create a record for the search engine.

A method/attribute to look at, in particular if this method/attribute has no documentation.

Type of method/attribute (class or instance).

Resets cached data for the object so it can be rebuilt by accessor methods.

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