ri > RDoc::CrossReference

man perldoc info pydoc3 ri search

📝 NAME

RDoc::CrossReference < Object — A reusable way to create cross references for names (from gem rdoc-7.2.0).

🚀 Quick Reference

Use Case	Command	Description
Create a cross‑reference resolver	RDoc::CrossReference.new	Initialize a new resolver instance
Resolve a cross‑reference name	resolve(name)	Resolve a name to a cross‑reference
Resolve a local symbol	resolve_local_symbol(name)	Resolve a symbol within the current context
Access the seen attribute	seen	Return the set of already‑resolved references

📖 DESCRIPTION

RDoc::CrossReference is a reusable way to create cross references for names.

📦 Constants

• ALL_CROSSREF_REGEXP: Version of CROSSREF_REGEXP used when --hyperlink-all is specified.
• CLASS_REGEXP_STR: Regular expression to match class references
  • There can be a '' in front of text to suppress the cross‑reference
  • There can be a '::' in front of class names to reference from the top-level namespace.
  • The method can be followed by parenthesis (not recommended)
• CROSSREF_REGEXP: Regular expressions matching text that should potentially have cross‑reference links generated are passed to add_regexp_handling. Note that these expressions are meant to pick up text for which cross‑references have been suppressed, since the suppression characters are removed by the code that is triggered.
• METHOD_ARGS_REGEXP_STR: Regular expression to match method arguments.
• METHOD_ARG_REGEXP_STR: Regular expression to match a single method argument.
• METHOD_REGEXP_STR: Regular expression to match method references. See CLASS_REGEXP_STR

🔧 Class Methods

• new — Initialize a new cross‑reference resolver.

🔧 Instance Methods

• resolve — Resolve a cross‑reference name.
• resolve_local_symbol — Resolve a local symbol.
• seen — Access the seen attribute.

📦 Attributes

• seen (attr_accessor) — Accessor for the seen attribute.

📝 NAME 🚀 Quick Reference 📖 DESCRIPTION 📦 Constants 🔧 Class Methods 🔧 Instance Methods 📦 Attributes