CBXGenerator

java.lang.Object

com.io7m.cedarbridge.bridgedoc.xhtml.internal.CBXGenerator

All Implemented Interfaces:: CBSPIDocGeneratorType

public final class CBXGenerator extends Object implements CBSPIDocGeneratorType

An XHTML generator.

Constructor Summary

Constructors

Constructor

Description

CBXGenerator(CBSPIDocGeneratorConfiguration inConfiguration)

An XHTML generator.
Method Summary

Modifier and Type

Method

Description

CBSPIDocGeneratorResult

execute(CBPackageType pack)

Execute documentation generation for the given package.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- CBXGenerator
  
  public CBXGenerator(CBSPIDocGeneratorConfiguration inConfiguration)
  
  An XHTML generator.
  
  Parameters:
  
  inConfiguration - The configuration
Method Details
- execute
  
  public CBSPIDocGeneratorResult execute(CBPackageType pack) throws CBSPIDocGeneratorException
  
  Description copied from interface: CBSPIDocGeneratorType
  
  Execute documentation generation for the given package.
  
  Specified by:
  
  execute in interface CBSPIDocGeneratorType
  
  Parameters:
  
  pack - The package
  
  Returns:
  
  The result of generation
  
  Throws:
  
  CBSPIDocGeneratorException - On errors