Fixing javadocs and adding missing package javadocs.

Also marked a few packages and classes as deprecated.

Change-Id: I8629ad001f218f92c35721daa3b7c0ebe0916c27

@@ -15,6 +15,6 @@
  */
  */
 
 
 /**
 /**
- * Trivial application that provides simple form of reactive forwarding.
+ * Sample application that provides simple form of reactive forwarding.
  */
  */
 package org.onlab.onos.fwd;
 package org.onlab.onos.fwd;

@@ -15,7 +15,7 @@
  */
  */
 
 
 /**
 /**
- * Trivial application that provides simple form of reactive forwarding
+ * Sample application that provides simple form of reactive forwarding
  * using the intent service.
  * using the intent service.
  */
  */
 package org.onlab.onos.ifwd;
 package org.onlab.onos.ifwd;

+/*
+ * Copyright 2014 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.
+ */
+
+/**
+ * Intent metrics command-line handlers.
+ */
+package org.onlab.onos.metrics.intent.cli;
\ No newline at end of file

+/*
+ * Copyright 2014 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.
+ */
+
+/**
+ * Topology metrics command-line handlers.
+ */
+package org.onlab.onos.metrics.topology.cli;
\ No newline at end of file

@@ -15,6 +15,6 @@
  */
  */
 
 
 /**
 /**
- * Trivial application that provides simple form of reactive forwarding.
+ * Sample application that provides simple form of end-station host mobility.
  */
  */
 package org.onlab.onos.mobility;
 package org.onlab.onos.mobility;

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * See the License for the specific language governing permissions and
  * limitations under the License.
  * limitations under the License.
  */
  */
-package org.onlab.onos.optical.provisioner;
+package org.onlab.onos.optical;
 
 
 import java.util.ArrayList;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.HashMap;

@@ -58,7 +58,7 @@ import static org.onlab.onos.net.DeviceId.deviceId;
  * operations.
  * operations.
  *
  *
  */
  */
-
+@Deprecated
 @JsonIgnoreProperties(ignoreUnknown = true)
 @JsonIgnoreProperties(ignoreUnknown = true)
 //@Component(immediate = true)
 //@Component(immediate = true)
 public class OpticalConfigProvider extends AbstractProvider implements DeviceProvider, LinkProvider {
 public class OpticalConfigProvider extends AbstractProvider implements DeviceProvider, LinkProvider {

@@ -22,6 +22,7 @@ import org.onlab.util.HexString;
 /**
 /**
  * Public class corresponding to JSON described data model.
  * Public class corresponding to JSON described data model.
  */
  */
+@Deprecated
 public class OpticalLinkDescription {
 public class OpticalLinkDescription {
     protected String type;
     protected String type;
     protected Boolean allowed;
     protected Boolean allowed;

@@ -24,6 +24,7 @@ import org.slf4j.LoggerFactory;
 /**
 /**
  * Public class corresponding to JSON described data model.
  * Public class corresponding to JSON described data model.
  */
  */
+@Deprecated
 public class OpticalNetworkConfig {
 public class OpticalNetworkConfig {
     protected static final Logger log = LoggerFactory.getLogger(OpticalNetworkConfig.class);
     protected static final Logger log = LoggerFactory.getLogger(OpticalNetworkConfig.class);
 
 

@@ -23,6 +23,7 @@ import org.onlab.util.HexString;
 /**
 /**
  * Public class corresponding to JSON described data model.
  * Public class corresponding to JSON described data model.
  */
  */
+@Deprecated
 public class OpticalSwitchDescription {
 public class OpticalSwitchDescription {
     protected String name;
     protected String name;
     protected long dpid;
     protected long dpid;

@@ -18,6 +18,7 @@ package org.onlab.onos.optical.cfg;
 /**
 /**
  * Packet-optical link Java data object.
  * Packet-optical link Java data object.
  */
  */
+@Deprecated
 class PktOptLink {
 class PktOptLink {
     private String srcNodeName;
     private String srcNodeName;
     private String snkNodeName;
     private String snkNodeName;

@@ -18,6 +18,7 @@ package org.onlab.onos.optical.cfg;
 /**
 /**
  * ROADM java data object converted from a JSON file.
  * ROADM java data object converted from a JSON file.
  */
  */
+@Deprecated
 class Roadm {
 class Roadm {
     private String name;
     private String name;
     private String nodeID;
     private String nodeID;

@@ -18,6 +18,7 @@ package org.onlab.onos.optical.cfg;
 /**
 /**
  * WDM Link Java data object converted from a JSON file.
  * WDM Link Java data object converted from a JSON file.
  */
  */
+@Deprecated
 class WdmLink {
 class WdmLink {
     private String srcNodeName;
     private String srcNodeName;
     private String snkNodeName;
     private String snkNodeName;

+/*
+ * Copyright 2014 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.
+ */
+
+/**
+ * Packet/Optical configuration.
+ */
+@Deprecated
+package org.onlab.onos.optical.cfg;
\ No newline at end of file

+/*
+ * Copyright 2014 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.
+ */
+
+/**
+ * Packet/Optical application.
+ */
+package org.onlab.onos.optical;
\ No newline at end of file

+/*
+ * Copyright 2014 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.
+ */
+
+/**
+ * Packet/Optical sample forwarding applications.
+ */
+package org.onlab.onos.optical.testapp;
\ No newline at end of file

+/*
+ * Copyright 2014 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.
+ */
+
+/**
+ * SDN-IP command-line handlers.
+ */
+package org.onlab.onos.sdnip.cli;
\ No newline at end of file

@@ -94,13 +94,15 @@ public interface Link extends Annotated, Provided, NetworkResource {
 
 
     /**
     /**
      * Returns the link state.
      * Returns the link state.
+     *
+     * @return link state
      */
      */
     State state();
     State state();
 
 
     /**
     /**
      * Indicates if the link is to be considered durable.
      * Indicates if the link is to be considered durable.
      *
      *
-     * @return link state
+     * @return true if the link is durable
      */
      */
     boolean isDurable();
     boolean isDurable();
 
 

@@ -92,7 +92,7 @@
                         <group>
                         <group>
                             <title>Sample Applications</title>
                             <title>Sample Applications</title>
                             <packages>
                             <packages>
-                                org.onlab.onos.tvue:org.onlab.onos.fwd:org.onlab.onos.ifwd:org.onlab.onos.mobility:org.onlab.onos.proxyarp:org.onlab.onos.foo:org.onlab.onos.calendar:org.onlab.onos.optical.*:org.onlab.onos.sdnip:org.onlab.onos.sdnip.*:org.onlab.onos.config
+                                org.onlab.onos.tvue:org.onlab.onos.fwd:org.onlab.onos.ifwd:org.onlab.onos.mobility:org.onlab.onos.proxyarp:org.onlab.onos.foo:org.onlab.onos.calendar:org.onlab.onos.optical:org.onlab.onos.optical.*:org.onlab.onos.sdnip:org.onlab.onos.sdnip.*:org.onlab.onos.config
                             </packages>
                             </packages>
                         </group>
                         </group>
                         <group>
                         <group>