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

Interface DocumentedType

All Known Subinterfaces:
Enumeration, GeneratedTransferObject, GeneratedType
public interface DocumentedType
Implementing this interface allows an object to hold information which are essential for generating java doc from type definition.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Returns a string that contains a human-readable textual description of type definition.
    String
    getModuleName()
    Returns the name of the module, in which generated type was specified.
    String
    getReference()
    Returns a string that is used to specify a textual cross-reference to an external document, either another module that defines related management information, or a document that provides additional information relevant to this definition.

  • Method Details

    • getDescription

      String getDescription()
      Returns a string that contains a human-readable textual description of type definition.
      Returns:
      a human-readable textual description of type definition.

    • getReference

      String getReference()
      Returns a string that is used to specify a textual cross-reference to an external document, either another module that defines related management information, or a document that provides additional information relevant to this definition.
      Returns:
      a textual cross-reference to an external document.

    • getModuleName

      String getModuleName()
      Returns the name of the module, in which generated type was specified.
      Returns:
      the name of the module, in which generated type was specified.