Skip to content

Commit 78b0a80

Browse files
committed
chore(model-datastructure): make comments kdoc comments
This way they are visible in IDEs on mouse over and in the generated reference.
1 parent 89a64ff commit 78b0a80

File tree

1 file changed

+12
-4
lines changed
  • model-datastructure/src/commonMain/kotlin/org/modelix/model/persistent

1 file changed

+12
-4
lines changed

model-datastructure/src/commonMain/kotlin/org/modelix/model/persistent/Separators.kt

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,20 @@ package org.modelix.model.persistent
2424
* Each of the separators should be unique and not appear in the output of SerializationUtil.escape (URL encode)
2525
*/
2626
object Separators {
27-
const val LEVEL1 = "/" // Between parts of top level elements stored in the key-value store: CPVersion, CPNode, CPHamt*
28-
const val LEVEL2 = "," // between elements of the operation list
27+
/** Between parts of top level elements stored in the key-value store: CPVersion, CPNode, CPHamt* */
28+
const val LEVEL1 = "/"
29+
30+
/** Between elements of the operation list */
31+
const val LEVEL2 = ","
32+
2933
const val LEVEL3 = ";"
30-
const val LEVEL4 = ":" // lists inside operation parts
3134

32-
const val MAPPING = "=" // for properties and references
35+
/** For lists inside operation parts */
36+
const val LEVEL4 = ":" //
37+
38+
/** For properties and references */
39+
const val MAPPING = "="
40+
3341
const val OPS = LEVEL2
3442
const val OP_PARTS = LEVEL3
3543
}

0 commit comments

Comments
 (0)