From 86f9559ebd40a07e996df49464fc9101dd21d3bc Mon Sep 17 00:00:00 2001
From: Ignat Beresnev <ignat.beresnev@jetbrains.com>
Date: Mon, 26 Sep 2022 18:47:01 +0200
Subject: Add documentation for synthetic Enum `values()` and `valueOf()`
 functions (#2650)

---
 .../resources/dokka/docs/javadoc/EnumValueOf.java.template   | 12 ++++++++++++
 .../resources/dokka/docs/javadoc/EnumValues.java.template    |  8 ++++++++
 .../main/resources/dokka/docs/kdoc/EnumValueOf.kt.template   |  4 ++++
 .../main/resources/dokka/docs/kdoc/EnumValues.kt.template    |  3 +++
 4 files changed, 27 insertions(+)
 create mode 100644 plugins/base/src/main/resources/dokka/docs/javadoc/EnumValueOf.java.template
 create mode 100644 plugins/base/src/main/resources/dokka/docs/javadoc/EnumValues.java.template
 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')

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
+ */
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