org.opendaylight.mdsal.binding.model.util

Class TypeComments

java.lang.Object

org.opendaylight.mdsal.binding.model.util.TypeComments

@Beta
 @NonNullByDefault
public final class TypeComments
extends Object

Utility methods for creating TypeComments.

Method Summary

Modifier and Type	Method and Description
static Optional<TypeComment>	description(org.opendaylight.yangtools.yang.model.api.DocumentedNode node) Create a TypeComment for a DocumentedNode's description string.
static Optional<TypeComment>	javadoc(String javadoc) Create a TypeComment for a javadoc-compliant text snippet.

Methods inherited from class java.lang.Object

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

Method Detail

javadoc

public static Optional<TypeComment> javadoc(String javadoc)

Create a TypeComment for a javadoc-compliant text snippet. This snippet must be eligible for direct inclusion in a Java comment without further escaping.

Parameters:

javadoc - Pre-formatted javadoc snippet

Returns:

TypeComment, or empty if the snippet was empty

description

public static Optional<TypeComment> description(org.opendaylight.yangtools.yang.model.api.DocumentedNode node)

Create a TypeComment for a DocumentedNode's description string.

Parameters:

node - Documented node containing the description to be processed

Returns:

TypeComment, or empty if the node's description was empty or non-present.