Add comment

Kotlin · Feb 28, 2023 · 4b87328 · 4b87328
1 parent 80120f2
commit 4b87328
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/core/src/main/kotlin/model/DisplaySourceSet.kt b/core/src/main/kotlin/model/DisplaySourceSet.kt
@@ -5,6 +5,14 @@ import org.jetbrains.dokka.DokkaSourceSetID
 import org.jetbrains.dokka.Platform
 import org.jetbrains.dokka.utilities.SelfRepresentingSingletonSet
 
+/**
+ * TODO: fix the example (symmetric equivalence relation with [Set]):
+ * ```
+ * val ds = DokkaSourceSetImpl(sourceSetID = DokkaSourceSetID("", "")).toDisplaySourceSet()
+ * println(setOf(ds) == ds) // true
+ * println(ds == setOf(ds)) // false
+ * ```
+ */
 data class DisplaySourceSet(
     val sourceSetIDs: CompositeSourceSetID,
     val name: String,

diff --git a/plugins/base/src/main/kotlin/resolvers/local/DokkaLocationProvider.kt b/plugins/base/src/main/kotlin/resolvers/local/DokkaLocationProvider.kt
@@ -96,6 +96,7 @@ open class DokkaLocationProvider(
                     .mapNotNull { ssid ->
                         dokkaContext.configuration.sourceSets.find { it.sourceSetID == ssid }?.toDisplaySourceSet()
                     }.map {
+                        // be careful `data DisplaySourceSet: Set<DisplaySourceSet>` but `setOf(someDisplaySourceSet) != someDisplaySourceSet`
                         setOf(it)
                     }
             }