org.opendaylight.mdsal.binding.javav2.model.api

Interface TypeComment

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@Beta
 @FunctionalInterface
 @NonNullByDefault
public interface TypeComment

Dedicated type for holding a class comment. It exposes a javadoc-encoded string.

Author:

Robert Varga

Method Summary

Modifier and Type	Method and Description
String	getJavadoc() Return a javadoc snippet.

Method Detail

getJavadoc

String getJavadoc()

Return a javadoc snippet. This snippet is guaranteed to be safe for direct inclusion in a Java block comment.

Returns:

Javadoc snippet.