parse() Instance Public methods Parses the comment into an RDoc::Markup::Document. The parsed document is cached until the text is changed.

remove_private() Instance Public methods Removes private sections from this comment. Private sections are flush to the comment marker and start with -- and end with ++. For C-style comments, a private marker may not start at the opening of the comment. *-- * private *++ * public

text=(text) Instance Public methods Replaces this comment's text with text and resets the parsed document. An error is raised if the comment contains a document but no text.

tomdoc?() Instance Public methods Returns true if this comment is in TomDoc format.

new(name, value, comment) Class Public methods Creates a new constant with name, value and comment

<=>(other) Instance Public methods Constants are ordered by name

==(other) Instance Public methods Constants are equal when their parent and name is the same

documented?() Instance Public methods A constant is documented if it has a comment, or is an alias for a documented class or module.

full_name() Instance Public methods Full constant name including namespace

is_alias_for() Instance Public methods The module or class this constant is an alias for