From dda610132e5af0a12b18264d7e4495eea4d0f1c3 Mon Sep 17 00:00:00 2001 From: Peter Kajsa Date: Wed, 12 Apr 2017 10:27:57 +0200 Subject: [PATCH] Bug 7050 - Document parser-impl package structure Added initial javadoc to yang statement parser packages. Change-Id: I2f18eb4ad01fee297f52953f2ef2aae24a69d253 Signed-off-by: Peter Kajsa --- .../yang/parser/spi/meta/package-info.java | 12 ++++++++ .../yang/parser/spi/package-info.java | 15 ++++++++++ .../yang/parser/spi/source/package-info.java | 12 ++++++++ .../parser/spi/validation/package-info.java | 17 +++++++++++ .../parser/stmt/reactor/package-info.java | 30 +++++++++++++++++++ .../stmt/rfc6020/effective/package-info.java | 14 +++++++++ .../parser/stmt/rfc6020/package-info.java | 15 ++++++++++ .../stmt/rfc7950/effective/package-info.java | 12 ++++++++ .../parser/stmt/rfc7950/package-info.java | 13 ++++++++ 9 files changed, 140 insertions(+) create mode 100644 yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/package-info.java create mode 100644 yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/package-info.java create mode 100644 yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/source/package-info.java create mode 100644 yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/validation/package-info.java create mode 100644 yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/package-info.java create mode 100644 yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/effective/package-info.java create mode 100644 yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/package-info.java create mode 100644 yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc7950/effective/package-info.java create mode 100644 yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc7950/package-info.java 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 index 0000000000..439a35b3b6 --- /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 index 0000000000..32ecb14f44 --- /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 index 0000000000..1ba9498445 --- /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 index 0000000000..1d13f8f85c --- /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 index 0000000000..f727e3082b --- /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}. + * + *

+ * 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. + * + *

+ * This package also contains: + *

+ * + */ +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 index 0000000000..12cb041002 --- /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 index 0000000000..31c0c78939 --- /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 index 0000000000..627fb4133d --- /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 index 0000000000..bafb852737 --- /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 -- 2.36.6