aboutsummaryrefslogtreecommitdiff
path: root/plugins/base/src/main/resources/dokka/docs/kdoc
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/base/src/main/resources/dokka/docs/kdoc')
-rw-r--r--plugins/base/src/main/resources/dokka/docs/kdoc/EnumValueOf.kt.template4
-rw-r--r--plugins/base/src/main/resources/dokka/docs/kdoc/EnumValues.kt.template3
2 files changed, 7 insertions, 0 deletions
diff --git a/plugins/base/src/main/resources/dokka/docs/kdoc/EnumValueOf.kt.template b/plugins/base/src/main/resources/dokka/docs/kdoc/EnumValueOf.kt.template
new file mode 100644
index 00000000..fbf8fa8d
--- /dev/null
+++ b/plugins/base/src/main/resources/dokka/docs/kdoc/EnumValueOf.kt.template
@@ -0,0 +1,4 @@
+Returns the enum constant of this type with the specified name. The string must match exactly an identifier used
+to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
+
+@throws kotlin.IllegalArgumentException if this enum type has no constant with the specified name
diff --git a/plugins/base/src/main/resources/dokka/docs/kdoc/EnumValues.kt.template b/plugins/base/src/main/resources/dokka/docs/kdoc/EnumValues.kt.template
new file mode 100644
index 00000000..c0e3559c
--- /dev/null
+++ b/plugins/base/src/main/resources/dokka/docs/kdoc/EnumValues.kt.template
@@ -0,0 +1,3 @@
+Returns an array containing the constants of this enum type, in the order they're declared.
+
+This method may be used to iterate over the constants.