Add javadoc comments. Remove unused IBorderAttributes.java interface, whose content...

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196553 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/java/org/apache/fop/rtf/rtflib/rtfdoc/BorderAttributesConverter.java b/src/java/org/apache/fop/rtf/rtflib/rtfdoc/BorderAttributesConverter.java
index 27c07ab758f2ed3ed2fc0c90eafb561c912e1199..004467668791c764299f1a54b95a242b2f637e90 100644 (file)
--- a/src/java/org/apache/fop/rtf/rtflib/rtfdoc/BorderAttributesConverter.java
+++ b/src/java/org/apache/fop/rtf/rtflib/rtfdoc/BorderAttributesConverter.java
@@ -63,35 +63,64 @@ package org.apache.fop.rtf.rtflib.rtfdoc;
 
 public class BorderAttributesConverter {
 
+    /** Constant for a single-thick border */
     public static final String BORDER_SINGLE_THICKNESS = "brdrs";
+    /** Constant for a double-thick border */
     public static final String BORDER_DOUBLE_THICKNESS = "brdrth";
+    /** Constant for a shadowed border */
     public static final String BORDER_SHADOWED = "brdrsh";
+    /** Constant for a double border */
     public static final String BORDER_DOUBLE = "brdrdb";
+    /** Constant for a dotted border */
     public static final String BORDER_DOTTED = "brdrdot";
+    /** Constant for a dashed border */
     public static final String BORDER_DASH = "brdrdash";
+    /** Constant for a hairline border */
     public static final String BORDER_HAIRLINE = "brdrhair";
+    /** Constant for a small-dashed border */
     public static final String BORDER_DASH_SMALL = "brdrdashsm";
+    /** Constant for a dot-dashed border */
     public static final String BORDER_DOT_DASH = "brdrdashd";
+    /** Constant for a dot-dot-dashed border */
     public static final String BORDER_DOT_DOT_DASH = "brdrdashdd";
+    /** Constant for a triple border */
     public static final String BORDER_TRIPLE = "brdrtriple";
+    /** Constant for a think-thin-small border */
     public static final String BORDER_THINK_THIN_SMALL = "brdrtnthsg";
+    /** Constant for a thin-thick-small border */
     public static final String BORDER_THIN_THICK_SMALL = "brdrthtnsg";
+    /** Constant for a thin-thick-thin-small border */
     public static final String BORDER_THIN_THICK_THIN_SMALL = "brdrthtnthsg";
+    /** Constant for a think-thin-medium border */
     public static final String BORDER_THINK_THIN_MEDIUM = "brdrtnthmg";
+    /** Constant for a thin-thick-medium border */
     public static final String BORDER_THIN_THICK_MEDIUM = "brdrthtnmg";
+    /** Constant for a thin-thick-thin-medium border */
     public static final String BORDER_THIN_THICK_THIN_MEDIUM = "brdrthtnthmg";
+    /** Constant for a think-thin-large border */
     public static final String BORDER_THINK_THIN_LARGE = "brdrtnthlg";
+    /** Constant for a thin-thick-large border */
     public static final String BORDER_THIN_THICK_LARGE = "brdrthtnlg";
+    /** Constant for a thin-thick-thin-large border */
     public static final String BORDER_THIN_THICK_THIN_LARGE = "brdrthtnthlg";
+    /** Constant for a wavy border */
     public static final String BORDER_WAVY = "brdrwavy";
+    /** Constant for a double wavy border */
     public static final String BORDER_WAVY_DOUBLE = "brdrwavydb";
+    /** Constant for a striped border */
     public static final String BORDER_STRIPED = "brdrdashdotstr";
+    /** Constant for an embossed border */
     public static final String BORDER_EMBOSS = "brdremboss";
+    /** Constant for an engraved border */
     public static final String BORDER_ENGRAVE = "brdrengrave";
+    /** Constant for border color */
     public static final String BORDER_COLOR = "brdrcf";
+    /** Constant for border space */
     public static final String BORDER_SPACE = "brsp";
+    /** Constant for border width */
     public static final String BORDER_WIDTH = "brdrw";
 
+    /** String array of border attributes */
     public static final String [] BORDERS = new String[] {
         BORDER_SINGLE_THICKNESS,    BORDER_DOUBLE_THICKNESS,            BORDER_SHADOWED,
         BORDER_DOUBLE,              BORDER_DOTTED,                      BORDER_DASH,

diff --git a/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IBorderAttributes.java b/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IBorderAttributes.java
deleted file mode 100644 (file)
index 12f50a6..0000000
--- a/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IBorderAttributes.java
+++ /dev/null
@@ -1,92 +0,0 @@
-/*
- * $Id$
- * ============================================================================
- *                    The Apache Software License, Version 1.1
- * ============================================================================
- *
- * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without modifica-
- * tion, are permitted provided that the following conditions are met:
- *
- * 1. Redistributions of source code must retain the above copyright notice,
- *    this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright notice,
- *    this list of conditions and the following disclaimer in the documentation
- *    and/or other materials provided with the distribution.
- *
- * 3. The end-user documentation included with the redistribution, if any, must
- *    include the following acknowledgment: "This product includes software
- *    developed by the Apache Software Foundation (http://www.apache.org/)."
- *    Alternately, this acknowledgment may appear in the software itself, if
- *    and wherever such third-party acknowledgments normally appear.
- *
- * 4. The names "FOP" and "Apache Software Foundation" must not be used to
- *    endorse or promote products derived from this software without prior
- *    written permission. For written permission, please contact
- *    apache@apache.org.
- *
- * 5. Products derived from this software may not be called "Apache", nor may
- *    "Apache" appear in their name, without prior written permission of the
- *    Apache Software Foundation.
- *
- * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
- * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
- * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
- * APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
- * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
- * DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
- * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
- * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
- * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- * ============================================================================
- *
- * This software consists of voluntary contributions made by many individuals
- * on behalf of the Apache Software Foundation and was originally created by
- * James Tauber <jtauber@jtauber.com>. For more information on the Apache
- * Software Foundation, please see <http://www.apache.org/>.
- */
-
-/*
- * This file is part of the RTF library of the FOP project, which was originally
- * created by Bertrand Delacretaz <bdelacretaz@codeconsult.ch> and by other
- * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to
- * the FOP project.
- */
-
-package org.apache.fop.rtf.rtflib.rtfdoc;
-
-/** Constants for RTF table attribute names */
-
-public interface IBorderAttributes {
-
-    String BORDER_SINGLE_THICKNESS = "brdrs";
-    String BORDER_DOUBLE_THICKNESS = "brdrth";
-    String BORDER_SHADOWED = "brdrsh";
-    String BORDER_DOUBLE = "brdrdb";
-    String BORDER_DOTTED = "brdrdot";
-    String BORDER_DASH = "brdrdash";
-    String BORDER_HAIRLINE = "brdrhair";
-    String BORDER_DASH_SMALL = "brdrdashsm";
-    String BORDER_DOT_DASH = "brdrdashd";
-    String BORDER_DOT_DOT_DASH = "brdrdashdd";
-    String BORDER_TRIPLE = "brdrtriple";
-    String BORDER_THINK_THIN_SMALL = "brdrtnthsg";
-    String BORDER_THIN_THICK_SMALL = "brdrthtnsg";
-    String BORDER_THIN_THICK_THIN_SMALL = "brdrthtnthsg";
-    String BORDER_THINK_THIN_MEDIUM = "brdrtnthmg";
-    String BORDER_THIN_THICK_MEDIUM = "brdrthtnmg";
-    String BORDER_THIN_THICK_THIN_MEDIUM = "brdrthtnthmg";
-    String BORDER_THINK_THIN_LARGE = "brdrtnthlg";
-    String BORDER_THIN_THICK_LARGE = "brdrthtnlg";
-    String BORDER_THIN_THICK_THIN_LARGE = "brdrthtnthlg";
-    String BORDER_WAVY = "brdrwavy";
-    String BORDER_WAVY_DOUBLE = "brdrwavydb";
-    String BORDER_STRIPED = "brdrdashdotstr";
-    String BORDER_EMBOSS = "brdremboss";
-    String BORDER_ENGRAVE = "brdrengrave";
-    String BORDER_COLOR = "brdrcf";
-    String BORDER_SPACE = "brsp";
-}
\ No newline at end of file