binding/mdsal-binding-model-api/src/main/java/org/opendaylight/mdsal/binding/model/api/DocumentedType.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.mdsal.binding.model.api;
   9
  10 /**
  11  * Implementing this interface allows an object to hold information which are
  12  * essential for generating java doc from type definition.
  13  */
  14 public interface DocumentedType {
  15     /**
  16      * Returns a string that contains a human-readable textual description of
  17      * type definition.
  18      *
  19      * @return a human-readable textual description of type definition.
  20      */
  21     String getDescription();
  22
  23     /**
  24      * Returns a string that is used to specify a textual cross-reference to an
  25      * external document, either another module that defines related management
  26      * information, or a document that provides additional information relevant
  27      * to this definition.
  28      *
  29      * @return a textual cross-reference to an external document.
  30      */
  31     String getReference();
  32
  33     /**
  34      * Returns the name of the module, in which generated type was specified.
  35      *
  36      * @return the name of the module, in which generated type was specified.
  37      */
  38     String getModuleName();
  39 }