lumis.doui.documentation.generator

Class DouiServiceDocumentationGenerator

java.lang.Object

lumis.portal.documentation.generator.GenericServiceDocumentationGenerator

lumis.doui.documentation.generator.DouiServiceDocumentationGenerator

All Implemented Interfaces:

IServiceDocumentationGenerator

Direct Known Subclasses:

ContentServiceDocumentationGenerator

public class DouiServiceDocumentationGenerator
extends GenericServiceDocumentationGenerator

Responsible for DOUI specific documentation generation

Since:

9.0.0

Version:

$Revision: 19135 $ $Date: 2016-06-02 21:12:21 +0000 (Thu, 02 Jun 2016) $

Field Summary

Fields inherited from class lumis.portal.documentation.generator.GenericServiceDocumentationGenerator

docResource

Constructor Summary

Constructors

Constructor and Description
DouiServiceDocumentationGenerator()

Method Summary

Modifier and Type	Method and Description
protected void	documentationSetTemplateSectionFields(ServiceConfig serviceConfig, IResource resource, Locale locale, Node sourceNode, IDocumentationTemplate.DocumentationSection dataSection) For each source the field information is generated here.
protected void	documentationSetTemplateSections(ServiceConfig serviceConfig, IResource resource, Locale locale, IDocumentationTemplate template, ITransaction transaction) Includes source information to the documentation.
protected IServiceInterfaceDocumentationGenerator	getServiceInterfaceDocumentationGenerator(IServiceInterface si)

Methods inherited from class lumis.portal.documentation.generator.GenericServiceDocumentationGenerator

documentationGetServiceDescription, documentationGetServiceName, documentationGetServiceSummary, generateDocumentationForService, generateDocumentationForServiceInterface, getDefaultServiceDetailedDescription

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DouiServiceDocumentationGenerator

public DouiServiceDocumentationGenerator()

Method Detail

documentationSetTemplateSections

protected void documentationSetTemplateSections(ServiceConfig serviceConfig,
                                                IResource resource,
                                                Locale locale,
                                                IDocumentationTemplate template,
                                                ITransaction transaction)
                                         throws PortalException

Includes source information to the documentation.

Overrides:

documentationSetTemplateSections in class GenericServiceDocumentationGenerator

resource - used to translate strings.

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

template - the documentation template used to generate documentation files.

Throws:

PortalException

documentationSetTemplateSectionFields

protected void documentationSetTemplateSectionFields(ServiceConfig serviceConfig,
                                                     IResource resource,
                                                     Locale locale,
                                                     Node sourceNode,
                                                     IDocumentationTemplate.DocumentationSection dataSection)
                                              throws PortalException

For each source the field information is generated here.

Parameters:

serviceConfig -

resource - used to translate strings.

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

sourceNode - the source node used to generate fields documentation.

dataSection - the documentation source section to which information should be added.

Throws:

PortalException

Since:

9.0.0

getServiceInterfaceDocumentationGenerator

protected IServiceInterfaceDocumentationGenerator getServiceInterfaceDocumentationGenerator(IServiceInterface si)
                                                                                     throws PortalException

Overrides:

getServiceInterfaceDocumentationGenerator in class GenericServiceDocumentationGenerator

Throws:

PortalException