From 53ef7398ce731423e94a64e42bf8714a50ecbea3 Mon Sep 17 00:00:00 2001
From: Michael Busch <buschmi@apache.org>
Date: Sat, 9 Jun 2007 04:52:38 +0000
Subject: [PATCH] LUCENE-917: Javadoc improvements for
 org.apache.lucene.index.Payload

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@545693 13f79535-47bb-0310-9956-ffa450edef68
---
 src/java/org/apache/lucene/index/Payload.java | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/java/org/apache/lucene/index/Payload.java b/src/java/org/apache/lucene/index/Payload.java
index 716a4c24f4b..15f11364a92 100644
--- a/src/java/org/apache/lucene/index/Payload.java
+++ b/src/java/org/apache/lucene/index/Payload.java
@@ -41,10 +41,16 @@ import org.apache.lucene.analysis.TokenStream;
   */    
   // TODO: Remove warning after API has been finalized
   public class Payload implements Serializable {
+    /** the byte array containing the payload data */
     protected byte[] data;
+    
+    /** the offset within the byte array */
     protected int offset;
+    
+    /** the length of the payload data */
     protected int length;
     
+    /** Creates an empty payload and does not allocate a byte array. */
     protected Payload() {
       // no-arg constructor since this class implements Serializable
     }
@@ -74,6 +80,9 @@ import org.apache.lucene.analysis.TokenStream;
       this.length = length;
     }
     
+    /**
+     * Returns the length of the payload data. 
+     */
     public int length() {
       return this.length;
     }