Thomas Vachuska
Committed by Gerrit Code Review

Fixing javadocs.

Change-Id: Ifc894fce6366baf6cfed655b4bfc5885710be77c
...@@ -39,12 +39,15 @@ public class PolicyHandler { ...@@ -39,12 +39,15 @@ public class PolicyHandler {
39 39
40 protected final Logger log = getLogger(getClass()); 40 protected final Logger log = getLogger(getClass());
41 41
42 + // FIXME: references to manager components should be avoided
42 private final SegmentRoutingManager srManager; 43 private final SegmentRoutingManager srManager;
43 private final EventuallyConsistentMap<String, Policy> policyStore; 44 private final EventuallyConsistentMap<String, Policy> policyStore;
44 45
45 /** 46 /**
46 * Creates a reference. 47 * Creates a reference.
47 - * @param policyStore 48 + *
49 + * @param srManager segment routing manager
50 + * @param policyStore policy store
48 */ 51 */
49 public PolicyHandler(SegmentRoutingManager srManager, 52 public PolicyHandler(SegmentRoutingManager srManager,
50 EventuallyConsistentMap<String, Policy> policyStore) { 53 EventuallyConsistentMap<String, Policy> policyStore) {
......
...@@ -47,6 +47,7 @@ public interface Tunnel { ...@@ -47,6 +47,7 @@ public interface Tunnel {
47 /** 47 /**
48 * Sets group ID for the tunnel. 48 * Sets group ID for the tunnel.
49 * 49 *
50 + * @param groupId group identifier
50 */ 51 */
51 void setGroupId(int groupId); 52 void setGroupId(int groupId);
52 53
......
...@@ -50,6 +50,7 @@ public class TunnelHandler { ...@@ -50,6 +50,7 @@ public class TunnelHandler {
50 * Creates a tunnel. 50 * Creates a tunnel.
51 * 51 *
52 * @param tunnel tunnel reference to create a tunnel 52 * @param tunnel tunnel reference to create a tunnel
53 + * @return true if creation succeeded
53 */ 54 */
54 public boolean createTunnel(Tunnel tunnel) { 55 public boolean createTunnel(Tunnel tunnel) {
55 56
......
1 +/*
2 + * Copyright 2015 Open Networking Laboratory
3 + *
4 + * Licensed under the Apache License, Version 2.0 (the "License");
5 + * you may not use this file except in compliance with the License.
6 + * You may obtain a copy of the License at
7 + *
8 + * http://www.apache.org/licenses/LICENSE-2.0
9 + *
10 + * Unless required by applicable law or agreed to in writing, software
11 + * distributed under the License is distributed on an "AS IS" BASIS,
12 + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 + * See the License for the specific language governing permissions and
14 + * limitations under the License.
15 + */
16 +
17 +/**
18 + * Services for reserving devices as network resources.
19 + */
20 +package org.onosproject.net.resource.device;
1 +/*
2 + * Copyright 2015 Open Networking Laboratory
3 + *
4 + * Licensed under the Apache License, Version 2.0 (the "License");
5 + * you may not use this file except in compliance with the License.
6 + * You may obtain a copy of the License at
7 + *
8 + * http://www.apache.org/licenses/LICENSE-2.0
9 + *
10 + * Unless required by applicable law or agreed to in writing, software
11 + * distributed under the License is distributed on an "AS IS" BASIS,
12 + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 + * See the License for the specific language governing permissions and
14 + * limitations under the License.
15 + */
16 +
17 +/**
18 + * Services for reserving links and their capacity as network resources,
19 + * e.g.&nbsp;bandwidth, lambdas.
20 + */
21 +package org.onosproject.net.resource.link;
...@@ -15,6 +15,6 @@ ...@@ -15,6 +15,6 @@
15 */ 15 */
16 16
17 /** 17 /**
18 - * Services for reserving network resources, e.g.&nbsp;bandwidth, lambdas. 18 + * Abstractions for reserving network resources.
19 */ 19 */
20 package org.onosproject.net.resource; 20 package org.onosproject.net.resource;
......
...@@ -79,7 +79,7 @@ ...@@ -79,7 +79,7 @@
79 <group> 79 <group>
80 <title>Incubator for Core Subsystems &amp; Distributed Stores</title> 80 <title>Incubator for Core Subsystems &amp; Distributed Stores</title>
81 <packages> 81 <packages>
82 - org.onosproject.incubator.net.impl:org.onosproject.incubator.store.impl 82 + 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
83 </packages> 83 </packages>
84 </group> 84 </group>
85 <group> 85 <group>
......
...@@ -16,8 +16,9 @@ public interface LabelResource extends Annotated, Provided, NetworkResource { ...@@ -16,8 +16,9 @@ public interface LabelResource extends Annotated, Provided, NetworkResource {
16 DeviceId deviceId(); 16 DeviceId deviceId();
17 17
18 /** 18 /**
19 - * Returns labelResource Id. 19 + * Returns label resource identifier.
20 - * @return LabelResourceId 20 + *
21 + * @return resource id
21 */ 22 */
22 LabelResourceId labelResourceId(); 23 LabelResourceId labelResourceId();
23 } 24 }
......
1 +/*
2 + * Copyright 2015 Open Networking Laboratory
3 + *
4 + * Licensed under the Apache License, Version 2.0 (the "License");
5 + * you may not use this file except in compliance with the License.
6 + * You may obtain a copy of the License at
7 + *
8 + * http://www.apache.org/licenses/LICENSE-2.0
9 + *
10 + * Unless required by applicable law or agreed to in writing, software
11 + * distributed under the License is distributed on an "AS IS" BASIS,
12 + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 + * See the License for the specific language governing permissions and
14 + * limitations under the License.
15 + */
16 +
17 +/**
18 + * Service for reserving labels as network resources.
19 + */
20 +package org.onosproject.incubator.net.resource.label;
...\ No newline at end of file ...\ No newline at end of file
1 +/*
2 + * Copyright 2015 Open Networking Laboratory
3 + *
4 + * Licensed under the Apache License, Version 2.0 (the "License");
5 + * you may not use this file except in compliance with the License.
6 + * You may obtain a copy of the License at
7 + *
8 + * http://www.apache.org/licenses/LICENSE-2.0
9 + *
10 + * Unless required by applicable law or agreed to in writing, software
11 + * distributed under the License is distributed on an "AS IS" BASIS,
12 + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 + * See the License for the specific language governing permissions and
14 + * limitations under the License.
15 + */
16 +
17 +/**
18 + * Implementation of the label resource subsystem.
19 + */
20 +package org.onosproject.incubator.net.resource.label.impl;
...\ No newline at end of file ...\ No newline at end of file
1 +/*
2 + * Copyright 2015 Open Networking Laboratory
3 + *
4 + * Licensed under the Apache License, Version 2.0 (the "License");
5 + * you may not use this file except in compliance with the License.
6 + * You may obtain a copy of the License at
7 + *
8 + * http://www.apache.org/licenses/LICENSE-2.0
9 + *
10 + * Unless required by applicable law or agreed to in writing, software
11 + * distributed under the License is distributed on an "AS IS" BASIS,
12 + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 + * See the License for the specific language governing permissions and
14 + * limitations under the License.
15 + */
16 +
17 +/**
18 + * Implementation of the label resource distributed store.
19 + */
20 +package org.onosproject.incubator.store.resource.impl;
...\ No newline at end of file ...\ No newline at end of file