mcconnell 2002/08/04 05:04:00
Modified: assembly/src/java/org/apache/excalibur/merlin/assembly
DefaultLoggerManager.java
assembly/src/java/org/apache/excalibur/merlin/model/builder
ProfileCreator.java
Log:
javadoc updating
Revision Changes Path
1.3 +20 -17
jakarta-avalon-excalibur/assembly/src/java/org/apache/excalibur/merlin/assembly/DefaultLoggerManager.java
Index: DefaultLoggerManager.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/assembly/src/java/org/apache/excalibur/merlin/assembly/DefaultLoggerManager.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DefaultLoggerManager.java 2 Aug 2002 06:36:09 -0000 1.2
+++ DefaultLoggerManager.java 4 Aug 2002 12:04:00 -0000 1.3
@@ -158,8 +158,7 @@
}
/**
- * Add a set of category entries using the system wide defaults.
- * @param path the category header
+ * Add a set of category entries using the supplied categories descriptor.
* @param descriptor a set of category descriptors to be added under the path
*/
public void addCategories( CategoriesDescriptor descriptor )
@@ -168,9 +167,11 @@
}
/**
- * Add a set of category entries using the system wide defaults.
- * @param path the category header
- * @param descriptor a set of category descriptors to be added under the path
+ * Add a set of category entries relative to the supplied base category
+ * path, using the supplied descriptor as the definition of subcategories.
+ * @param path the category base path
+ * @param descriptor a set of category descriptors to be added under
+ * the base path
*/
public void addCategories( String path, CategoriesDescriptor descriptor )
{
@@ -258,11 +259,13 @@
}
/**
- * Configure Logging categories.
- *
- * @param categories configuration data for categories
- * @param targets a hashmap containing the already existing taregt
- * @throws ConfigurationException if an error occurs
+ * Create a logging channel configured with the supplied category path,
+ * priority and target.
+ *
+ * @param name logging category path
+ * @param target the logging target to assign the channel to
+ * @param priority the priority level to assign to the channel
+ * @throws Exception if an error occurs
*/
public org.apache.avalon.framework.logger.Logger getLoggerForCategory(
final String name, String target, String priority )
@@ -272,11 +275,11 @@
}
/**
- * Configure Logging categories.
+ * Configure Logging channel based on the description supplied in a
+ * category descriptor.
*
- * @param categories configuration data for categories
- * @param targets a hashmap containing the already existing taregt
- * @throws ConfigurationException if an error occurs
+ * @param category defintion of the channel category, priority and target
+ * @throws Exception if an error occurs
*/
public org.apache.avalon.framework.logger.Logger getLoggerForCategory( final
Category category )
throws Exception
@@ -296,6 +299,7 @@
/**
* Return the Logger for the specified category.
+ * @param category the category path
*/
public org.apache.avalon.framework.logger.Logger getLoggerForCategory( final
String category )
{
@@ -321,10 +325,9 @@
}
/**
- * Return the default Logger. This is the same
- * as getting the Logger for the "" category.
+ * Return the internal Logger.
*/
- public org.apache.avalon.framework.logger.Logger getLogger( )
+ private org.apache.avalon.framework.logger.Logger getLogger( )
{
if( m_logger == null )
m_logger = getLoggerForCategory("kernel.logging");
1.7 +2 -2
jakarta-avalon-excalibur/assembly/src/java/org/apache/excalibur/merlin/model/builder/ProfileCreator.java
Index: ProfileCreator.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/assembly/src/java/org/apache/excalibur/merlin/model/builder/ProfileCreator.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ProfileCreator.java 4 Aug 2002 11:49:36 -0000 1.6
+++ ProfileCreator.java 4 Aug 2002 12:04:00 -0000 1.7
@@ -22,7 +22,7 @@
public interface ProfileCreator
{
/**
- * Create a set of packaged {@link Profile[]} instances from stream
+ * Create a set of packaged {@link Profile} instances from stream
*
* @param loader the classloader
* @param type the base type
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
