lumis.content.documentation.generator

Class ContentServiceDocumentationGenerator

java.lang.Object

lumis.portal.documentation.generator.GenericServiceDocumentationGenerator

lumis.doui.documentation.generator.DouiServiceDocumentationGenerator

lumis.content.documentation.generator.ContentServiceDocumentationGenerator

All Implemented Interfaces:

IServiceDocumentationGenerator

public class ContentServiceDocumentationGenerator
extends DouiServiceDocumentationGenerator

Generates service documentation for content services.

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
ContentServiceDocumentationGenerator()

Method Summary

Modifier and Type	Method and Description
protected void	documentationSetTemplateSectionFields(ServiceConfig serviceConfig, IResource resource, Locale locale, Node sourceNode, IDocumentationTemplate.DocumentationSection dataSection) Generation of source field information is overridden to include meta data fields as well.
protected String	getDefaultServiceDetailedDescription(ServiceConfig serviceConfig, IResource resource, Locale locale, IDocumentationTemplate template, ITransaction transaction) Used by inherited Classes (ex.
protected IServiceInterfaceDocumentationGenerator	getServiceInterfaceDocumentationGenerator(IServiceInterface si)

Methods inherited from class lumis.doui.documentation.generator.DouiServiceDocumentationGenerator

documentationSetTemplateSections

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

documentationGetServiceDescription, documentationGetServiceName, documentationGetServiceSummary, generateDocumentationForService, generateDocumentationForServiceInterface

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentServiceDocumentationGenerator

public ContentServiceDocumentationGenerator()

Method Detail

documentationSetTemplateSectionFields

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

Generation of source field information is overridden to include meta data fields as well.

Overrides:

documentationSetTemplateSectionFields in class DouiServiceDocumentationGenerator

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

getDefaultServiceDetailedDescription

protected String getDefaultServiceDetailedDescription(ServiceConfig serviceConfig,
                                                      IResource resource,
                                                      Locale locale,
                                                      IDocumentationTemplate template,
                                                      ITransaction transaction)
                                               throws ManagerException,
                                                      PortalException

Description copied from class: GenericServiceDocumentationGenerator

Used by inherited Classes (ex. doui/content) to customize default description.

Overrides:

getDefaultServiceDetailedDescription 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.

Returns:

Throws:

ManagerException

PortalException

getServiceInterfaceDocumentationGenerator

protected IServiceInterfaceDocumentationGenerator getServiceInterfaceDocumentationGenerator(IServiceInterface si)
                                                                                     throws PortalException

Overrides:

getServiceInterfaceDocumentationGenerator in class DouiServiceDocumentationGenerator

Throws:

PortalException