Interface DocumentationWriter<T extends CodeWriter>

Type Parameters:
T - The type of CodegenWriter being written to.
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@Deprecated @FunctionalInterface public interface DocumentationWriter<T extends CodeWriter>
prefer DocWriter. This will be removed in a future release.
Responsible for properly writing documentation emitted when a Runnable in invoked.

The following example shows how to implement a basic DocumentationWriter that encloses documentation in successive lines that start with "///".

 public final class MyDocWriter implements DocumentationWriter<MyWriter> {
     public void writeDocs(T writer, Runnable runnable) {
         setNewlinePrefix("/// ");
  • Method Summary

    Modifier and Type
    writeDocs(T writer, Runnable runnable)
    Writes documentation comments.
  • Method Details

    • writeDocs

      void writeDocs(T writer, Runnable runnable)
      Writes documentation comments.

      Implementations are expected to write out the beginning of a documentation comment, set any necessary prefix for each line written while writing docs, then invoke the given runnable, then finally write the closing characters for documentation.

      writer - Writer to configure for writing documentation.
      runnable - Runnable that handles actually writing docs with the writer.