software.amazon.smithy.codegen.core.writer

Class JavaStyleDocumentationWriterBuilder

java.lang.Object

software.amazon.smithy.codegen.core.writer.JavaStyleDocumentationWriterBuilder

Deprecated.

this class uses CodeWriter, which is deprecated.

@Deprecated
public final class JavaStyleDocumentationWriterBuilder
extends java.lang.Object

A builder used to create a DocumentationWriter for Java style documentation comments.

Documentation comments are automatically sanitized by escaping a closing documentation comment (i.e., star (*) followed by a forward slash (/)). This should also work for JavaScript, PHP, and other languages that use Java-style comments.

Constructor Summary

Constructors

Constructor and Description
JavaStyleDocumentationWriterBuilder() Deprecated.

Method Summary

Modifier and Type	Method and Description
<T extends CodeWriter> DocumentationWriter<T>	build() Deprecated. Creates a DocumentationWriter configured by the builder.
JavaStyleDocumentationWriterBuilder	escapeAtSignWithEntity(boolean escapeAtSignWithEntity) Deprecated. Sets whether or not the "@" sign is escaped with an HTML entity.
static java.lang.String	escapeAtSignWithEntity(java.lang.String contents) Deprecated. A function used to escape the @ sign of a documentation comment with an HTML entity of &#064;.
static java.lang.String	escapeClosingChars(java.lang.String contents) Deprecated. A function used to escape the closing tokens of a documentation comment.
JavaStyleDocumentationWriterBuilder	mappingFunction(java.util.function.Function<java.lang.String,java.lang.String> mappingFunction) Deprecated. Sets a custom mapping function to use when filtering documentation.
JavaStyleDocumentationWriterBuilder	namedDocumentationSection(java.lang.String namedDocumentationSection) Deprecated. Sets a specific named section to use when writing documentation.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaStyleDocumentationWriterBuilder

public JavaStyleDocumentationWriterBuilder()

Deprecated.

Method Detail

escapeClosingChars

public static java.lang.String escapeClosingChars(java.lang.String contents)

Deprecated.

A function used to escape the closing tokens of a documentation comment.

Parameters:

contents - Contents to sanitize.

Returns:

Returns the sanitized contents.

escapeAtSignWithEntity

public static java.lang.String escapeAtSignWithEntity(java.lang.String contents)

Deprecated.

A function used to escape the @ sign of a documentation comment with an HTML entity of @.

Parameters:

contents - Contents to sanitize.

Returns:

Returns the sanitized contents.

build

public <T extends CodeWriter> DocumentationWriter<T> build()

Deprecated.

Creates a DocumentationWriter configured by the builder.

Type Parameters:

T - The type of writer to create.

Returns:

Returns the created documentation writer.

namedDocumentationSection

public JavaStyleDocumentationWriterBuilder namedDocumentationSection(java.lang.String namedDocumentationSection)

Deprecated.

Sets a specific named section to use when writing documentation.

Parameters:

namedDocumentationSection - The name of the state's section to use.

Returns:

Returns the builder.

mappingFunction

public JavaStyleDocumentationWriterBuilder mappingFunction(java.util.function.Function<java.lang.String,java.lang.String> mappingFunction)

Deprecated.

Sets a custom mapping function to use when filtering documentation.

Setting a custom mapping function will disable the default mapping function that is used to escape the closing tokens of a block comment. However, other mapping functions will still compose with a custom mapping function if provided (e.g., escaping @ symbols via escapeAtSignWithEntity(boolean) still compose with a custom mapping function).

Parameters:

mappingFunction - Mapping function to use. Set to null to use the default.

Returns:

Returns the builder.

escapeAtSignWithEntity

public JavaStyleDocumentationWriterBuilder escapeAtSignWithEntity(boolean escapeAtSignWithEntity)

Deprecated.

Sets whether or not the "@" sign is escaped with an HTML entity.

At signs are not escaped by default.

Parameters:

escapeAtSignWithEntity - Set to true to escape, false to not.

Returns:

Returns the builder.