Refactor and document DisplaySourceSet, deprecate SelfRepresentingSingletonSet (#3105)

* Deprecate internal API SelfRepresentingSingletonSet for removal as being harmful and unimplement it in DisplaySourceSet
* Provide no automatic migration for DisplaySourceSet, as there are no mechanisms for that. Manual migration is the replacement of 'dss' to `setOf(dss)` where applicable
* Introduce a convenience-member DefaultRenderer.buildContentNode to avoid wrapping DSS into set manually
* Document DisplaySourceSet
* Replace Iterable<DisplaySourceSet>.sourceSetIDs with more straightforward Iterable<DisplaySourceSet>.computeSourceSetIds(), refactor all the usages, save some allocations
* Start caching CompositeSourceSetID properties to avoid excessive allocations
* Update integration tests on the latest revision with Knit version where the workaround is applied

Fixes #2897

1 files changed, 0 insertions, 60 deletions

diff --git a/core/src/test/kotlin/utilities/SelfRepresentingSingletonSetTest.kt b/core/src/test/kotlin/utilities/SelfRepresentingSingletonSetTest.kt
deleted file mode 100644
index bef43565..00000000
--- a/core/src/test/kotlin/utilities/SelfRepresentingSingletonSetTest.kt
+++ /dev/null
@@ -1,60 +0,0 @@
-package utilities
-
-import org.jetbrains.dokka.utilities.SelfRepresentingSingletonSet
-import kotlin.test.Test
-import kotlin.test.assertEquals
-import kotlin.test.assertFalse
-import kotlin.test.assertTrue
-
-class SelfRepresentingSingletonSetTest {
-
-    data class TestModel(val index: Int = 0) : SelfRepresentingSingletonSet<TestModel>
-
-    @Test
-    fun size() {
-        assertEquals(1, TestModel().size)
-    }
-
-    @Test
-    fun contains() {
-        val m0 = TestModel(0)
-        val m1 = TestModel(1)
-
-        assertFalse(m1 in m0)
-        assertFalse(m0 in m1)
-        assertTrue(m0 in m0)
-        assertTrue(m1 in m1)
-        assertTrue(TestModel(0) in m0)
-    }
-
-    @Test
-    fun `containsAll is compliant to setOf`() {
-        val setOf = setOf(TestModel())
-        val testModel = TestModel()
-
-        assertEquals(
-            setOf.containsAll(emptyList()), testModel.containsAll(emptyList())
-        )
-
-        assertEquals(
-            setOf.containsAll(listOf(TestModel())), testModel.containsAll(listOf(TestModel()))
-        )
-
-        assertEquals(
-            setOf.containsAll(listOf(TestModel(0), TestModel(1))),
-            testModel.containsAll(listOf(TestModel(0), TestModel(1)))
-        )
-    }
-
-    @Test
-    fun isEmpty() {
-        assertFalse(TestModel().isEmpty())
-    }
-
-    @Test
-    fun iterator() {
-        assertEquals(
-            listOf(TestModel()), TestModel(0).iterator().asSequence().toList()
-        )
-    }
-}