com.google.api.tools.framework.aspects.documentation

Class DocumentationProcessorSet

java.lang.Object

com.google.api.tools.framework.aspects.documentation.DocumentationProcessorSet

public class DocumentationProcessorSet
extends java.lang.Object

Processor set that contains a set of registered DocumentationProcessors to process given documentation in a chained way.

Constructor Summary

Constructors

Constructor and Description
DocumentationProcessorSet(java.util.Collection<com.google.api.tools.framework.aspects.documentation.DocumentationProcessor> processors)

Method Summary

Modifier and Type	Method and Description
java.lang.String	process(java.lang.String source, Location location, Element element) Processes given documentation source by the registered processor chain.
static DocumentationProcessorSet	standardSetup(Model model) Returns DocumentationProcessorSet with standard processors registered.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentationProcessorSet

public DocumentationProcessorSet(java.util.Collection<com.google.api.tools.framework.aspects.documentation.DocumentationProcessor> processors)

Method Detail

standardSetup

public static DocumentationProcessorSet standardSetup(Model model)

Returns DocumentationProcessorSet with standard processors registered.

process

public java.lang.String process(java.lang.String source,
                                Location location,
                                Element element)

Processes given documentation source by the registered processor chain. Returns processed documentation string.