Package org.apache.camel.tooling.util

Class JavadocHelper

java.lang.Object

org.apache.camel.tooling.util.JavadocHelper

public final class JavadocHelper
extends Object

Method Summary

Modifier and Type	Method	Description
static String	sanitizeDescription(String javadoc, boolean summary)	Sanitizes the javadoc to removed invalid characters so it can be used as json description
static String	xmlEncode(String text)	Encodes the text into safe XML by replacing invalid input: '<' > and invalid input: '&' with XML tokens

Methods inherited from class java.lang.Object

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

Method Details

sanitizeDescription

public static String sanitizeDescription(String javadoc,
 boolean summary)

Sanitizes the javadoc to removed invalid characters so it can be used as json description

Parameters:

javadoc - the javadoc

Returns:

the text that is valid as json

xmlEncode

public static String xmlEncode(String text)

Encodes the text into safe XML by replacing invalid input: '<' > and invalid input: '&' with XML tokens

Parameters:

text - the text

Returns:

the encoded text