aboutsummaryrefslogtreecommitdiff
path: root/core/src/main/kotlin/model/DisplaySourceSet.kt
diff options
context:
space:
mode:
Diffstat (limited to 'core/src/main/kotlin/model/DisplaySourceSet.kt')
-rw-r--r--core/src/main/kotlin/model/DisplaySourceSet.kt8
1 files changed, 8 insertions, 0 deletions
diff --git a/core/src/main/kotlin/model/DisplaySourceSet.kt b/core/src/main/kotlin/model/DisplaySourceSet.kt
index 85904db6..5ea1ba3d 100644
--- 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 (asymmetric 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,