org.nuxeo.apidoc.documentation

Class DocumentationHelper

java.lang.Object

org.nuxeo.apidoc.documentation.DocumentationHelper

public class DocumentationHelper
extends Object

Helper to generate HTML for documentation strings.

Method Summary

Modifier and Type	Method and Description
static String	getHtml(String doc) Transforms Nuxeo extension point <documentation> content into HTML.
static String	secureXML(String xml) Makes sure no passwords are embedded in the XML.

Methods inherited from class java.lang.Object

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

Method Detail

getHtml

public static String getHtml(String doc)

Transforms Nuxeo extension point <documentation> content into HTML.

• standalone newlines are turned into <p/>
• <code> blocks are turned into a <div class="code"> with a <pre> <code>
• @author blocks are removed

secureXML

public static String secureXML(String xml)

Makes sure no passwords are embedded in the XML.