lumis.portal.documentation

Interface IServiceInterfaceDocumentationGenerator

All Known Implementing Classes:

ContentServiceInterfaceDocumentationGenerator, DouiServiceInterfaceDocumentationGenerator, GenericServiceInterfaceDocumentationGenerator

public interface IServiceInterfaceDocumentationGenerator

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	generateDocumentationForServiceInterface(String interfaceId, IResource docResource, Locale locale, boolean reGenerateImages, IDocumentationTemplate documentationTemplate) Generates HTML documentation for the service interface

Method Detail

generateDocumentationForServiceInterface

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

Generates HTML documentation for the service interface

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

Parameters:

interfaceId -

locale -

reGenerateImages - TODO

documentationTemplate -

transaction -

Throws:

PortalException

Since:

9.0.0