donaldp 02/01/11 18:03:41
Modified: src/java/org/apache/avalon/phoenix/metainfo
ServiceDescriptor.java
Log:
Update javadocs to be more descriptive
Revision Changes Path
1.7 +12 -4
jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/metainfo/ServiceDescriptor.java
Index: ServiceDescriptor.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/metainfo/ServiceDescriptor.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ServiceDescriptor.java 11 Dec 2001 10:13:35 -0000 1.6
+++ ServiceDescriptor.java 12 Jan 2002 02:03:41 -0000 1.7
@@ -10,7 +10,9 @@
import org.apache.avalon.framework.Version;
/**
- * This interface describes a particular service that a component offers.
+ * This class describes the meta info of a service offered by a Block.
+ * Each service is defined by an interface name and the version of that
+ * interface.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Peter Donald</a>
*/
@@ -19,6 +21,12 @@
private final Version m_version;
private final String m_name;
+ /**
+ * Construct a service with specified name and version.
+ *
+ * @param name the name of the service
+ * @param version the version of service
+ */
public ServiceDescriptor( final String name, final Version version )
{
m_name = name;
@@ -26,7 +34,7 @@
}
/**
- * Return version of interface
+ * Return the version of interface
*
* @return the version of interface
*/
@@ -37,7 +45,7 @@
/**
* Return name of Service (which coresponds to the interface
- * name eg org.apache.block.Logger)
+ * name eg org.apache.block.WebServer)
*
* @return the name of the Service
*/
@@ -47,7 +55,7 @@
}
/**
- * Determine if other service will match this service.
+ * Determine if specified service will match this service.
* To match a service has to have same name and must comply with version.
*
* @param other the other ServiceInfo
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
