Interface CBSPIDocGeneratorType

All Known Implementing Classes:

CBXGenerator

public interface CBSPIDocGeneratorType

A documentation generator.

Method Summary

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

Method Details

execute

CBSPIDocGeneratorResult execute(CBPackageType pack)
                         throws CBSPIDocGeneratorException

Execute documentation generation for the given package.

Parameters:

pack - The package

Returns:

The result of generation

Throws:

CBSPIDocGeneratorException - On errors