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/javadoc | |
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/javadoc')
-rw-r--r-- | plugins/base/src/main/resources/dokka/docs/javadoc/EnumValueOf.java.template | 12 | ||||
-rw-r--r-- | plugins/base/src/main/resources/dokka/docs/javadoc/EnumValues.java.template | 8 |
2 files changed, 20 insertions, 0 deletions
diff --git a/plugins/base/src/main/resources/dokka/docs/javadoc/EnumValueOf.java.template b/plugins/base/src/main/resources/dokka/docs/javadoc/EnumValueOf.java.template new file mode 100644 index 00000000..233f8819 --- /dev/null +++ b/plugins/base/src/main/resources/dokka/docs/javadoc/EnumValueOf.java.template @@ -0,0 +1,12 @@ +/** + * 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.) + * + * @return the enum constant with the specified name + * @throws IllegalArgumentException if this enum type has no + * constant with the specified name + */ +
\ No newline at end of file diff --git a/plugins/base/src/main/resources/dokka/docs/javadoc/EnumValues.java.template b/plugins/base/src/main/resources/dokka/docs/javadoc/EnumValues.java.template new file mode 100644 index 00000000..4aed38a6 --- /dev/null +++ b/plugins/base/src/main/resources/dokka/docs/javadoc/EnumValues.java.template @@ -0,0 +1,8 @@ +/** + * 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. + * + * @return an array containing the constants of this enum + * type, in the order they're declared + */ |