Author: oheger
Date: Sat Mar 5 09:45:50 2005
New Revision: 156268
URL: http://svn.apache.org/viewcvs?view=rev&rev=156268
Log:
Minor documentation update about the usage of SubsetConfiguration
Modified:
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/SubsetConfiguration.java
Modified:
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/SubsetConfiguration.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/SubsetConfiguration.java?view=diff&r1=156267&r2=156268
==============================================================================
---
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/SubsetConfiguration.java
(original)
+++
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/SubsetConfiguration.java
Sat Mar 5 09:45:50 2005
@@ -1,5 +1,5 @@
/*
- * Copyright 2004 The Apache Software Foundation.
+ * Copyright 2004-2005 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License")
* you may not use this file except in compliance with the License.
@@ -22,11 +22,12 @@
import org.apache.commons.collections.iterators.TransformIterator;
/**
- * A subset of another configuration. The new Configuration object contains
+ * <p>A subset of another configuration. The new Configuration object contains
* every key from the parent Configuration that starts with prefix. The prefix
- * is removed from the keys in the subset.
- *
- * @see Configuration#subset(String)
+ * is removed from the keys in the subset.</p>
+ * <p>It is usually not necessary to use this class directly. Instead the
+ * <code>[EMAIL PROTECTED] Configuration#subset(String)}</code> method should
be used,
+ * which will return a correctly initialized instance.</p>
*
* @author Emmanuel Bourg
* @version $Revision$, $Date$
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
