azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[LL FIR] FirDesignation: update KDoc for collectDesignationWithOptionalFile

Browse Source 
^KT-65344
This commit is contained in:
Dmitrii Gridin
2024-02-13 12:42:55 +01:00
committed by Space Team
parent ca484fae2c
commit ab328e76d4
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
analysis/low-level-api-fir/src/org/jetbrains/kotlin/analysis/low/level/api/fir/api/FirDesignation.kt
+8
View File
@@ -313,6 +313,10 @@ private fun findKotlinStdlibClass(classId: ClassId, target: FirDeclaration): Fir
/** /**
* Consider using this function only if [collectDesignation] is not applicable. * Consider using this function only if [collectDesignation] is not applicable.
* *
* This extension function can be used in the case there your [FirElementWithResolveState] probably
* doesn't have [getContainingFile] and it doesn't matter for your purposes.
* Potentially, this function can become obsolete if we support all possible cases in [getContainingFile]
*
* @return [FirDesignation] where [FirDesignation.fileOrNull] can be null or throws an exception. * @return [FirDesignation] where [FirDesignation.fileOrNull] can be null or throws an exception.
* *
* @see collectDesignation * @see collectDesignation
@@ -339,6 +343,10 @@ fun FirElementWithResolveState.collectDesignation(providedFile: FirFile? = null)
/** /**
* Consider using this function only if [tryCollectDesignation] is not applicable. * Consider using this function only if [tryCollectDesignation] is not applicable.
* *
* This extension function can be used in the case there your [FirElementWithResolveState] probably
* doesn't have [getContainingFile] and it doesn't matter for your purposes.
* Potentially, this function can become obsolete if we support all possible cases in [getContainingFile]
*
* @return [FirDesignation] where [FirDesignation.fileOrNull] can be null or null. * @return [FirDesignation] where [FirDesignation.fileOrNull] can be null or null.
* *
* @see collectDesignationWithOptionalFile * @see collectDesignationWithOptionalFile