diff options
| author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2022-09-26 18:47:01 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-26 18:47:01 +0200 |
| commit | 86f9559ebd40a07e996df49464fc9101dd21d3bc (patch) | |
| tree | 88b91d93b49e3276b81143febb9cb381ab03b82d /plugins/base/src/main/resources/dokka/docs/kdoc | |
| parent | 9207f8f032fac8036c9aa5aa65633341a14efa62 (diff) | |
| download | dokka-86f9559ebd40a07e996df49464fc9101dd21d3bc.tar.gz dokka-86f9559ebd40a07e996df49464fc9101dd21d3bc.tar.bz2 dokka-86f9559ebd40a07e996df49464fc9101dd21d3bc.zip | |
Add documentation for synthetic Enum `values()` and `valueOf()` functions (#2650)
Diffstat (limited to 'plugins/base/src/main/resources/dokka/docs/kdoc')
| -rw-r--r-- | plugins/base/src/main/resources/dokka/docs/kdoc/EnumValueOf.kt.template | 4 | ||||
| -rw-r--r-- | plugins/base/src/main/resources/dokka/docs/kdoc/EnumValues.kt.template | 3 |
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. |