Package org.apache.batchee.tools.maven.doc

## Interface ComponentDocumentationGenerator.Formatter

- Enclosing class:
    ComponentDocumentationGenerator

      public static interface ComponentDocumentationGenerator.Formatter

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | `add​(Writer writer, ComponentDocumentationGenerator.FieldDoc doc)` |
    `void` | `begin​(Writer writer)` |
    `void` | `beginClass​(Writer writer, String className, String doc)` |
    `void` | `end​(Writer writer)` |
    `void` | `endClass​(Writer writer)` |

- - ### Method Detail

    - #### begin

          void begin​(Writer writer)
              throws IOException

      Throws:
        `IOException`

    - #### beginClass

          void beginClass​(Writer writer,
                          String className,
                          String doc)
                   throws IOException

      Throws:
        `IOException`

    - #### add

          void add​(Writer writer,
                   ComponentDocumentationGenerator.FieldDoc doc)
            throws IOException

      Throws:
        `IOException`

    - #### endClass

          void endClass​(Writer writer)
                 throws IOException

      Throws:
        `IOException`

    - #### end

          void end​(Writer writer)
            throws IOException

      Throws:
        `IOException`