From 86f9559ebd40a07e996df49464fc9101dd21d3bc Mon Sep 17 00:00:00 2001 From: Ignat Beresnev Date: Mon, 26 Sep 2022 18:47:01 +0200 Subject: Add documentation for synthetic Enum `values()` and `valueOf()` functions (#2650) --- .../base/src/main/resources/dokka/docs/kdoc/EnumValueOf.kt.template | 4 ++++ .../base/src/main/resources/dokka/docs/kdoc/EnumValues.kt.template | 3 +++ 2 files changed, 7 insertions(+) create mode 100644 plugins/base/src/main/resources/dokka/docs/kdoc/EnumValueOf.kt.template create mode 100644 plugins/base/src/main/resources/dokka/docs/kdoc/EnumValues.kt.template (limited to 'plugins/base/src/main/resources/dokka/docs/kdoc') 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. -- cgit