Package org.apache.camel.maven.packaging.generics

Class JavadocUtil

java.lang.Object

org.apache.camel.maven.packaging.generics.JavadocUtil

public final class JavadocUtil
extends Object

Method Summary

Modifier and Type	Method	Description
static String	extractJavaDoc(String sourceCode, org.jboss.forge.roaster.model.source.MethodSource<?> ms)
static String	getMainDescription(org.apache.camel.tooling.model.ComponentModel model)
static String	getMainDescription(org.apache.camel.tooling.model.ComponentModel model, boolean withPathParameterDetails)
static String	pathParameterJavaDoc(org.apache.camel.tooling.model.ComponentModel model)

Methods inherited from class java.lang.Object

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

Method Details

getMainDescription

public static String getMainDescription(org.apache.camel.tooling.model.ComponentModel model)

Parameters:

model - the model from which the information are extracted.

Returns:

the description of the given component with all the possible details.

getMainDescription

public static String getMainDescription(org.apache.camel.tooling.model.ComponentModel model,
 boolean withPathParameterDetails)

Parameters:

model - the model from which the information are extracted.

withPathParameterDetails - indicates whether the information about the path parameters should be added to the description.

Returns:

the description of the given component.

pathParameterJavaDoc

public static String pathParameterJavaDoc(org.apache.camel.tooling.model.ComponentModel model)

extractJavaDoc

public static String extractJavaDoc(String sourceCode,
 org.jboss.forge.roaster.model.source.MethodSource<?> ms)
                             throws IOException

Throws:

IOException