Added comments to IceDiscovery.ice fixes #697

1 files changed, 56 insertions, 0 deletions

diff --git a/slice/IceDiscovery/IceDiscovery.ice b/slice/IceDiscovery/IceDiscovery.ice
index dbf9907889d..12485f4f3cb 100644
--- a/slice/IceDiscovery/IceDiscovery.ice
+++ b/slice/IceDiscovery/IceDiscovery.ice
@@ -24,17 +24,73 @@
 module IceDiscovery
 {
 
+/**
+ *
+ * The LookupReply interface is used by IceDiscovery clients to answer requests
+ * received on the Lookup interface.
+ *
+ **/
 interface LookupReply
 {
+    /**
+     * Reply to the findObjectById request.
+     *
+     * @param id The identity of the object.
+     *
+     * @param prx The proxy of the object.
+     *
+     **/
     void foundObjectById(Ice::Identity id, Object* prx);
 
+    /**
+     * Reply to the findAdpaterById request.
+     *
+     * @param id The adapter ID.
+     *
+     * @param prx The adapter proxy (a dummy proxy created by the adapter).
+     * The proxy provides the adapter endpoints.
+     *
+     * @param isReplicaGroup True if the adapter is also a member of a
+     * replica group.
+     *
+     **/
     void foundAdapterById(string id, Object* prx, bool isReplicaGroup);
 }
 
+/**
+ *
+ * The Lookup interface is used by IceDiscovery clients to look for objects
+ * and adapters using UDP multicast.
+ *
+ **/
 interface Lookup
 {
+    /**
+     * Request to find an Ice object
+     *
+     * @param domainId The IceDiscovery domain identifier. An IceDiscovery client only
+     * replies to requests with a matching domain identifier.
+     *
+     * @param id The object identity.
+     *
+     * @param reply The proxy of the LookupReply interface that should be used to send
+     * the reply if a matching object is found.
+     *
+     **/
     idempotent void findObjectById(string domainId, Ice::Identity id, LookupReply* reply);
 
+    /**
+     * Request to find an object adapter
+     *
+     * @param domainId The IceDiscovery domain identifier. An IceDiscovery client only
+     * replies to requests with a matching domain identifier.
+     *
+     * @param id The adapter ID.
+     *
+     * @param reply The proxy of the LookupReply interface that should be used to send
+     * the reply if a matching adapter is found.
+     *
+     **/
     idempotent void findAdapterById(string domainId, string id, LookupReply* reply);
 }