org.wildfly.swarm.plugin.process.configurable

Class ResourceDocumentationGatherer

java.lang.Object

org.wildfly.swarm.plugin.process.configurable.DocumentationGatherer

org.wildfly.swarm.plugin.process.configurable.ResourceDocumentationGatherer

public class ResourceDocumentationGatherer
extends DocumentationGatherer

Author:

Bob McWhirter

Field Summary

Fields inherited from class org.wildfly.swarm.plugin.process.configurable.DocumentationGatherer

index, registry

Constructor Summary

Constructors

Constructor and Description
ResourceDocumentationGatherer(org.apache.maven.plugin.logging.Log log, DocumentationRegistry registry, org.jboss.jandex.IndexView index, org.jboss.jandex.ClassInfo resourceClassInfo)
ResourceDocumentationGatherer(org.apache.maven.plugin.logging.Log log, String name, DocumentationRegistry registry, org.jboss.jandex.IndexView index, org.jboss.jandex.ClassInfo resourceClassInfo)

Method Summary

Modifier and Type	Method and Description
void	gather()
protected void	process(org.jboss.jandex.ClassInfo current, boolean isRootFraction)
protected void	process(org.jboss.jandex.FieldInfo field, boolean isRootFraction)

Methods inherited from class org.wildfly.swarm.plugin.process.configurable.DocumentationGatherer

addDocumentation, dashize, getClassByName, getDocumentation, getLog, isMarkedAsConfigurable, isMarkedAsDocumented, isSingletonResource, isSubresources, nameFor, nameFor

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceDocumentationGatherer

public ResourceDocumentationGatherer(org.apache.maven.plugin.logging.Log log,
                                     DocumentationRegistry registry,
                                     org.jboss.jandex.IndexView index,
                                     org.jboss.jandex.ClassInfo resourceClassInfo)

ResourceDocumentationGatherer

public ResourceDocumentationGatherer(org.apache.maven.plugin.logging.Log log,
                                     String name,
                                     DocumentationRegistry registry,
                                     org.jboss.jandex.IndexView index,
                                     org.jboss.jandex.ClassInfo resourceClassInfo)

Method Detail

gather

public void gather()

Specified by:

gather in class DocumentationGatherer

process

protected void process(org.jboss.jandex.ClassInfo current,
                       boolean isRootFraction)

process

protected void process(org.jboss.jandex.FieldInfo field,
                       boolean isRootFraction)