SymbolDatabase.crossReference

Get a link to documentation of symbol specified by word (if word is a symbol).

Searching for a symbol matching to word is done in 3 stages: 1. Assume word starts by a module name (with or without parent packages of the module), look for matching modules, and if any, try to find the symbol there. 2. If 1. didn't find anything, assume word refers to a local symbol (parent scope - siblings of the symbol being documented or current scope - children of that symbol). 3. If 2. didn't find anything, assume word refers to a symbol in any module; search for a symbol with identical full name (but without the module part) in all modules.

class SymbolDatabase
string
crossReference
(
Writer
)
(
Writer writer
,
string[] scopeStack
,
string word
)

Parameters

writer Writer

Writer used to determine links.

scopeStack string[]

Scope of the symbol the documentation of which contains word.

word string

Word to cross-reference.

Return Value

Type: string

link if a matching symbol was found, null otherwise.

Meta