diff --git a/dokka/main/cpg-analysis/navigation.html b/dokka/main/cpg-analysis/navigation.html index 87717f7f2b..2e9df5baf4 100644 --- a/dokka/main/cpg-analysis/navigation.html +++ b/dokka/main/cpg-analysis/navigation.html @@ -546,6 +546,11 @@ Companion +
This class represents the result of the extractScope operation. It contains a scope object, if a scope was found and the adjustedName that is normalized if any aliases were found during scope extraction.
This function extracts a scope for the Name, e.g. if the name is fully qualified. null
is returned, if no scope can be extracted.
The pair returns the extracted scope and a name that is adjusted by possible import aliases. The extracted scope is "responsible" for the name (e.g. declares the parent namespace) and the returned name only differs from the provided name if aliasing was involved at the node location (e.g. because of imports).
Note: Currently only fully qualified names are properly resolved. This function will probably return imprecise results for partially qualified names, e.g. if a name A
inside B
points to A::B
, rather than to A
.
a pair with the scope of node.name and the alias-adjusted name
the nodes name references a namespace constituted by a scope
the current scope relevant for the name resolution, e.g. parent of node
This function extracts a scope for the Name, e.g. if the name is fully qualified. null
is returned, if no scope can be extracted.
The pair returns the extracted scope and a name that is adjusted by possible import aliases. The extracted scope is "responsible" for the name (e.g. declares the parent namespace) and the returned name only differs from the provided name if aliasing was involved at the node location (e.g. because of imports).
Note: Currently only fully qualified names are properly resolved. This function will probably return imprecise results for partially qualified names, e.g. if a name A
inside B
points to A::B
, rather than to A
.
a pair with the scope of node.name and the alias-adjusted name
the name
the current scope relevant for the name resolution, e.g. parent of node
This function extracts a scope for the Name, e.g. if the name is fully qualified (wrapped in a ScopeExtraction object. null
is returned if a scope was specified, but does not exist as a Scope object.
The returned object contains the extracted scope and a name that is adjusted by possible import aliases. The extracted scope is "responsible" for the name (e.g. declares the parent namespace) and the returned name only differs from the provided name if aliasing was involved at the node location (e.g. because of imports).
Note: Currently only fully qualified names are properly resolved. This function will probably return imprecise results for partially qualified names, e.g. if a name A
inside B
points to A::B
, rather than to A
.
a ScopeExtraction object with the scope of node.name and the alias-adjusted name
the nodes name references a namespace constituted by a scope
the current scope relevant for the name resolution, e.g. parent of node
This function extracts a scope for the Name, e.g. if the name is fully qualified. null
is returned, if no scope can be extracted.
The pair returns the extracted scope and a name that is adjusted by possible import aliases. The extracted scope is "responsible" for the name (e.g. declares the parent namespace) and the returned name only differs from the provided name if aliasing was involved at the node location (e.g. because of imports).
Note: Currently only fully qualified names are properly resolved. This function will probably return imprecise results for partially qualified names, e.g. if a name A
inside B
points to A::B
, rather than to A
.
a pair with the scope of node.name and the alias-adjusted name
the name
the current scope relevant for the name resolution, e.g. parent of node
This class represents the result of the extractScope operation. It contains a scope object, if a scope was found and the adjustedName that is normalized if any aliases were found during scope extraction.
This function extracts a scope for the Name, e.g. if the name is fully qualified. null
is returned, if no scope can be extracted.
This function extracts a scope for the Name, e.g. if the name is fully qualified (wrapped in a ScopeExtraction object. null
is returned if a scope was specified, but does not exist as a Scope object.
This function extracts a scope for the Name, e.g. if the name is fully qualified. null
is returned, if no scope can be extracted.