From f1fad72ac4bdede152b3e62f40cf06a60eac91c5 Mon Sep 17 00:00:00 2001
From: Rainer Klute <klute@apache.org>
Date: Fri, 26 Apr 2002 05:58:00 +0000
Subject: [PATCH] Comment added.

git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@352488 13f79535-47bb-0310-9956-ffa450edef68
---
 .../apache/poi/hpsf/SummaryInformation.java   | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/src/java/org/apache/poi/hpsf/SummaryInformation.java b/src/java/org/apache/poi/hpsf/SummaryInformation.java
index 1c591ab52e..85ab273ea6 100644
--- a/src/java/org/apache/poi/hpsf/SummaryInformation.java
+++ b/src/java/org/apache/poi/hpsf/SummaryInformation.java
@@ -279,8 +279,23 @@ public class SummaryInformation extends SpecialPropertySet
 
 
     /**
-     * <p>Returns the stream's security field or 0 if the {@link
-     * SummaryInformation} does not contain a security field.</p>
+     * <p>Returns one of the following values:</p>
+     *
+     * <ul>
+     *
+     * <li><p>0 if the {@link SummaryInformation} does not contain a
+     * security field or if there is no security on the document. Use
+     * {@link #wasNull} to distinguish between the two cases!</p></li>
+     *
+     * <li><p>1 if the document is password protected</p></li>
+     *
+     * <li><p>2 if the document is read-only recommended</p></li>
+     *
+     * <li><p>4 if the document is read-only enforced</p></li>
+     *
+     * <li><p>8 if the document is locked for annotations</p></li>
+     *
+     * </ul>
      */
     public int getSecurity()
     {