MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-02-04 23:39:07 +07:00
Code Issues Packages Projects Releases Wiki Activity

[jdk] Use @return tag in kdoc

Browse Source 
IJ-CR-140587

GitOrigin-RevId: 3b8f73569e7afbdbffdf80005da1c5be870d1232
This commit is contained in:
Louis Vignier
2024-07-24 08:53:56 +02:00
committed by intellij-monorepo-bot
parent 89adeb005a
commit 25ad74d2fe
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
java/java-impl/src/com/intellij/openapi/projectRoots/impl/ExternalJavaConfigurationProvider.kt
View File

@@ -19,22 +19,22 @@ interface ExternalJavaConfigurationProvider<T> {
}
/**
* Returns the configuration file supported by this provider.
* @return the configuration file supported by this provider.
*/
fun getConfigurationFile(project: Project): File
/**
* Returns the release data [T] corresponding to the [text] content of the configuration file.
* @return the release data [T] corresponding to the [text] content of the configuration file.
*/
fun getReleaseData(text: String): T?
/**
* Returns true if the release data matches the given SDK.
* @return true if the release data matches the given SDK.
*/
fun matchAgainstSdk(releaseData: T, sdk: Sdk): Boolean
/**
* Returns true if the release data matches the given path.
* @return true if the release data matches the given path.
*/
fun matchAgainstPath(releaseData: T, path: String): Boolean

4
java/java-impl/src/com/intellij/openapi/projectRoots/impl/ExternalJavaConfigurationService.kt
View File

@@ -75,7 +75,7 @@ class ExternalJavaConfigurationService(val project: Project, private val scope:
}
/**
* Parses the configuration file and returns a candidate.
* @return a JDK candidate based on the configuration file.
*/
suspend fun <T> getReleaseData(configProvider: ExternalJavaConfigurationProvider<T>): T? {
val text = readAction {
@@ -87,7 +87,7 @@ class ExternalJavaConfigurationService(val project: Project, private val scope:
}
/**
* Finds a matching JDK candidate for the release data among registered and detected JDKs.
* @return a matching JDK candidate for the release data among registered and detected JDKs.
*/
fun <T> findCandidate(releaseData: T, configProvider: ExternalJavaConfigurationProvider<T>): JdkCandidate<T>? {
val fileName = configProvider.getConfigurationFile(project).name