Comment to binding-generator source code (partially) + bug fixing

[yangtools.git] / code-generator / binding-generator-api / src / main / java / org / opendaylight / yangtools / sal / binding / generator / api / BindingGenerator.java

diff --git a/code-generator/binding-generator-api/src/main/java/org/opendaylight/yangtools/sal/binding/generator/api/BindingGenerator.java b/code-generator/binding-generator-api/src/main/java/org/opendaylight/yangtools/sal/binding/generator/api/BindingGenerator.java
index 9ef4ccde2f0437c2f70ab4725dc5479e57e27686..83764119a13a6a3957a4dff2a1cc6e4a787d4a97 100644 (file)
--- a/code-generator/binding-generator-api/src/main/java/org/opendaylight/yangtools/sal/binding/generator/api/BindingGenerator.java
+++ b/code-generator/binding-generator-api/src/main/java/org/opendaylight/yangtools/sal/binding/generator/api/BindingGenerator.java
@@ -1,53 +1,53 @@
-/*\r
- * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
- *\r
- * This program and the accompanying materials are made available under the\r
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
- * and is available at http://www.eclipse.org/legal/epl-v10.html\r
- */\r
-package org.opendaylight.yangtools.sal.binding.generator.api;\r
-\r
-import java.util.List;\r
-import java.util.Set;\r
-\r
-import org.opendaylight.yangtools.sal.binding.model.api.Type;\r
-import org.opendaylight.yangtools.yang.model.api.Module;\r
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;\r
-\r
-/**\r
- *\r
- *\r
- */\r
-public interface BindingGenerator {\r
-\r
-    /**\r
-     * Generate Types from whole Schema Context.\r
-     * <br>\r
-     * The method will return List of All Generated Types that could be\r
-     * Generated from Schema Context.\r
-     *\r
-     *\r
-     * @param context Schema Context\r
-     * @return List of Generated Types\r
-     *\r
-     * @see SchemaContext\r
-     */\r
-    public List<Type> generateTypes(final SchemaContext context);\r
-\r
-    /**\r
-     * Generate Types from Schema Context restricted by sub set of specified\r
-     * Modules. The Schema Context MUST contain all of the sub modules\r
-     * otherwise the there is no guarantee that result List of Generated\r
-     * Types will contain correct Generated Types.\r
-     *\r
-     * @param context Schema Context\r
-     * @param modules Sub Set of Modules\r
-     * @return List of Generated Types restricted by sub set of Modules\r
-     *\r
-     * @see Module\r
-     * @see SchemaContext\r
-     *\r
-     */\r
-    public List<Type> generateTypes(final SchemaContext context,\r
-                                    final Set<Module> modules);\r
-}\r
+/*
+ * Copyright (c) 2013 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.yangtools.sal.binding.generator.api;
+
+import java.util.List;
+import java.util.Set;
+
+import org.opendaylight.yangtools.sal.binding.model.api.Type;
+import org.opendaylight.yangtools.yang.model.api.Module;
+import org.opendaylight.yangtools.yang.model.api.SchemaContext;
+
+/**
+ * Transform Schema Context to Generated types.
+ *
+ */
+public interface BindingGenerator {
+
+    /**
+     * Generate Types from whole Schema Context.
+     * <br>
+     * The method will return List of All Generated Types that could be
+     * Generated from Schema Context.
+     *
+     *
+     * @param context Schema Context
+     * @return List of Generated Types
+     *
+     * @see SchemaContext
+     */
+    public List<Type> generateTypes(final SchemaContext context);
+
+    /**
+     * Generate Types from Schema Context restricted by sub set of specified
+     * Modules. The Schema Context MUST contain all of the sub modules
+     * otherwise the there is no guarantee that result List of Generated
+     * Types will contain correct Generated Types.
+     *
+     * @param context Schema Context
+     * @param modules Sub Set of Modules
+     * @return List of Generated Types restricted by sub set of Modules
+     *
+     * @see Module
+     * @see SchemaContext
+     *
+     */
+    public List<Type> generateTypes(final SchemaContext context,
+                                    final Set<Module> modules);
+}