Module org.opendaylight.mdsal.binding.model.api
Package org.opendaylight.mdsal.binding.model.api

Interface TypeComment

All Superinterfaces:
org.opendaylight.yangtools.concepts.Immutable
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 extends org.opendaylight.yangtools.concepts.Immutable
Dedicated type for holding a class comment. It exposes a javadoc-encoded string.
Author:
Robert Varga

  • Method Summary

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

  • Method Details

    • 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.