org.coursera.courier.lang

Class DocEscaping

java.lang.Object

org.coursera.courier.lang.DocEscaping

public class DocEscaping
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DocEscaping()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	stringToDocComment(java.lang.String doc, DocCommentStyle style) Returns a doc comment, as a string of source, for the given documentation string and deprecated property.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocEscaping

public DocEscaping()

Method Detail

stringToDocComment

public static java.lang.String stringToDocComment(java.lang.String doc,
                                                  DocCommentStyle style)

Returns a doc comment, as a string of source, for the given documentation string and deprecated property.

Parameters:

doc - provides the schemadoc for the symbol, if any. May be null.

Returns:

an escaped schemadoc string.