org.codehaus.mojo.servicedocgen.generation

Interface ServicesGenerator

All Known Implementing Classes:

VelocityServicesGenerator

public interface ServicesGenerator

Interface for a generator that creates documentation for a given ServicesDescriptor.

Author:

hohwille

See Also:

generate(ServicesDescriptor, File, String, String)

Method Summary

Modifier and Type	Method and Description
void	generate(ServicesDescriptor descriptor, File outputDirectory, String filename, String openApiUrl) Generates the documentation as output.

Method Detail

generate

void generate(ServicesDescriptor descriptor,
              File outputDirectory,
              String filename,
              String openApiUrl)
       throws IOException

Generates the documentation as output.

Parameters:

descriptor - the ServicesDescriptor with the collected meta-data.

outputDirectory - the directory where to write the output to.

filename - the name of the file to write the output to.

openApiUrl - the url to the OpenApi file

Throws:

IOException - if something goes wrong.