dlr 01/08/09 12:30:12
Modified: src/core/java/org/apache/fulcrum Service.java
Log:
* Corrected comment.
* Added JavaDoc to methods which were missing it.
Revision Changes Path
1.3 +14 -2
jakarta-turbine-fulcrum/src/core/java/org/apache/fulcrum/Service.java
Index: Service.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-fulcrum/src/core/java/org/apache/fulcrum/Service.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -u -r1.2 -r1.3
--- Service.java 2001/08/09 19:07:25 1.2
+++ Service.java 2001/08/09 19:30:12 1.3
@@ -67,7 +67,7 @@
* @author <a href="mailto:[EMAIL PROTECTED]";>Rafal Krzewski</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Daniel Rall</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Jason van Zyl</a>
- * @version $Id: Service.java,v 1.2 2001/08/09 19:07:25 dlr Exp $
+ * @version $Id: Service.java,v 1.3 2001/08/09 19:30:12 dlr Exp $
*/
public interface Service
{
@@ -81,7 +81,8 @@
*
* When your class is being requested from an InitableBroker, it
* will call getInit(), and if it returns false, this method will
- * be invoked. A typical implementation will look something like
+ * be invoked. A typical implementation for classes extending
+ * {@link org.apache.fulcrum.BaseService} will look something like
* the following:
*
* <blockquote><code><pre>
@@ -152,9 +153,20 @@
*/
public Configuration getConfiguration();
+ /**
+ * Given a relative paths, gets the real path.
+ */
public String getRealPath(String path);
+ /**
+ * Gets the default logger for this service.
+ */
public Category getCategory();
+ /**
+ * Gets the named logger.
+ *
+ * @param name The name of the logger.
+ */
public Category getCategory(String name);
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
