Package io.toolisticon.kotlin.generation.builder

Interface KotlinDocumentableBuilder

  • All Implemented Interfaces:
    io.toolisticon.kotlin.generation.builder.KotlinTaggableBuilder 
    
public interface KotlinDocumentableBuilder<SELF extends Object>
 implements KotlinTaggableBuilder<SELF>

    Typesafe wrapper for com.squareup.kotlinpoet.Documentable.Builder. Marks anything that can have kdoc documentation.

    • addKdoc

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract SELF addKdoc(KDoc kdoc) Implementing builders have to add this to their build.
      SELF addKdoc(String docs) Wraps a single string and adds it.
      SELF addKdoc(String format, String first, Object other) Creates a codeBlock using format and args and then addsIt.
      SELF addKDoc(CodeBlock kdoc) Wraps a codeBlock into a KDoc and adds it.

      • Methods inherited from class io.toolisticon.kotlin.generation.builder.KotlinTaggableBuilder

        addTag, addTag, removeTag

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • addKdoc

         abstract SELF addKdoc(KDoc kdoc)

        Implementing builders have to add this to their build.

      • addKDoc

         SELF addKDoc(CodeBlock kdoc)

        Wraps a codeBlock into a KDoc and adds it.