lumis.portal.documentation

Interface IServiceDocumentationGenerator

All Known Implementing Classes:

ContentServiceDocumentationGenerator, DouiServiceDocumentationGenerator, GenericServiceDocumentationGenerator

public interface IServiceDocumentationGenerator

Interface for generating documentation for services.

Since:

9.0.0

Version:

$Revision: 19136 $ $Date: 2016-06-02 21:14:45 +0000 (Thu, 02 Jun 2016) $

Method Summary

Modifier and Type	Method and Description
void	generateDocumentationForService(String serviceId, Locale locale, IDocumentationTemplate template) Generates HTML documentation for the service.
void	generateDocumentationForServiceInterface(String interfaceId, Locale locale, boolean reGenerateImages, IDocumentationTemplate documentationTemplate) Generates HTML documentation for the given service interface.

Method Detail

generateDocumentationForService

void generateDocumentationForService(String serviceId,
                                     Locale locale,
                                     IDocumentationTemplate template)
                              throws PortalException

Generates HTML documentation for the service.

The HTML documentation should be generated in the root directory provided.

Parameters:

serviceId -

locale - locale the locale in which the documentation should be generated.

template - the template where the generated information should be sent to for rendering.

Throws:

PortalException

generateDocumentationForServiceInterface

void generateDocumentationForServiceInterface(String interfaceId,
                                              Locale locale,
                                              boolean reGenerateImages,
                                              IDocumentationTemplate documentationTemplate)
                                       throws PortalException

Generates HTML documentation for the given service interface.

Parameters:

interfaceId - the interface for which documentation should be generated

locale - locale the locale in which the documentation should be generated.

reGenerateImages - flags whether images should be generated. This may cause documentation take longer to generate.

documentationTemplate - the template where the generated information should be sent to for rendering.

Throws:

PortalException

Since:

9.0.0