Move binding.model.api documentation 86/109386/1
authorRobert Varga <robert.varga@pantheon.tech>
Tue, 19 Dec 2023 12:49:28 +0000 (13:49 +0100)
committerRobert Varga <robert.varga@pantheon.tech>
Tue, 19 Dec 2023 12:49:57 +0000 (13:49 +0100)
Package documentation resides in the wrong file, move it.

Change-Id: I77d1c5f3b411df7ebb855ccaeb6c7c8d9d1184cc
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
binding/mdsal-binding-model-api/src/main/java/org/opendaylight/mdsal/binding/model/api/package-info.java
binding/mdsal-binding-model-api/src/main/java/org/opendaylight/mdsal/binding/model/api/pkg-info.java [deleted file]

index 9af600c9562143ba0c67f2ccd783bed22b523f0c..26ee930515d4deeb8b012ce0d49020cca7e93869 100644 (file)
@@ -5,4 +5,23 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
+/**
+ * Model of Java classes generated from YANG. Some information on naming:
+ *
+ * <ul>
+ * <li>
+ * {@link Type} refers to a Java class, interface or primitive type. This is something that is used as the type
+ * specifier of a variable declaration.
+ * </li>
+ * <li>
+ * {@link GeneratedType} refers to a Java class or interface. It can either be a top-level or a nested class or
+ * interface.
+ * </li>
+ * <li>
+ * {@link GeneratedTransferObject} refers to {@link GeneratedType}, which is a concrete class. These are generated to
+ * encapsulate the YANG type hierarchy as expressed by 'typedef' and 'type' statement use. If it has a superclass, it is
+ * also referred to as an {@code Extended Type}.
+ * </li>
+ * </ul>
+ */
 package org.opendaylight.mdsal.binding.model.api;
\ No newline at end of file
diff --git a/binding/mdsal-binding-model-api/src/main/java/org/opendaylight/mdsal/binding/model/api/pkg-info.java b/binding/mdsal-binding-model-api/src/main/java/org/opendaylight/mdsal/binding/model/api/pkg-info.java
deleted file mode 100644 (file)
index 0b461e6..0000000
+++ /dev/null
@@ -1,27 +0,0 @@
-/*
- * Copyright (c) 2018 Pantheon Technologies, s.r.o. 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
- */
-/**
- * Model of Java classes generated from YANG. Some information on naming:
- *
- * <ul>
- * <li>
- * {@link Type} refers to a Java class, interface or primitive type. This is something that is used as the type
- * specifier of a variable declaration.
- * </li>
- * <li>
- * {@link GeneratedType} refers to a Java class or interface. It can either be a top-level or a nested class or
- * interface.
- * </li>
- * <li>
- * {@link GeneratedTransferObject} refers to {@link GeneratedType}, which is a concrete class. These are generated to
- * encapsulate the YANG type hierarchy as expressed by 'typedef' and 'type' statement use. If it has a superclass, it is
- * also referred to as an {@code Extended Type}.
- * </li>
- * </ul>
- */
-package org.opendaylight.mdsal.binding.model.api;