MDSAL-301: Binding v2 - Rework javadoc generation

[mdsal.git] / binding2 / mdsal-binding2-generator-api / src / main / java / org / opendaylight / mdsal / binding / javav2 / model / api / TypeComment.java

diff --git a/binding2/mdsal-binding2-generator-api/src/main/java/org/opendaylight/mdsal/binding/javav2/model/api/TypeComment.java b/binding2/mdsal-binding2-generator-api/src/main/java/org/opendaylight/mdsal/binding/javav2/model/api/TypeComment.java
new file mode 100644 (file)
index 0000000..d292f29
--- /dev/null
+++ b/binding2/mdsal-binding2-generator-api/src/main/java/org/opendaylight/mdsal/binding/javav2/model/api/TypeComment.java
@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2018 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.mdsal.binding.javav2.model.api;
+
+import com.google.common.annotations.Beta;
+import org.eclipse.jdt.annotation.NonNullByDefault;
+
+/**
+ * Dedicated type for holding a class comment. It exposes a javadoc-encoded string.
+ *
+ * @author Robert Varga
+ */
+@Beta
+@FunctionalInterface
+@NonNullByDefault
+public interface TypeComment {
+
+    /**
+     * Return a javadoc snippet. This snippet is guaranteed to be safe for direct inclusion in a Java block comment.
+     *
+     * @return Javadoc snippet.
+     */
+    String getJavadoc();
+}