2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.binding.model.api;
11 * Implementing this interface allows an object to hold information which are
12 * essential for generating java doc from type definition.
14 public interface DocumentedType {
16 * Returns a string that contains a human-readable textual description of
19 * @return a human-readable textual description of type definition.
21 String getDescription();
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
29 * @return a textual cross-reference to an external document.
31 String getReference();
34 * Returns the name of the module, in which generated type was specified.
36 * @return the name of the module, in which generated type was specified.
38 String getModuleName();