Added @ExportAsHtml annotation and cleaned documentation/utils.kt file

Author: Jolanrensen

core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/utils.kt

@@ -1,5 +1,19 @@
 package org.jetbrains.kotlinx.dataframe.documentation
 
+import kotlin.annotation.AnnotationTarget.ANNOTATION_CLASS
+import kotlin.annotation.AnnotationTarget.CLASS
+import kotlin.annotation.AnnotationTarget.CONSTRUCTOR
+import kotlin.annotation.AnnotationTarget.FIELD
+import kotlin.annotation.AnnotationTarget.FILE
+import kotlin.annotation.AnnotationTarget.FUNCTION
+import kotlin.annotation.AnnotationTarget.LOCAL_VARIABLE
+import kotlin.annotation.AnnotationTarget.PROPERTY
+import kotlin.annotation.AnnotationTarget.PROPERTY_GETTER
+import kotlin.annotation.AnnotationTarget.PROPERTY_SETTER
+import kotlin.annotation.AnnotationTarget.TYPE
+import kotlin.annotation.AnnotationTarget.TYPEALIAS
+import kotlin.annotation.AnnotationTarget.VALUE_PARAMETER
+
 /**
  *
  *     
@@ -32,18 +46,27 @@ internal interface QuadrupleIndent
  * Do not rename!
  */
 @Target(
-    AnnotationTarget.CLASS,
-    AnnotationTarget.ANNOTATION_CLASS,
-    AnnotationTarget.PROPERTY,
-    AnnotationTarget.FIELD,
-    AnnotationTarget.LOCAL_VARIABLE,
-    AnnotationTarget.VALUE_PARAMETER,
-    AnnotationTarget.CONSTRUCTOR,
-    AnnotationTarget.FUNCTION,
-    AnnotationTarget.PROPERTY_GETTER,
-    AnnotationTarget.PROPERTY_SETTER,
-    AnnotationTarget.TYPE,
-    AnnotationTarget.TYPEALIAS,
-    AnnotationTarget.FILE,
+    CLASS, ANNOTATION_CLASS, PROPERTY, FIELD, LOCAL_VARIABLE, VALUE_PARAMETER,
+    CONSTRUCTOR, FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, TYPE, TYPEALIAS, FILE,
 )
 internal annotation class ExcludeFromSources
+
+/**
+ * Any `Documentable` annotated with this annotation will be exported to HTML by the documentation
+ * processor.
+ *
+ * You can use @exportAsHtmlStart and @exportAsHtmlEnd to specify a range of the doc to
+ * export to HTML.
+ *
+ * Do not rename!
+ *
+ * @param theme Whether to include a simple theme in the HTML file. Default is `true`.
+ * @param stripReferences Whether to strip `[references]` from the HTML file. Default is `true`.
+ *  This is useful when you want to include the HTML file in a website, where the references are not
+ *  needed or would break.
+ */
+@Target(
+    CLASS, ANNOTATION_CLASS, PROPERTY, FIELD, LOCAL_VARIABLE, VALUE_PARAMETER,
+    CONSTRUCTOR, FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, TYPE, TYPEALIAS, FILE,
+)
+internal annotation class ExportAsHtml(val theme: Boolean = true, val stripReferences: Boolean = true)

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/utils.kt

@@ -1,5 +1,19 @@
 package org.jetbrains.kotlinx.dataframe.documentation
 
+import kotlin.annotation.AnnotationTarget.ANNOTATION_CLASS
+import kotlin.annotation.AnnotationTarget.CLASS
+import kotlin.annotation.AnnotationTarget.CONSTRUCTOR
+import kotlin.annotation.AnnotationTarget.FIELD
+import kotlin.annotation.AnnotationTarget.FILE
+import kotlin.annotation.AnnotationTarget.FUNCTION
+import kotlin.annotation.AnnotationTarget.LOCAL_VARIABLE
+import kotlin.annotation.AnnotationTarget.PROPERTY
+import kotlin.annotation.AnnotationTarget.PROPERTY_GETTER
+import kotlin.annotation.AnnotationTarget.PROPERTY_SETTER
+import kotlin.annotation.AnnotationTarget.TYPE
+import kotlin.annotation.AnnotationTarget.TYPEALIAS
+import kotlin.annotation.AnnotationTarget.VALUE_PARAMETER
+
 /**
  *
  * {@include [Indent]}
@@ -32,18 +46,27 @@ internal interface QuadrupleIndent
  * Do not rename!
  */
 @Target(
-    AnnotationTarget.CLASS,
-    AnnotationTarget.ANNOTATION_CLASS,
-    AnnotationTarget.PROPERTY,
-    AnnotationTarget.FIELD,
-    AnnotationTarget.LOCAL_VARIABLE,
-    AnnotationTarget.VALUE_PARAMETER,
-    AnnotationTarget.CONSTRUCTOR,
-    AnnotationTarget.FUNCTION,
-    AnnotationTarget.PROPERTY_GETTER,
-    AnnotationTarget.PROPERTY_SETTER,
-    AnnotationTarget.TYPE,
-    AnnotationTarget.TYPEALIAS,
-    AnnotationTarget.FILE,
+    CLASS, ANNOTATION_CLASS, PROPERTY, FIELD, LOCAL_VARIABLE, VALUE_PARAMETER,
+    CONSTRUCTOR, FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, TYPE, TYPEALIAS, FILE,
 )
 internal annotation class ExcludeFromSources
+
+/**
+ * Any `Documentable` annotated with this annotation will be exported to HTML by the documentation
+ * processor.
+ *
+ * You can use @exportAsHtmlStart and @exportAsHtmlEnd to specify a range of the doc to
+ * export to HTML.
+ *
+ * Do not rename!
+ *
+ * @param theme Whether to include a simple theme in the HTML file. Default is `true`.
+ * @param stripReferences Whether to strip `[references]` from the HTML file. Default is `true`.
+ *  This is useful when you want to include the HTML file in a website, where the references are not
+ *  needed or would break.
+ */
+@Target(
+    CLASS, ANNOTATION_CLASS, PROPERTY, FIELD, LOCAL_VARIABLE, VALUE_PARAMETER,
+    CONSTRUCTOR, FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, TYPE, TYPEALIAS, FILE,
+)
+internal annotation class ExportAsHtml(val theme: Boolean = true, val stripReferences: Boolean = true)