Package com.io7m.cedarbridge.bridgedoc.api

# Class CBDocGenerators

java.lang.Object
com.io7m.cedarbridge.bridgedoc.api.CBDocGenerators

All Implemented Interfaces:
  `CBDocGeneratorDirectoryType`

public final class CBDocGenerators extends Object implements CBDocGeneratorDirectoryType
A directory of documentation generators.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `CBDocGenerators()`
  Construct a directory, loading available generators using `ServiceLoader`.
  `CBDocGenerators(List<CBDocGeneratorFactoryType> inGenerators)`
  Construct a directory using the given documentation generators.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `List<CBDocGeneratorFactoryType>`
  `availableGenerators()`

  ### Methods inherited from class java.lang.Object

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

  ### Methods inherited from interface com.io7m.cedarbridge.bridgedoc.api.CBDocGeneratorDirectoryType

  `findByLanguageName`

- ## Constructor Details

  - ### CBDocGenerators

    public CBDocGenerators(List<CBDocGeneratorFactoryType> inGenerators)
    Construct a directory using the given documentation generators.
    Parameters:
      `inGenerators` - The generators

  - ### CBDocGenerators

    public CBDocGenerators()
    Construct a directory, loading available generators using `ServiceLoader`.

- ## Method Details

  - ### availableGenerators

    public List<CBDocGeneratorFactoryType> availableGenerators()
    Specified by:
      `availableGenerators` in interface `CBDocGeneratorDirectoryType`
    Returns:
      The available documentation generators