kotlinpoet/src/commonMain/kotlin/com/squareup/kotlinpoet/Documentable.kt


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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
  }
}