Bug 7050 - Document parser-impl package structure

Added initial javadoc to yang statement parser packages.

Change-Id: I2f18eb4ad01fee297f52953f2ef2aae24a69d253
Signed-off-by: Peter Kajsa <pkajsa@cisco.com>

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/package-info.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/package-info.java
new file mode 100644 (file)
index 0000000..439a35b
--- /dev/null
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/package-info.java
@@ -0,0 +1,12 @@
+/*
+ * Copyright (c) 2017 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
+ */
+
+/**
+ * Provides base abstract classes, interfaces and common implementation used by the statement parser.
+ */
+package org.opendaylight.yangtools.yang.parser.spi.meta;
\ No newline at end of file

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/package-info.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/package-info.java
new file mode 100644 (file)
index 0000000..32ecb14
--- /dev/null
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/package-info.java
@@ -0,0 +1,15 @@
+/*
+ * Copyright (c) 2017 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
+ */
+
+/**
+ * Provides essential namespaces which are filled in the parsing process. Currently this package
+ * contains interfaces which represent essential namespaces according to Rfc6020
+ * and Rfc7950 (for more details see the section 6.2.1. Identifiers and Their Namespaces
+ * in Rfc6020 and Rfc7950).
+ */
+package org.opendaylight.yangtools.yang.parser.spi;
\ No newline at end of file

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/source/package-info.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/source/package-info.java
new file mode 100644 (file)
index 0000000..1ba9498
--- /dev/null
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/source/package-info.java
@@ -0,0 +1,12 @@
+/*
+ * Copyright (c) 2017 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
+ */
+
+/**
+ * Provides API necessary for the processing of statement sources.
+ */
+package org.opendaylight.yangtools.yang.parser.spi.source;
\ No newline at end of file

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/validation/package-info.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/validation/package-info.java
new file mode 100644 (file)
index 0000000..1d13f8f
--- /dev/null
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/validation/package-info.java
@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2017 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
+ */
+
+/**
+ * Provides interfaces and enumerations necessary for validation processes.
+ * Currently, this package contains an interface which represents a namespace used
+ * by the validation process. This namespace contains different types of validation
+ * bundles or collections. Allowed types of validation bundles are defined by the
+ * enumeration {@link ValidationBundlesNamespace.ValidationBundleType} which is
+ * provided by this package.
+ */
+package org.opendaylight.yangtools.yang.parser.spi.validation;
\ No newline at end of file

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/package-info.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/package-info.java
new file mode 100644 (file)
index 0000000..f727e30
--- /dev/null
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/package-info.java
@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2017 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
+ */
+
+/**
+ * Contains the implementation of the parser reactor
+ * {@link org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor}.
+ *
+ * <p>
+ * Classes provided by this package are responsible for performing the essential parsing processes and building the
+ * schema context {@link org.opendaylight.yangtools.yang.model.api.SchemaContext} as the result of the parsing process.
+ *
+ * <p>
+ * This package also contains:
+ * </p>
+ * <ul>
+ * <li> implementation of statement context which provides the information necessary for creation of declared and
+ * effective statements</li>
+ * <li> custom statement parser builder
+ * {@link org.opendaylight.yangtools.yang.parser.stmt.reactor.CustomStatementParserBuilder} which provides methods and
+ *  implementation useful for building of custom statement parser</li>
+ * <li> entry point to the parsing process provided by the cross source statement reactor
+ * {@link org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor}</li>
+ * </ul>
+ */
+package org.opendaylight.yangtools.yang.parser.stmt.reactor;

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/effective/package-info.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/effective/package-info.java
new file mode 100644 (file)
index 0000000..12cb041
--- /dev/null
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/effective/package-info.java
@@ -0,0 +1,14 @@
+/*
+ * Copyright (c) 2017 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
+ */
+
+/**
+ * Contains implementation of Rfc6020 effective statements. This package
+ * may also contain common implementation for both Rfc6020 and Rfc7950 statements,
+ * if there are no or minimal differences between these statements.
+ */
+package org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective;
\ No newline at end of file

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/package-info.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/package-info.java
new file mode 100644 (file)
index 0000000..31c0c78
--- /dev/null
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/package-info.java
@@ -0,0 +1,15 @@
+/*
+ * Copyright (c) 2017 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
+ */
+
+/**
+ * Contains implementation of statement supports for Rfc6020 statements and
+ * implementation of declared statements. This package may also contain common
+ * implementation of statement supports and declared statements for both Rfc6020 and Rfc7950
+ * statements, if there are no or minimal differences between these statements.
+ */
+package org.opendaylight.yangtools.yang.parser.stmt.rfc6020;
\ No newline at end of file

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc7950/effective/package-info.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc7950/effective/package-info.java
new file mode 100644 (file)
index 0000000..627fb41
--- /dev/null
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc7950/effective/package-info.java
@@ -0,0 +1,12 @@
+/*
+ * Copyright (c) 2017 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
+ */
+
+/**
+ * Contains implementation of Rfc7950 effective statements.
+ */
+package org.opendaylight.yangtools.yang.parser.stmt.rfc7950.effective;
\ No newline at end of file

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc7950/package-info.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc7950/package-info.java
new file mode 100644 (file)
index 0000000..bafb852
--- /dev/null
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc7950/package-info.java
@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) 2017 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
+ */
+
+/**
+ * Contains implementation of statement supports for Rfc7950 statements
+ * and implementation of declared statements specific to Rfc7950.
+ */
+package org.opendaylight.yangtools.yang.parser.stmt.rfc7950;
\ No newline at end of file