You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2012/02/14 03:35:59 UTC
svn commit: r1243764 - in
/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool:
impl/package-info.java impl/package.html package-info.java package.html
Author: ggregory
Date: Tue Feb 14 02:35:58 2012
New Revision: 1243764
URL: http://svn.apache.org/viewvc?rev=1243764&view=rev
Log:
Use Java 5 style for package level Javadocs.
Added:
commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/package-info.java
- copied, changed from r1229462, commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/package.html
commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/package-info.java
- copied, changed from r1229462, commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/package.html
Removed:
commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/package.html
commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/package.html
Copied: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/package-info.java (from r1229462, commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/package.html)
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/package-info.java?p2=commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/package-info.java&p1=commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/package.html&r1=1229462&r2=1243764&rev=1243764&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/package.html (original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/package-info.java Tue Feb 14 02:35:58 2012
@@ -1,56 +1,48 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
- http://www.apache.org/licenses/LICENSE-2.0
+/**
+ * <p>
+ * Object pooling API implementations.
+ * </p>
+ * <p>
+ * {@link org.apache.commons.pool.impl.StackObjectPool StackObjectPool} (
+ * {@link org.apache.commons.pool.impl.StackKeyedObjectPool StackKeyedObjectPool}) provides a simple,
+ * {@link java.util.Stack Stack}-based implementation of {@link org.apache.commons.pool.ObjectPool ObjectPool} (
+ * {@link org.apache.commons.pool.KeyedObjectPool KeyedObjectPool}).
+ * {@link org.apache.commons.pool.impl.StackObjectPoolFactory StackObjectPoolFactory} (
+ * {@link org.apache.commons.pool.impl.StackKeyedObjectPoolFactory StackKeyedObjectPoolFactory}) provides an
+ * implementation of the {@link org.apache.commons.pool.ObjectPoolFactory ObjectPoolFactory} (
+ * {@link org.apache.commons.pool.KeyedObjectPoolFactory KeyedObjectPoolFactory}) factory interface for this class.
+ * </p>
+ * <p>
+ * {@link org.apache.commons.pool.impl.GenericObjectPool GenericObjectPool} (
+ * {@link org.apache.commons.pool.impl.GenericKeyedObjectPool GenericKeyedObjectPool}) provides a more robust (but also
+ * more complicated) implementation of {@link org.apache.commons.pool.ObjectPool ObjectPool} (
+ * {@link org.apache.commons.pool.KeyedObjectPool KeyedObjectPool}).
+ * {@link org.apache.commons.pool.impl.GenericObjectPoolFactory GenericObjectPoolFactory} (
+ * {@link org.apache.commons.pool.impl.GenericKeyedObjectPoolFactory GenericKeyedObjectPoolFactory}) provides an
+ * implementation of the {@link org.apache.commons.pool.ObjectPoolFactory ObjectPoolFactory} (
+ * {@link org.apache.commons.pool.KeyedObjectPoolFactory KeyedObjectPoolFactory}) factory interface for this class.
+ * </p>
+ * <p>
+ * See also the {@link org.apache.commons.pool} package.
+ * </p>
+ * @version $Id$
+ */
+package org.apache.commons.pool.impl;
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
-<!-- $Id$ -->
-<html>
- <head>
- <title>Package Documentation for org.apache.commons.pool.impl</title>
- </head>
- <body>
- <p>
- Object pooling API implementations.
- </p>
- <p>
- {@link org.apache.commons.pool.impl.StackObjectPool StackObjectPool}
- ({@link org.apache.commons.pool.impl.StackKeyedObjectPool StackKeyedObjectPool})
- provides a simple, {@link java.util.Stack Stack}-based
- implementation of {@link org.apache.commons.pool.ObjectPool ObjectPool}
- ({@link org.apache.commons.pool.KeyedObjectPool KeyedObjectPool}).
- {@link org.apache.commons.pool.impl.StackObjectPoolFactory StackObjectPoolFactory}
- ({@link org.apache.commons.pool.impl.StackKeyedObjectPoolFactory StackKeyedObjectPoolFactory})
- provides an implementation of the
- {@link org.apache.commons.pool.ObjectPoolFactory ObjectPoolFactory}
- ({@link org.apache.commons.pool.KeyedObjectPoolFactory KeyedObjectPoolFactory})
- factory interface for this class.
- </p>
- <p>
- {@link org.apache.commons.pool.impl.GenericObjectPool GenericObjectPool}
- ({@link org.apache.commons.pool.impl.GenericKeyedObjectPool GenericKeyedObjectPool})
- provides a more robust (but also more complicated)
- implementation of {@link org.apache.commons.pool.ObjectPool ObjectPool}
- ({@link org.apache.commons.pool.KeyedObjectPool KeyedObjectPool}).
- {@link org.apache.commons.pool.impl.GenericObjectPoolFactory GenericObjectPoolFactory}
- ({@link org.apache.commons.pool.impl.GenericKeyedObjectPoolFactory GenericKeyedObjectPoolFactory})
- provides an implementation of the
- {@link org.apache.commons.pool.ObjectPoolFactory ObjectPoolFactory}
- ({@link org.apache.commons.pool.KeyedObjectPoolFactory KeyedObjectPoolFactory})
- factory interface for this class.
- </p>
- <p>
- See also the {@link org.apache.commons.pool} package.
- </p>
- </body>
-</html>
Copied: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/package-info.java (from r1229462, commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/package.html)
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/package-info.java?p2=commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/package-info.java&p1=commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/package.html&r1=1229462&r2=1243764&rev=1243764&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/package.html (original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/package-info.java Tue Feb 14 02:35:58 2012
@@ -1,69 +1,68 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
- http://www.apache.org/licenses/LICENSE-2.0
+/**
+ *<p>
+ * Object pooling API.
+ * </p>
+ * <p>
+ * The <code>org.apache.commons.pool</code> package defines a simple
+ * interface for a pool of object instances, and a handful of base
+ * classes that may be useful when creating pool implementations.
+ * </p>
+ * <p>
+ * The <code>pool</code> package itself doesn't define a specific object
+ * pooling implementation, but rather a contract that implementations may
+ * support in order to be fully interchangeable.
+ * </p>
+ * <p>
+ * The <code>pool</code> package separates the way in which instances are
+ * pooled from the way in which they are created, resulting in a pair of
+ * interfaces:
+ * </p>
+ * <dl>
+ * <dt>{@link org.apache.commons.pool.ObjectPool ObjectPool}</dt>
+ * <dd>
+ * defines a simple object pooling interface, with methods for
+ * borrowing instances from and returning them to the pool.
+ * </dd>
+ * <dt>{@link org.apache.commons.pool.PoolableObjectFactory PoolableObjectFactory}</dt>
+ * <dd>
+ * defines lifecycle methods for object instances contained within a pool.
+ * By associating a factory with a pool, the pool can create new object
+ * instances as needed.
+ * </dd>
+ * </dl>
+ * <p>
+ * {@link org.apache.commons.pool.ObjectPoolFactory ObjectPoolFactory}
+ * defines a simple factory for <code>ObjectPool</code>s, which may be
+ * useful for some applications.
+ * </p>
+ * <p>
+ * The <code>pool</code> package also provides a keyed pool interface,
+ * which pools instances of multiple types, accessed according to an
+ * arbitrary key. See
+ * {@link org.apache.commons.pool.KeyedObjectPool KeyedObjectPool},
+ * {@link org.apache.commons.pool.KeyedPoolableObjectFactory KeyedPoolableObjectFactory},
+ * and
+ * {@link org.apache.commons.pool.KeyedObjectPoolFactory KeyedObjectPoolFactory}.
+ * </p>
+ *
+ * @version $Id$
+ */
+package org.apache.commons.pool;
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
-<!-- $Id$ -->
-<html>
- <head>
- <title>Package Documentation for org.apache.commons.pool</title>
- </head>
- <body>
- <p>
- Object pooling API.
- </p>
- <p>
- The <code>org.apache.commons.pool</code> package defines a simple
- interface for a pool of object instances, and a handful of base
- classes that may be useful when creating pool implementations.
- </p>
- <p>
- The <code>pool</code> package itself doesn't define a specific object
- pooling implementation, but rather a contract that implementations may
- support in order to be fully interchangeable.
- </p>
- <p>
- The <code>pool</code> package separates the way in which instances are
- pooled from the way in which they are created, resulting in a pair of
- interfaces:
- </p>
- <dl>
- <dt>{@link org.apache.commons.pool.ObjectPool ObjectPool}</dt>
- <dd>
- defines a simple object pooling interface, with methods for
- borrowing instances from and returning them to the pool.
- </dd>
- <dt>{@link org.apache.commons.pool.PoolableObjectFactory PoolableObjectFactory}</dt>
- <dd>
- defines lifecycle methods for object instances contained within a pool.
- By associating a factory with a pool, the pool can create new object
- instances as needed.
- </dd>
- </dl>
- <p>
- {@link org.apache.commons.pool.ObjectPoolFactory ObjectPoolFactory}
- defines a simple factory for <code>ObjectPool</code>s, which may be
- useful for some applications.
- </p>
- <p>
- The <code>pool</code> package also provides a keyed pool interface,
- which pools instances of multiple types, accessed according to an
- arbitrary key. See
- {@link org.apache.commons.pool.KeyedObjectPool KeyedObjectPool},
- {@link org.apache.commons.pool.KeyedPoolableObjectFactory KeyedPoolableObjectFactory},
- and
- {@link org.apache.commons.pool.KeyedObjectPoolFactory KeyedObjectPoolFactory}.
- </p>
- </body>
-</html>