diff options
Diffstat (limited to 'kotlinpoet/src/commonMain/kotlin/com/squareup/kotlinpoet/Documentable.kt')
-rw-r--r-- | kotlinpoet/src/commonMain/kotlin/com/squareup/kotlinpoet/Documentable.kt | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/kotlinpoet/src/commonMain/kotlin/com/squareup/kotlinpoet/Documentable.kt b/kotlinpoet/src/commonMain/kotlin/com/squareup/kotlinpoet/Documentable.kt new file mode 100644 index 00000000..3dff284e --- /dev/null +++ b/kotlinpoet/src/commonMain/kotlin/com/squareup/kotlinpoet/Documentable.kt @@ -0,0 +1,34 @@ +/* + * Copyright (C) 2023 Square, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.squareup.kotlinpoet + +/** A spec which contains documentation. */ +public interface Documentable { + public val kdoc: CodeBlock + + @Suppress("UNCHECKED_CAST") + public interface Builder<out T : Builder<T>> { + public val kdoc: CodeBlock.Builder + + public fun addKdoc(format: String, vararg args: Any): T = apply { + kdoc.add(format, *args) + } as T + + public fun addKdoc(block: CodeBlock): T = apply { + kdoc.add(block) + } as T + } +} |