Fixing javadocs.
Change-Id: Ifc894fce6366baf6cfed655b4bfc5885710be77c
diff --git a/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/PolicyHandler.java b/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/PolicyHandler.java
index 5913e5b..5ff8db9 100644
--- a/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/PolicyHandler.java
+++ b/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/PolicyHandler.java
@@ -39,12 +39,15 @@
protected final Logger log = getLogger(getClass());
+ // FIXME: references to manager components should be avoided
private final SegmentRoutingManager srManager;
private final EventuallyConsistentMap<String, Policy> policyStore;
/**
* Creates a reference.
- * @param policyStore
+ *
+ * @param srManager segment routing manager
+ * @param policyStore policy store
*/
public PolicyHandler(SegmentRoutingManager srManager,
EventuallyConsistentMap<String, Policy> policyStore) {
diff --git a/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/Tunnel.java b/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/Tunnel.java
index c56ae70..783d253 100644
--- a/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/Tunnel.java
+++ b/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/Tunnel.java
@@ -47,6 +47,7 @@
/**
* Sets group ID for the tunnel.
*
+ * @param groupId group identifier
*/
void setGroupId(int groupId);
diff --git a/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/TunnelHandler.java b/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/TunnelHandler.java
index 1c07093..2405fa6 100644
--- a/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/TunnelHandler.java
+++ b/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/TunnelHandler.java
@@ -50,6 +50,7 @@
* Creates a tunnel.
*
* @param tunnel tunnel reference to create a tunnel
+ * @return true if creation succeeded
*/
public boolean createTunnel(Tunnel tunnel) {
diff --git a/core/api/src/main/java/org/onosproject/net/resource/device/package-info.java b/core/api/src/main/java/org/onosproject/net/resource/device/package-info.java
new file mode 100644
index 0000000..3ced37d
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/net/resource/device/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.
+ */
+
+/**
+ * Services for reserving devices as network resources.
+ */
+package org.onosproject.net.resource.device;
diff --git a/core/api/src/main/java/org/onosproject/net/resource/link/package-info.java b/core/api/src/main/java/org/onosproject/net/resource/link/package-info.java
new file mode 100644
index 0000000..b10e4ba
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/net/resource/link/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+/**
+ * Services for reserving links and their capacity as network resources,
+ * e.g. bandwidth, lambdas.
+ */
+package org.onosproject.net.resource.link;
diff --git a/core/api/src/main/java/org/onosproject/net/resource/package-info.java b/core/api/src/main/java/org/onosproject/net/resource/package-info.java
index a9b6035..e676fc8 100644
--- a/core/api/src/main/java/org/onosproject/net/resource/package-info.java
+++ b/core/api/src/main/java/org/onosproject/net/resource/package-info.java
@@ -15,6 +15,6 @@
*/
/**
- * Services for reserving network resources, e.g. bandwidth, lambdas.
+ * Abstractions for reserving network resources.
*/
package org.onosproject.net.resource;
diff --git a/docs/pom.xml b/docs/pom.xml
index 62d76cd..dc523ed 100644
--- a/docs/pom.xml
+++ b/docs/pom.xml
@@ -79,7 +79,7 @@
<group>
<title>Incubator for Core Subsystems & Distributed Stores</title>
<packages>
- org.onosproject.incubator.net.impl:org.onosproject.incubator.store.impl
+ org.onosproject.incubator.net.impl:org.onosproject.incubator.store.impl:org.onosproject.incubator.net.resource.label.impl:org.onosproject.incubator.store.resource.impl:org.onosproject.incubator.net.tunnel.impl:org.onosproject.incubator.store.tunnel.impl
</packages>
</group>
<group>
diff --git a/incubator/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResource.java b/incubator/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResource.java
index 612240f..36d3111 100644
--- a/incubator/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResource.java
+++ b/incubator/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResource.java
@@ -16,8 +16,9 @@
DeviceId deviceId();
/**
- * Returns labelResource Id.
- * @return LabelResourceId
+ * Returns label resource identifier.
+ *
+ * @return resource id
*/
LabelResourceId labelResourceId();
}
diff --git a/incubator/api/src/main/java/org/onosproject/incubator/net/resource/label/package-info.java b/incubator/api/src/main/java/org/onosproject/incubator/net/resource/label/package-info.java
new file mode 100644
index 0000000..9df466e
--- /dev/null
+++ b/incubator/api/src/main/java/org/onosproject/incubator/net/resource/label/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.
+ */
+
+/**
+ * Service for reserving labels as network resources.
+ */
+package org.onosproject.incubator.net.resource.label;
\ No newline at end of file
diff --git a/incubator/net/src/main/java/org/onosproject/incubator/net/resource/label/impl/package-info.java b/incubator/net/src/main/java/org/onosproject/incubator/net/resource/label/impl/package-info.java
new file mode 100644
index 0000000..afd31b4
--- /dev/null
+++ b/incubator/net/src/main/java/org/onosproject/incubator/net/resource/label/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.
+ */
+
+/**
+ * Implementation of the label resource subsystem.
+ */
+package org.onosproject.incubator.net.resource.label.impl;
\ No newline at end of file
diff --git a/incubator/store/src/main/java/org/onosproject/incubator/store/resource/impl/package-info.java b/incubator/store/src/main/java/org/onosproject/incubator/store/resource/impl/package-info.java
new file mode 100644
index 0000000..da0dc2e
--- /dev/null
+++ b/incubator/store/src/main/java/org/onosproject/incubator/store/resource/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.
+ */
+
+/**
+ * Implementation of the label resource distributed store.
+ */
+package org.onosproject.incubator.store.resource.impl;
\ No newline at end of file