From: William Victor Mote Date: Sun, 6 Jul 2003 23:27:55 +0000 (+0000) Subject: clean up gump javadoc warnings X-Git-Tag: Root_Temp_KnuthStylePageBreaking~1325 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=3f3fb880bd068fc326411279888933a1109e2359;p=xmlgraphics-fop.git clean up gump javadoc warnings git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196628 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/src/java/org/apache/fop/layoutmgr/LayoutHandler.java b/src/java/org/apache/fop/layoutmgr/LayoutHandler.java index 42805fc7e..e3986d17e 100644 --- a/src/java/org/apache/fop/layoutmgr/LayoutHandler.java +++ b/src/java/org/apache/fop/layoutmgr/LayoutHandler.java @@ -277,219 +277,219 @@ public class LayoutHandler extends StructureHandler { } /** - * @see org.apache.fop.apps.StructureHandler#startFlow(Flow) + * @see org.apache.fop.fo.StructureHandler#startFlow(Flow) */ public void startFlow(Flow fl) { } /** - * @see org.apache.fop.apps.StructureHandler#endFlow(Flow) + * @see org.apache.fop.fo.StructureHandler#endFlow(Flow) */ public void endFlow(Flow fl) { } /** - * @see org.apache.fop.apps.StructureHandler#startBlock(Block) + * @see org.apache.fop.fo.StructureHandler#startBlock(Block) */ public void startBlock(Block bl) { } /** - * @see org.apache.fop.apps.StructureHandler#endBlock(Block) + * @see org.apache.fop.fo.StructureHandler#endBlock(Block) */ public void endBlock(Block bl) { } /** - * @see org.apache.fop.apps.StructureHandler#startTable(Table) + * @see org.apache.fop.fo.StructureHandler#startTable(Table) */ public void startTable(Table tbl) { } /** - * @see org.apache.fop.apps.StructureHandler#endTable(Table) + * @see org.apache.fop.fo.StructureHandler#endTable(Table) */ public void endTable(Table tbl) { } /** - * @see org.apache.fop.apps.StructureHandler#startHeader(TableBody) + * @see org.apache.fop.fo.StructureHandler#startHeader(TableBody) */ public void startHeader(TableBody th) { } /** - * @see org.apache.fop.apps.StructureHandler#endHeader(TableBody) + * @see org.apache.fop.fo.StructureHandler#endHeader(TableBody) */ public void endHeader(TableBody th) { } /** - * @see org.apache.fop.apps.StructureHandler#startFooter(TableBody) + * @see org.apache.fop.fo.StructureHandler#startFooter(TableBody) */ public void startFooter(TableBody tf) { } /** - * @see org.apache.fop.apps.StructureHandler#endFooter(TableBody) + * @see org.apache.fop.fo.StructureHandler#endFooter(TableBody) */ public void endFooter(TableBody tf) { } /** - * @see org.apache.fop.apps.StructureHandler#startBody(TableBody) + * @see org.apache.fop.fo.StructureHandler#startBody(TableBody) */ public void startBody(TableBody tb) { } /** - * @see org.apache.fop.apps.StructureHandler#endBody(TableBody) + * @see org.apache.fop.fo.StructureHandler#endBody(TableBody) */ public void endBody(TableBody tb) { } /** - * @see org.apache.fop.apps.StructureHandler#startRow(TableRow) + * @see org.apache.fop.fo.StructureHandler#startRow(TableRow) */ public void startRow(TableRow tr) { } /** - * @see org.apache.fop.apps.StructureHandler#endRow(TableRow) + * @see org.apache.fop.fo.StructureHandler#endRow(TableRow) */ public void endRow(TableRow tr) { } /** - * @see org.apache.fop.apps.StructureHandler#startCell(TableCell) + * @see org.apache.fop.fo.StructureHandler#startCell(TableCell) */ public void startCell(TableCell tc) { } /** - * @see org.apache.fop.apps.StructureHandler#endCell(TableCell) + * @see org.apache.fop.fo.StructureHandler#endCell(TableCell) */ public void endCell(TableCell tc) { } // Lists /** - * @see org.apache.fop.apps.StructureHandler#startList(ListBlock) + * @see org.apache.fop.fo.StructureHandler#startList(ListBlock) */ public void startList(ListBlock lb) { } /** - * @see org.apache.fop.apps.StructureHandler#endList(ListBlock) + * @see org.apache.fop.fo.StructureHandler#endList(ListBlock) */ public void endList(ListBlock lb) { } /** - * @see org.apache.fop.apps.StructureHandler#startListItem(ListItem) + * @see org.apache.fop.fo.StructureHandler#startListItem(ListItem) */ public void startListItem(ListItem li) { } /** - * @see org.apache.fop.apps.StructureHandler#endListItem(ListItem) + * @see org.apache.fop.fo.StructureHandler#endListItem(ListItem) */ public void endListItem(ListItem li) { } /** - * @see org.apache.fop.apps.StructureHandler#startListLabel() + * @see org.apache.fop.fo.StructureHandler#startListLabel() */ public void startListLabel() { } /** - * @see org.apache.fop.apps.StructureHandler#endListLabel() + * @see org.apache.fop.fo.StructureHandler#endListLabel() */ public void endListLabel() { } /** - * @see org.apache.fop.apps.StructureHandler#startListBody() + * @see org.apache.fop.fo.StructureHandler#startListBody() */ public void startListBody() { } /** - * @see org.apache.fop.apps.StructureHandler#endListBody() + * @see org.apache.fop.fo.StructureHandler#endListBody() */ public void endListBody() { } // Static Regions /** - * @see org.apache.fop.apps.StructureHandler#startStatic() + * @see org.apache.fop.fo.StructureHandler#startStatic() */ public void startStatic() { } /** - * @see org.apache.fop.apps.StructureHandler#endStatic() + * @see org.apache.fop.fo.StructureHandler#endStatic() */ public void endStatic() { } /** - * @see org.apache.fop.apps.StructureHandler#startMarkup() + * @see org.apache.fop.fo.StructureHandler#startMarkup() */ public void startMarkup() { } /** - * @see org.apache.fop.apps.StructureHandler#endMarkup() + * @see org.apache.fop.fo.StructureHandler#endMarkup() */ public void endMarkup() { } /** - * @see org.apache.fop.apps.StructureHandler#startLink() + * @see org.apache.fop.fo.StructureHandler#startLink() */ public void startLink() { } /** - * @see org.apache.fop.apps.StructureHandler#endLink() + * @see org.apache.fop.fo.StructureHandler#endLink() */ public void endLink() { } /** - * @see org.apache.fop.apps.StructureHandler#image(ExternalGraphic) + * @see org.apache.fop.fo.StructureHandler#image(ExternalGraphic) */ public void image(ExternalGraphic eg) { } /** - * @see org.apache.fop.apps.StructureHandler#pageRef() + * @see org.apache.fop.fo.StructureHandler#pageRef() */ public void pageRef() { } /** - * @see org.apache.fop.apps.StructureHandler#foreignObject(InstreamForeignObject) + * @see org.apache.fop.fo.StructureHandler#foreignObject(InstreamForeignObject) */ public void foreignObject(InstreamForeignObject ifo) { } /** - * @see org.apache.fop.apps.StructureHandler#footnote() + * @see org.apache.fop.fo.StructureHandler#footnote() */ public void footnote() { } /** - * @see org.apache.fop.apps.StructureHandler#leader(Leader) + * @see org.apache.fop.fo.StructureHandler#leader(Leader) */ public void leader(Leader l) { } /** - * @see org.apache.fop.apps.StructureHandler#characters(char[], int, int) + * @see org.apache.fop.fo.StructureHandler#characters(char[], int, int) */ public void characters(char[] data, int start, int length) { } diff --git a/src/java/org/apache/fop/rtf/rtflib/rtfdoc/RtfBefore.java b/src/java/org/apache/fop/rtf/rtflib/rtfdoc/RtfBefore.java index 7046f5dec..a70442936 100644 --- a/src/java/org/apache/fop/rtf/rtflib/rtfdoc/RtfBefore.java +++ b/src/java/org/apache/fop/rtf/rtflib/rtfdoc/RtfBefore.java @@ -76,7 +76,8 @@ public class RtfBefore extends RtfAfterBeforeBase { } /** - * @see RtfAfterBeforeBase#writeMyAttributes + * Write the attributes for this element + * @throws IOException for I/O problems */ protected void writeMyAttributes() throws IOException { writeAttributes(attrib, HEADER_ATTR); diff --git a/src/java/org/apache/fop/rtf/rtflib/rtfdoc/RtfExtraRowSet.java b/src/java/org/apache/fop/rtf/rtflib/rtfdoc/RtfExtraRowSet.java index 4e272b5aa..42b3bb883 100755 --- a/src/java/org/apache/fop/rtf/rtflib/rtfdoc/RtfExtraRowSet.java +++ b/src/java/org/apache/fop/rtf/rtflib/rtfdoc/RtfExtraRowSet.java @@ -76,7 +76,7 @@ import org.apache.fop.rtf.rtflib.interfaces.ITableColumnsInfo; * causing extra rows to be generated, with content that can come * from several RtfTableCells * - * @see org.apache.fop.rtf.rtflib.testdoc.NestedTable + * @see org.apache.fop.rtf.rtflib.testdocs.NestedTable * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch */ diff --git a/src/java/org/apache/fop/rtf/rtflib/rtfdoc/RtfFile.java b/src/java/org/apache/fop/rtf/rtflib/rtfdoc/RtfFile.java index a9a09b19e..8ef92dddb 100755 --- a/src/java/org/apache/fop/rtf/rtflib/rtfdoc/RtfFile.java +++ b/src/java/org/apache/fop/rtf/rtflib/rtfdoc/RtfFile.java @@ -67,11 +67,11 @@ import java.io.BufferedWriter; import java.io.FileWriter; import java.io.OutputStreamWriter; -/** Models the top-level structure of an RTF file. - * @see RtfFileExample - * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch - * @author Andreas Putz a.putz@skynamics.com - * @author Christopher Scott scottc@westinghouse.com +/** + * Models the top-level structure of an RTF file. + * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch + * @author Andreas Putz a.putz@skynamics.com + * @author Christopher Scott scottc@westinghouse.com */ public class RtfFile diff --git a/src/java/org/apache/fop/util/ASCII85OutputStream.java b/src/java/org/apache/fop/util/ASCII85OutputStream.java index 942690d74..cb8ddeb72 100644 --- a/src/java/org/apache/fop/util/ASCII85OutputStream.java +++ b/src/java/org/apache/fop/util/ASCII85OutputStream.java @@ -3,34 +3,34 @@ * ============================================================================ * 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 @@ -42,12 +42,12 @@ * (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 . For more information on the Apache * Software Foundation, please see . - */ + */ package org.apache.fop.util; import java.io.OutputStream; @@ -109,7 +109,7 @@ public class ASCII85OutputStream extends FilterOutputStream private void checkedWrite(byte[] buf) throws IOException { checkedWrite(buf, buf.length, false); } - + private void checkedWrite(byte[] buf, boolean nosplit) throws IOException { checkedWrite(buf, buf.length, nosplit); } @@ -117,7 +117,7 @@ public class ASCII85OutputStream extends FilterOutputStream private void checkedWrite(byte[] buf , int len) throws IOException { checkedWrite(buf, len, false); } - + private void checkedWrite(byte[] buf , int len, boolean nosplit) throws IOException { if (posinline + len > 80) { int firstpart = (nosplit ? 0 : len - (posinline + len - 80)); @@ -155,24 +155,24 @@ public class ASCII85OutputStream extends FilterOutputStream if (word < 0) { word = -word; } - byte c1 = - (byte)((word + byte c1 = + (byte)((word / POW85[0]) & 0xFF); - byte c2 = - (byte)(((word - (c1 * POW85[0])) + byte c2 = + (byte)(((word - (c1 * POW85[0])) / POW85[1]) & 0xFF); byte c3 = - (byte)(((word - (c1 * POW85[0]) + (byte)(((word - (c1 * POW85[0]) - (c2 * POW85[1])) / POW85[2]) & 0xFF); byte c4 = - (byte)(((word - (c1 * POW85[0]) - - (c2 * POW85[1]) + (byte)(((word - (c1 * POW85[0]) + - (c2 * POW85[1]) - (c3 * POW85[2])) / POW85[3]) & 0xFF); byte c5 = - (byte)(((word - (c1 * POW85[0]) - - (c2 * POW85[1]) + (byte)(((word - (c1 * POW85[0]) + - (c2 * POW85[1]) - (c3 * POW85[2]) - (c4 * POW85[3]))) & 0xFF); @@ -195,7 +195,7 @@ public class ASCII85OutputStream extends FilterOutputStream } } - /** @see org.apache.fop.render.ps.Finalizable **/ + /** @see Finalizable **/ public void finalizeStream() throws IOException { // now take care of the trailing few bytes. // with n leftover bytes, we append 0 bytes to make a full group of 4 diff --git a/src/java/org/apache/fop/util/ASCIIHexOutputStream.java b/src/java/org/apache/fop/util/ASCIIHexOutputStream.java index dadca8f1f..c5db98496 100644 --- a/src/java/org/apache/fop/util/ASCIIHexOutputStream.java +++ b/src/java/org/apache/fop/util/ASCIIHexOutputStream.java @@ -3,34 +3,34 @@ * ============================================================================ * 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 @@ -42,12 +42,12 @@ * (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 . For more information on the Apache * Software Foundation, please see . - */ + */ package org.apache.fop.util; import java.io.OutputStream; @@ -109,7 +109,7 @@ public class ASCIIHexOutputStream extends FilterOutputStream } - /** @see org.apache.fop.render.ps.Finalizable **/ + /** @see Finalizable **/ public void finalizeStream() throws IOException { checkLineWrap(); //Write closing character ">" diff --git a/src/java/org/apache/fop/util/FlateEncodeOutputStream.java b/src/java/org/apache/fop/util/FlateEncodeOutputStream.java index f008b3d28..3e7640e69 100644 --- a/src/java/org/apache/fop/util/FlateEncodeOutputStream.java +++ b/src/java/org/apache/fop/util/FlateEncodeOutputStream.java @@ -3,34 +3,34 @@ * ============================================================================ * 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 @@ -42,12 +42,12 @@ * (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 . For more information on the Apache * Software Foundation, please see . - */ + */ package org.apache.fop.util; import java.io.OutputStream; @@ -71,7 +71,7 @@ public class FlateEncodeOutputStream extends java.util.zip.DeflaterOutputStream } - /** @see org.apache.fop.render.ps.Finalizable **/ + /** @see Finalizable **/ public void finalizeStream() throws IOException { finish(); flush(); diff --git a/src/java/org/apache/fop/util/RunLengthEncodeOutputStream.java b/src/java/org/apache/fop/util/RunLengthEncodeOutputStream.java index b5ec142a9..54df124ca 100644 --- a/src/java/org/apache/fop/util/RunLengthEncodeOutputStream.java +++ b/src/java/org/apache/fop/util/RunLengthEncodeOutputStream.java @@ -3,34 +3,34 @@ * ============================================================================ * 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 @@ -42,12 +42,12 @@ * (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 . For more information on the Apache * Software Foundation, please see . - */ + */ package org.apache.fop.util; import java.io.FilterOutputStream; @@ -185,7 +185,7 @@ public class RunLengthEncodeOutputStream extends FilterOutputStream } - /** @see org.apache.fop.render.ps.Finalizable **/ + /** @see Finalizable **/ public void finalizeStream() throws IOException { switch (isSequence) {