docs: Fix instances of documentation referring to inline (value) classes where they are no longer used. Closes #111

Author: 0ffz

addons/geary-prefabs/src/com/mineinabyss/geary/prefabs/PrefabKey.kt

@@ -6,12 +6,12 @@ import com.mineinabyss.geary.prefabs.serializers.PrefabKeySerializer
 import kotlinx.serialization.Serializable
 
 /**
- * An inline class which represents a key build from a [namespace] and [key], separated
+ * Represents a key build from a [namespace] and [key], separated
  * by a '`:`' symbol.
  */
 @ConsistentCopyVisibility
 @Serializable(with = PrefabKeySerializer::class)
-// We don't make this a value class since calculating substring is pretty expensive compared to one new object instantiation
+// Note: We don't make this a value class since calculating substring is pretty expensive compared to one new object instantiation
 data class PrefabKey private constructor(val namespace: String, val key: String) {
     val full get() = "$namespace:$key"
 

geary-core/src/com/mineinabyss/geary/datatypes/Entity.kt

@@ -3,7 +3,6 @@ package com.mineinabyss.geary.datatypes
 import com.mineinabyss.geary.annotations.optin.DangerousComponentOperation
 import com.mineinabyss.geary.components.EntityName
 import com.mineinabyss.geary.datatypes.family.family
-import com.mineinabyss.geary.engine.Engine
 import com.mineinabyss.geary.helpers.NO_COMPONENT
 import com.mineinabyss.geary.helpers.component
 import com.mineinabyss.geary.helpers.componentId
@@ -28,11 +27,12 @@ import kotlin.reflect.KClass
 typealias GearyEntity = Entity
 
 /**
- * A wrapper around [EntityId] that gets inlined to just a long (no performance degradation since no boxing occurs).
+ * A combination of [EntityId] with a [world] it belongs to.
  *
- * Provides some useful functions, so we aren't forced to go through [Engine] every time we want to do some things.
+ * Provides some useful functions for reading and writing data associated with this entity, as well as validating
+ * matching [world] instances when multiple entities are involved (see [requireSameWorldAs]).
  */
-//TODO add require checks for entities across different worlds
+//TODO call requireSameWorldAs for all functions involving other Entity instances.
 class Entity(val id: EntityId, val world: Geary) {
     val comp get() = world.components
 

geary-core/src/com/mineinabyss/geary/datatypes/EntityIdArray.kt

@@ -13,6 +13,10 @@ fun MutableLongList.toEntityArray(world: Geary): EntityArray {
     return EntityArray(world, ULongArray(size) { get(it).toULong() })
 }
 
+/**
+ * An array of [EntityId]s with an associated [world].
+ * Avoids string boxed [GearyEntity] instances for each entity, with helpers to completely avoid boxing like [forEachId].
+ */
 class EntityArray(
     val world: Geary,
     val ids: EntityIdArray,

geary-core/src/com/mineinabyss/geary/datatypes/EntityType.kt

@@ -4,13 +4,13 @@ import com.mineinabyss.geary.helpers.readableString
 
 
 /**
- * An inlined class used for tracking the components an entity/archetype has.
+ * Immutable array of [ComponentId]s used to represent the 'type' of an [com.mineinabyss.geary.engine.archetypes.Archetype].
  *
  * It provides fast (no boxing) functions backed by FastUtil sorted sets to do operations with [ComponentId]s.
  */
 class EntityType private constructor(
     @PublishedApi
-    internal val inner: ULongArray
+    internal val inner: ULongArray,
 ) {
     constructor() : this(ULongArray(0))