You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2022/05/31 08:08:14 UTC
[tomcat] branch main updated: Javadoc clean-up including removing @author tag
This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/main by this push:
new b685d84874 Javadoc clean-up including removing @author tag
b685d84874 is described below
commit b685d8487483c726eedb1aa3e8b009c166c4bf45
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Wed May 25 09:05:49 2022 +0100
Javadoc clean-up including removing @author tag
---
java/org/apache/tomcat/jni/Buffer.java | 8 +++++---
java/org/apache/tomcat/jni/Pool.java | 20 +++++++++++---------
2 files changed, 16 insertions(+), 12 deletions(-)
diff --git a/java/org/apache/tomcat/jni/Buffer.java b/java/org/apache/tomcat/jni/Buffer.java
index 2645666357..a9d29edb1e 100644
--- a/java/org/apache/tomcat/jni/Buffer.java
+++ b/java/org/apache/tomcat/jni/Buffer.java
@@ -18,9 +18,9 @@ package org.apache.tomcat.jni;
import java.nio.ByteBuffer;
-/** Buffer
- *
- * @author Mladen Turk
+/**
+ * Provides utilities related to the use of directly allocated
+ * {@link ByteBuffer} instances with native code.
*/
public class Buffer {
@@ -93,7 +93,9 @@ public class Buffer {
/**
* Returns the memory address of the ByteBuffer.
+ *
* @param buf Previously allocated ByteBuffer.
+ *
* @return the memory address
*/
public static native long address(ByteBuffer buf);
diff --git a/java/org/apache/tomcat/jni/Pool.java b/java/org/apache/tomcat/jni/Pool.java
index e3741f5cff..3668a508b9 100644
--- a/java/org/apache/tomcat/jni/Pool.java
+++ b/java/org/apache/tomcat/jni/Pool.java
@@ -18,18 +18,20 @@ package org.apache.tomcat.jni;
import java.nio.ByteBuffer;
-/** Pool
- *
- * @author Mladen Turk
+/**
+ * Provides access to APR memory pools which are used to manage memory
+ * allocations for natively created instances.
*/
public class Pool {
/**
* Create a new pool.
- * @param parent The parent pool. If this is 0, the new pool is a root
- * pool. If it is non-zero, the new pool will inherit all
- * of its parent pool's attributes, except the apr_pool_t will
- * be a sub-pool.
+ *
+ * @param parent The parent pool. If this is 0, the new pool is a root pool.
+ * If it is non-zero, the new pool will inherit all of its
+ * parent pool's attributes, except the apr_pool_t will be a
+ * sub-pool.
+ *
* @return The pool we have just created.
*/
public static native long create(long parent);
@@ -48,8 +50,8 @@ public class Pool {
/**
* Destroy the pool. This takes similar action as apr_pool_clear() and then
- * frees all the memory.
- * This will actually free the memory
+ * frees all the memory. This will actually free the memory.
+ *
* @param pool The pool to destroy
*/
public static native void destroy(long pool);
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org