org.coursera.courier.swift

Class SwiftDocEscaping

java.lang.Object

org.coursera.courier.swift.SwiftDocEscaping

public class SwiftDocEscaping
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
SwiftDocEscaping()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	deprecatedToString(java.lang.Object deprecatedProp) Return a deprecated attribute, as a string of Swift source.
static java.lang.String	stringToDocComment(java.lang.String doc) Returns a doc comment, as a string of Swift source, for the given documentation string.

Methods inherited from class java.lang.Object

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

Constructor Detail

SwiftDocEscaping

public SwiftDocEscaping()

Method Detail

stringToDocComment

public static java.lang.String stringToDocComment(java.lang.String doc)

Returns a doc comment, as a string of Swift source, for the given documentation string.

Parameters:

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

Returns:

an escaped doc comment string.

deprecatedToString

public static java.lang.String deprecatedToString(java.lang.Object deprecatedProp)

Return a deprecated attribute, as a string of Swift source.

Parameters:

deprecatedProp - provides the deprecated Pegasus schema property, if any. May be a Boolean, a String, or null.

Returns:

a Swift property indicating that a type or field is deprecated.