lumis.content.documentation.generator

Class ContentDocumentationUtil

java.lang.Object

lumis.doui.documentation.generator.DouiDocumentationUtil

lumis.content.documentation.generator.ContentDocumentationUtil

public class ContentDocumentationUtil
extends DouiDocumentationUtil

Utility file for content specific documentation generation

Since:

9.0.0

Version:

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

Constructor Summary

Constructors

Constructor and Description
ContentDocumentationUtil()

Method Summary

Modifier and Type	Method and Description
static void	documentationSetTemplateSectionFields(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, Node sourceNode, IDocumentationTemplate.DocumentationSection dataSection) sets the fields information into a data section considering metadata information

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

renderSource

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentDocumentationUtil

public ContentDocumentationUtil()

Method Detail

documentationSetTemplateSectionFields

public static void documentationSetTemplateSectionFields(ServiceInterfaceConfig serviceInterfaceConfig,
                                                         IResource resource,
                                                         Locale locale,
                                                         Node sourceNode,
                                                         IDocumentationTemplate.DocumentationSection dataSection)
                                                  throws PortalException

sets the fields information into a data section considering metadata information

Parameters:

serviceInterfaceConfig -

resource - used to translate strings.

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

sourceNode - the source node for which documentation should be rendered.

dataSection - the dataSection of documentation for which field information should be included.

Throws:

PortalException

Since:

9.0.0