Enable checkstyle rule to enforce package-info.java files
Change-Id: If837601380e4950b46ad1332bd3c20ef59cc216e
diff --git a/apps/igmp/src/main/java/org/onosproject/igmp/impl/package-info.java b/apps/igmp/src/main/java/org/onosproject/igmp/impl/package-info.java
new file mode 100644
index 0000000..7d42019
--- /dev/null
+++ b/apps/igmp/src/main/java/org/onosproject/igmp/impl/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * IGMP implementation.
+ */
+package org.onosproject.igmp.impl;
diff --git a/apps/mfwd/src/main/java/org/onosproject/mfwd/rest/package-info.java b/apps/mfwd/src/main/java/org/onosproject/mfwd/rest/package-info.java
new file mode 100644
index 0000000..b42586f
--- /dev/null
+++ b/apps/mfwd/src/main/java/org/onosproject/mfwd/rest/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * REST API for multicase forwarding.
+ */
+package org.onosproject.mfwd.rest;
diff --git a/apps/mlb/src/main/java/org/onosproject/mlb/package-info.java b/apps/mlb/src/main/java/org/onosproject/mlb/package-info.java
new file mode 100644
index 0000000..a7d8375
--- /dev/null
+++ b/apps/mlb/src/main/java/org/onosproject/mlb/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Mastership load balancer.
+ */
+package org.onosproject.mlb;
diff --git a/apps/openstackswitching/src/main/java/org/onosproject/openstackswitching/package-info.java b/apps/openstackswitching/src/main/java/org/onosproject/openstackswitching/package-info.java
new file mode 100644
index 0000000..cd50f91
--- /dev/null
+++ b/apps/openstackswitching/src/main/java/org/onosproject/openstackswitching/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * OpenStack switch interface.
+ */
+package org.onosproject.openstackswitching;
diff --git a/apps/openstackswitching/src/main/java/org/onosproject/openstackswitching/web/package-info.java b/apps/openstackswitching/src/main/java/org/onosproject/openstackswitching/web/package-info.java
new file mode 100644
index 0000000..91e19c6
--- /dev/null
+++ b/apps/openstackswitching/src/main/java/org/onosproject/openstackswitching/web/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * OpenStack switching REST API.
+ */
+package org.onosproject.openstackswitching.web;
diff --git a/core/api/src/main/java/org/onosproject/persistence/package-info.java b/core/api/src/main/java/org/onosproject/persistence/package-info.java
new file mode 100644
index 0000000..6e11a5e
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/persistence/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Persistence service and builders.
+ */
+package org.onosproject.persistence;
diff --git a/core/store/persistence/src/main/java/org/onosproject/persistence/impl/package-info.java b/core/store/persistence/src/main/java/org/onosproject/persistence/impl/package-info.java
new file mode 100644
index 0000000..968a504
--- /dev/null
+++ b/core/store/persistence/src/main/java/org/onosproject/persistence/impl/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Implementations of core persistence classes.
+ */
+package org.onosproject.persistence.impl;
diff --git a/incubator/api/src/main/java/org/onosproject/incubator/net/intf/package-info.java b/incubator/api/src/main/java/org/onosproject/incubator/net/intf/package-info.java
new file mode 100644
index 0000000..6cea24d
--- /dev/null
+++ b/incubator/api/src/main/java/org/onosproject/incubator/net/intf/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Interface Service.
+ */
+package org.onosproject.incubator.net.intf;
diff --git a/netconf/api/src/main/java/org/onosproject/netconf/package-info.java b/netconf/api/src/main/java/org/onosproject/netconf/package-info.java
new file mode 100644
index 0000000..5562bd3
--- /dev/null
+++ b/netconf/api/src/main/java/org/onosproject/netconf/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Created by ray on 10/30/15.
+ */
+package org.onosproject.netconf;
diff --git a/netconf/ctl/src/main/java/org/onosproject/netconf/ctl/package-info.java b/netconf/ctl/src/main/java/org/onosproject/netconf/ctl/package-info.java
new file mode 100644
index 0000000..84992bf
--- /dev/null
+++ b/netconf/ctl/src/main/java/org/onosproject/netconf/ctl/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Created by ray on 10/30/15.
+ */
+package org.onosproject.netconf.ctl;
diff --git a/netconf/rfc/src/main/java/org/onosproject/netconf/rfc/package-info.java b/netconf/rfc/src/main/java/org/onosproject/netconf/rfc/package-info.java
new file mode 100644
index 0000000..616a7ce
--- /dev/null
+++ b/netconf/rfc/src/main/java/org/onosproject/netconf/rfc/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Created by ray on 10/30/15.
+ */
+package org.onosproject.netconf.rfc;
diff --git a/pom.xml b/pom.xml
index b9fdfe2..4686e3f 100644
--- a/pom.xml
+++ b/pom.xml
@@ -58,6 +58,7 @@
<module>tools/package/archetypes</module>
<module>tools/package/branding</module>
+ <module>tools/build/conf</module>
<module>bgp</module>
</modules>
@@ -79,7 +80,7 @@
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
- <onos-build-conf.version>1.0</onos-build-conf.version>
+ <onos-build-conf.version>1.1-SNAPSHOT</onos-build-conf.version>
<netty4.version>4.0.23.Final</netty4.version>
<copycat.version>0.5.0.onos</copycat.version>
<openflowj.version>0.9.0.onos</openflowj.version>
diff --git a/tools/build/conf/pom.xml b/tools/build/conf/pom.xml
index 29e4dea..d56168f 100644
--- a/tools/build/conf/pom.xml
+++ b/tools/build/conf/pom.xml
@@ -27,7 +27,7 @@
<groupId>org.onosproject</groupId>
<artifactId>onos-build-conf</artifactId>
- <version>1.1</version>
+ <version>1.1-SNAPSHOT</version>
<description>Various ONOS build settings</description>
<properties>
diff --git a/tools/build/conf/src/main/resources/onos/checkstyle.xml b/tools/build/conf/src/main/resources/onos/checkstyle.xml
index 1bb3b0b..e04479c 100644
--- a/tools/build/conf/src/main/resources/onos/checkstyle.xml
+++ b/tools/build/conf/src/main/resources/onos/checkstyle.xml
@@ -67,9 +67,7 @@
-->
<!-- Checks that a package-info.java file exists for each package. -->
<!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
- <!-- ONOS does not currently supply package level Javadoc information
- in package-info files -->
- <!-- <module name="JavadocPackage"/> -->
+ <module name="JavadocPackage"/>
<!-- Checks whether files end with a new line. -->
<!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
diff --git a/tools/build/conf/src/main/resources/onos/suppressions.xml b/tools/build/conf/src/main/resources/onos/suppressions.xml
index a71d941..6d8f198 100644
--- a/tools/build/conf/src/main/resources/onos/suppressions.xml
+++ b/tools/build/conf/src/main/resources/onos/suppressions.xml
@@ -29,4 +29,12 @@
<suppress files=".*" checks="HiddenField"/>
<suppress files=".java" checks="NewlineAtEndOfFile"/>
+ <!-- Suppressions for unit testing code -->
+ <suppress checks="JavadocPackage"
+ files=".*/src/test/.*.java"
+ />
+
+ <suppress checks="JavadocPackage"
+ files=".*/thirdparty/.*.java"/>
+
</suppressions>