Added javadocs documentation for discovery API interfaces and classes

7 files changed, 16 insertions, 12 deletions

diff --git a/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IDiscoveryContainer.java b/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IDiscoveryContainer.java
index 0aca1e7d0..1559119c6 100644
--- a/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IDiscoveryContainer.java
+++ b/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IDiscoveryContainer.java
@@ -26,8 +26,6 @@ import org.eclipse.ecf.core.identity.ServiceID;
  * Clients can then proceed to use this interface to interact with the given
  * discovery implementation.
  * 
- * @author slewis
- *
  */
 public interface IDiscoveryContainer {
 	/**
diff --git a/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IServiceEvent.java b/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IServiceEvent.java
index bc2079956..61d321914 100644
--- a/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IServiceEvent.java
+++ b/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IServiceEvent.java
@@ -11,6 +11,9 @@ package org.eclipse.ecf.discovery;
 
 import org.eclipse.ecf.core.events.IContainerEvent;
 
+/**
+ * Service discovery event that provides access to IServiceInfo instance
+ */
 public interface IServiceEvent extends IContainerEvent {
 	/**
 	 * Get the service info associated with this event
diff --git a/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IServiceInfo.java b/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IServiceInfo.java
index 81bd5b615..5c7a608e5 100644
--- a/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IServiceInfo.java
+++ b/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IServiceInfo.java
@@ -16,11 +16,9 @@ import java.util.Map;
 
 import org.eclipse.ecf.core.identity.ServiceID;
 /**
- * Service information.  Defines the information associated
- * with a service
+ * Service information contrace.  Defines the information associated
+ * with a remotely discoverable service
  * 
- * @author slewis
- *
  */
 public interface IServiceInfo {
 	/**
diff --git a/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IServiceListener.java b/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IServiceListener.java
index dc1895976..599656b86 100644
--- a/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IServiceListener.java
+++ b/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IServiceListener.java
@@ -10,10 +10,8 @@
 package org.eclipse.ecf.discovery;
 
 /**
- * Listener for receiving service events.
+ * Listener for receiving service events
  * 
- * @author slewis
- *
  */
 public interface IServiceListener {
 	/**
diff --git a/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IServiceTypeListener.java b/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IServiceTypeListener.java
index 35fdcd56f..149b451ac 100644
--- a/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IServiceTypeListener.java
+++ b/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/IServiceTypeListener.java
@@ -9,6 +9,9 @@
 
 package org.eclipse.ecf.discovery;
 
+/**
+ * Listener for service type notifications
+ */
 public interface IServiceTypeListener {
 	/**
 	 * Notification that a service type has been added
diff --git a/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/ServiceContainerEvent.java b/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/ServiceContainerEvent.java
index cfd57227f..190c0b89b 100644
--- a/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/ServiceContainerEvent.java
+++ b/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/ServiceContainerEvent.java
@@ -11,12 +11,13 @@ package org.eclipse.ecf.discovery;
 
 import org.eclipse.ecf.core.identity.ID;
 
+/**
+ * Event implementation of IServiceEvent interface
+ */
 public class ServiceContainerEvent implements IServiceEvent {
 
 	private static final long serialVersionUID = 1L;
-
 	protected IServiceInfo info;
-
 	protected ID containerID;
 
 	public ServiceContainerEvent(IServiceInfo info, ID containerID) {
diff --git a/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/ServiceInfo.java b/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/ServiceInfo.java
index 0e96209d3..750399c16 100644
--- a/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/ServiceInfo.java
+++ b/framework/bundles/org.eclipse.ecf.discovery/src/org/eclipse/ecf/discovery/ServiceInfo.java
@@ -17,6 +17,9 @@ import java.util.Map;
 
 import org.eclipse.ecf.core.identity.ServiceID;
 
+/**
+ * Information provided by discovery protocol about a remote service
+ */
 public class ServiceInfo implements IServiceInfo, Serializable {
 
 	private static final long serialVersionUID = 1L;
@@ -84,6 +87,6 @@ public class ServiceInfo implements IServiceInfo, Serializable {
 	}
 	
 	public URI getServiceURI() throws URISyntaxException {
-		throw new URISyntaxException("","");
+		throw new URISyntaxException(this.toString(),"ServiceInfo doesn't support URI syntax");
 	}
 }