Package com.io7m.cedarbridge.bridgedoc.api

# Interface CBDocGeneratorDirectoryType

All Known Implementing Classes:
  `CBDocGenerators`

public interface CBDocGeneratorDirectoryType
A directory of documentation generators.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `List<CBDocGeneratorFactoryType>`
  `availableGenerators()`
  `default Optional<CBDocGeneratorFactoryType>`
  `findByLanguageName(String languageName)`
  Find a documentation generator that has the given language name.

- ## Method Details

  - ### availableGenerators

    List<CBDocGeneratorFactoryType> availableGenerators()
    Returns:
      The available documentation generators

  - ### findByLanguageName

    default Optional<CBDocGeneratorFactoryType> findByLanguageName(String languageName)
    Find a documentation generator that has the given language name.
    Parameters:
      `languageName` - The language name (case insensitive)
    Returns:
      A documentation generator, if any