Package com.io7m.cedarbridge.bridgedoc.api

Interface CBDocGeneratorType

public interface CBDocGeneratorType

A documentation generator.

Method Summary

Modifier and Type	Method	Description
CBDocGeneratorResult	execute(CBPackageType pack)	Execute documentation generation for the given package.

Method Details

execute

CBDocGeneratorResult execute(CBPackageType pack)
                      throws CBDocGeneratorException

Execute documentation generation for the given package.

Parameters:

pack - The package

Returns:

The result of generation

Throws:

CBDocGeneratorException - On errors