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

   1 /*
   2  * Copyright (c) 2018 Pantheon Technologies, s.r.o. 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 import com.google.common.annotations.Beta;
  11 import org.eclipse.jdt.annotation.NonNullByDefault;
  12 import org.opendaylight.yangtools.concepts.Immutable;
  13
  14 /**
  15  * Dedicated type for holding a class comment. It exposes a javadoc-encoded string.
  16  *
  17  * @author Robert Varga
  18  */
  19 @Beta
  20 @FunctionalInterface
  21 @NonNullByDefault
  22 public interface TypeComment extends Immutable {
  23     /**
  24      * Return a javadoc snippet. This snippet is guaranteed to be safe for direct inclusion in a Java block comment.
  25      *
  26      * @return Javadoc snippet.
  27      */
  28     String getJavadoc();
  29 }