diff options
Diffstat (limited to 'src/java/org')
24 files changed, 37 insertions, 71 deletions
diff --git a/src/java/org/apache/fop/afp/goca/GraphicsChainedSegment.java b/src/java/org/apache/fop/afp/goca/GraphicsChainedSegment.java index 1162e83aa..8d94bf9fc 100644 --- a/src/java/org/apache/fop/afp/goca/GraphicsChainedSegment.java +++ b/src/java/org/apache/fop/afp/goca/GraphicsChainedSegment.java @@ -73,7 +73,6 @@ public final class GraphicsChainedSegment extends AbstractGraphicsDrawingOrderCo return NAME_LENGTH; } - /** {@inheritDoc} */ byte getOrderCode() { return 0x70; } diff --git a/src/java/org/apache/fop/afp/svg/AFPTextHandler.java b/src/java/org/apache/fop/afp/svg/AFPTextHandler.java index b7393a3b2..975210375 100644 --- a/src/java/org/apache/fop/afp/svg/AFPTextHandler.java +++ b/src/java/org/apache/fop/afp/svg/AFPTextHandler.java @@ -73,7 +73,6 @@ public class AFPTextHandler implements FOPTextHandler { * Registers a page font * * @param internalFontName the internal font name - * @param internalFontName the internal font name * @param fontSize the font size * @return a font reference */ diff --git a/src/java/org/apache/fop/afp/util/DTDEntityResolver.java b/src/java/org/apache/fop/afp/util/DTDEntityResolver.java index dcf5ad7d9..b4eb7fc23 100644 --- a/src/java/org/apache/fop/afp/util/DTDEntityResolver.java +++ b/src/java/org/apache/fop/afp/util/DTDEntityResolver.java @@ -98,7 +98,7 @@ public class DTDEntityResolver implements EntityResolver { /** * Returns the URL of a resource on the classpath - * @param resourceName the path to the resource relative to the root of the + * @param resourcePath the path to the resource relative to the root of the * classpath. * @return the URL of the required resource * @throws FontRuntimeException if the resource could not be found. diff --git a/src/java/org/apache/fop/fo/flow/table/TableRow.java b/src/java/org/apache/fop/fo/flow/table/TableRow.java index 2feb45d86..dd9f7c6d4 100644 --- a/src/java/org/apache/fop/fo/flow/table/TableRow.java +++ b/src/java/org/apache/fop/fo/flow/table/TableRow.java @@ -144,7 +144,6 @@ public class TableRow extends TableCellContainer implements BreakPropertySet { return (TablePart) parent; } - /** {@inheritDoc} */ boolean isTableRow() { return true; } diff --git a/src/java/org/apache/fop/fo/properties/CompoundPropertyMaker.java b/src/java/org/apache/fop/fo/properties/CompoundPropertyMaker.java index 45f6b2e9f..f7381dba7 100644 --- a/src/java/org/apache/fop/fo/properties/CompoundPropertyMaker.java +++ b/src/java/org/apache/fop/fo/properties/CompoundPropertyMaker.java @@ -101,7 +101,7 @@ public class CompoundPropertyMaker extends PropertyMaker { * Calculate the real value of a subproperty by unmasking and shifting * the value into the range [0 - (COMPOUND_COUNT-1)]. * The value is used as index into the subproperties array. - * @param propId the property id of the sub property. + * @param subpropertyId the property id of the sub property. * @return the array index. */ private int getSubpropIndex(int subpropertyId) { diff --git a/src/java/org/apache/fop/fonts/autodetect/FontInfoFinder.java b/src/java/org/apache/fop/fonts/autodetect/FontInfoFinder.java index e2858e2f7..9f0fa9fd6 100644 --- a/src/java/org/apache/fop/fonts/autodetect/FontInfoFinder.java +++ b/src/java/org/apache/fop/fonts/autodetect/FontInfoFinder.java @@ -70,7 +70,7 @@ public class FontInfoFinder { * It seems to be fairly accurate but will probably require some tweaking over time * * @param customFont CustomFont - * @param triplet Collection that will take the generated triplets + * @param triplets Collection that will take the generated triplets */ private void generateTripletsFromFont(CustomFont customFont, Collection triplets) { if (log.isTraceEnabled()) { @@ -138,7 +138,7 @@ public class FontInfoFinder { * @param fontUrl the font URL * @param customFont the custom font * @param fontCache font cache (may be null) - * @return + * @return FontInfo from the given custom font */ private EmbedFontInfo getFontInfoFromCustomFont( URL fontUrl, CustomFont customFont, FontCache fontCache) { diff --git a/src/java/org/apache/fop/layoutmgr/inline/AbstractPageNumberCitationLayoutManager.java b/src/java/org/apache/fop/layoutmgr/inline/AbstractPageNumberCitationLayoutManager.java index a74fac743..c2dde9f9e 100644 --- a/src/java/org/apache/fop/layoutmgr/inline/AbstractPageNumberCitationLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/inline/AbstractPageNumberCitationLayoutManager.java @@ -99,10 +99,9 @@ public abstract class AbstractPageNumberCitationLayoutManager extends LeafNodeLa } /** - * If id can be resolved then simply return a word, otherwise + * If id can be resolved then simply return a text area, otherwise * return a resolvable area * - * @param parentLM the parent LayoutManager * @return a corresponding InlineArea */ private InlineArea getPageNumberCitationInlineArea() { diff --git a/src/java/org/apache/fop/layoutmgr/inline/AlignmentContext.java b/src/java/org/apache/fop/layoutmgr/inline/AlignmentContext.java index 4eb0abd64..efe006d14 100644 --- a/src/java/org/apache/fop/layoutmgr/inline/AlignmentContext.java +++ b/src/java/org/apache/fop/layoutmgr/inline/AlignmentContext.java @@ -307,7 +307,6 @@ public class AlignmentContext implements Constants { * Calculates the baseline shift value based on the baseline-shift * property value. * @param baselineShift the baseline shift property value - * @return the computed baseline shift value */ private void setBaselineShift(Length baselineShift) { baselineShiftValue = 0; diff --git a/src/java/org/apache/fop/pdf/PDFEncryptionJCE.java b/src/java/org/apache/fop/pdf/PDFEncryptionJCE.java index 43a323335..90b530774 100644 --- a/src/java/org/apache/fop/pdf/PDFEncryptionJCE.java +++ b/src/java/org/apache/fop/pdf/PDFEncryptionJCE.java @@ -80,26 +80,6 @@ public class PDFEncryptionJCE extends PDFObject implements PDFEncryption { } /** - * Encode the given data with the filter - * @param data The data to be encrypted - * @return The encrypted data - */ - public byte[] encode(byte[] data) { - return encryption.encryptData(data, number, generation); - } - - /** - * {@inheritDoc} - */ - public void encode(InputStream in, OutputStream out, int length) - throws IOException { - byte[] buffer = new byte[length]; - in.read(buffer); - buffer = encode(buffer); - out.write(buffer); - } - - /** * {@inheritDoc} */ public OutputStream applyFilter(OutputStream out) throws IOException { diff --git a/src/java/org/apache/fop/pdf/PDFNull.java b/src/java/org/apache/fop/pdf/PDFNull.java index 01ec7898c..7e11a1763 100644 --- a/src/java/org/apache/fop/pdf/PDFNull.java +++ b/src/java/org/apache/fop/pdf/PDFNull.java @@ -33,7 +33,6 @@ public final class PDFNull implements PDFWritable { /** * Creates a new PDF name object. - * @param name the name value */ private PDFNull() { } diff --git a/src/java/org/apache/fop/pdf/PDFToUnicodeCMap.java b/src/java/org/apache/fop/pdf/PDFToUnicodeCMap.java index 95999b73f..56ca884f9 100644 --- a/src/java/org/apache/fop/pdf/PDFToUnicodeCMap.java +++ b/src/java/org/apache/fop/pdf/PDFToUnicodeCMap.java @@ -79,7 +79,6 @@ public class PDFToUnicodeCMap extends PDFCMap { /** * Writes the CMap to a Writer. - * @param writer the writer * @throws IOException if an I/O error occurs */ public void writeCMap() throws IOException { @@ -94,7 +93,6 @@ public class PDFToUnicodeCMap extends PDFCMap { /** * Writes the character mappings for this font. - * @param p StingBuffer to write to */ protected void writeBFEntries() throws IOException { if (unicodeCharMap != null) { @@ -106,7 +104,6 @@ public class PDFToUnicodeCMap extends PDFCMap { /** * Writes the entries for single characters of a base font (only characters which cannot be * expressed as part of a character range). - * @param p StringBuffer to write to * @param charArray all the characters to map * @throws IOException */ @@ -147,7 +144,6 @@ public class PDFToUnicodeCMap extends PDFCMap { /** * Writes the entries for character ranges for a base font. - * @param p StringBuffer to write to * @param charArray all the characters to map * @throws IOException */ diff --git a/src/java/org/apache/fop/render/afp/AFPRendererConfigurator.java b/src/java/org/apache/fop/render/afp/AFPRendererConfigurator.java index 1720667df..77d02b8c5 100644 --- a/src/java/org/apache/fop/render/afp/AFPRendererConfigurator.java +++ b/src/java/org/apache/fop/render/afp/AFPRendererConfigurator.java @@ -149,7 +149,7 @@ public class AFPRendererConfigurator extends PrintRendererConfigurator * @param encoding character encoding e.g. 'Cp500', 'UnicodeBigUnmarked' * @param accessor * @param afpFontCfg - * @return + * @return the created AFPFont * @throws ConfigurationException */ private AFPFont fontFromType(String type, String codepage, String encoding, diff --git a/src/java/org/apache/fop/render/bitmap/PNGRenderer_onthefly.java b/src/java/org/apache/fop/render/bitmap/PNGRenderer_onthefly.java index a6a6e8dfe..b85ee9d1c 100644 --- a/src/java/org/apache/fop/render/bitmap/PNGRenderer_onthefly.java +++ b/src/java/org/apache/fop/render/bitmap/PNGRenderer_onthefly.java @@ -125,7 +125,7 @@ public class PNGRenderer_onthefly extends Java2DRenderer { /** * Builds the OutputStream corresponding to this page - * @param 0-based pageNumber + * @param pageNumber the 0-based page number * @return the corresponding OutputStream */ private OutputStream getCurrentOutputStream(int pageNumber) { diff --git a/src/java/org/apache/fop/render/pdf/PDFPainter.java b/src/java/org/apache/fop/render/pdf/PDFPainter.java index f72f09ad0..161b46617 100644 --- a/src/java/org/apache/fop/render/pdf/PDFPainter.java +++ b/src/java/org/apache/fop/render/pdf/PDFPainter.java @@ -162,10 +162,7 @@ public class PDFPainter extends AbstractIFPainter { /** * Places a previously registered image at a certain place on the page. - * @param x X coordinate - * @param y Y coordinate - * @param w width for image - * @param h height for image + * @param rect the rectangle for the image * @param xobj the image XObject */ private void placeImage(Rectangle rect, PDFXObject xobj) { @@ -179,10 +176,7 @@ public class PDFPainter extends AbstractIFPainter { } /** * Places a previously registered image at a certain place on the page - Accessibility version - * @param x X coordinate - * @param y Y coordinate - * @param w width for image - * @param h height for image + * @param rect the rectangle for the image * @param xobj the image XObject */ private void placeImageAccess(Rectangle rect, PDFXObject xobj) { diff --git a/src/java/org/apache/fop/render/rtf/TableAttributesConverter.java b/src/java/org/apache/fop/render/rtf/TableAttributesConverter.java index 764c2c93e..2944b230a 100644 --- a/src/java/org/apache/fop/render/rtf/TableAttributesConverter.java +++ b/src/java/org/apache/fop/render/rtf/TableAttributesConverter.java @@ -65,11 +65,8 @@ public final class TableAttributesConverter { /** * Converts table-only attributes to rtf attributes. * - * @param attrs Given attributes - * @param defaultAttributes Default rtf attributes - * + * @param fobj the table for which the attributes are converted * @return All valid rtf attributes together - * * @throws ConverterException On convertion error */ static RtfAttributes convertTableAttributes(Table fobj) @@ -83,11 +80,8 @@ public final class TableAttributesConverter { /** * Converts table-only attributes to rtf attributes. * - * @param attrs Given attributes - * @param defaultAttributes Default rtf attributes - * + * @param part the table part for which the attributes are converted * @return All valid rtf attributes together - * * @throws ConverterException On convertion error */ static RtfAttributes convertTablePartAttributes(TablePart part) @@ -226,8 +220,6 @@ public final class TableAttributesConverter { * Converts table and row attributes to rtf attributes. * * @param fobj FObj to be converted - * @param defaultAttributes Default rtf attributes - * * @return All valid rtf attributes together * @throws ConverterException On converion error */ diff --git a/src/java/org/apache/fop/render/rtf/TextAttributesConverter.java b/src/java/org/apache/fop/render/rtf/TextAttributesConverter.java index 63c470b5d..ee840b4aa 100644 --- a/src/java/org/apache/fop/render/rtf/TextAttributesConverter.java +++ b/src/java/org/apache/fop/render/rtf/TextAttributesConverter.java @@ -68,7 +68,7 @@ final class TextAttributesConverter { /** * Converts all known text FO properties to RtfAttributes - * @param props list of FO properites, which are to be converted + * @param fobj the FO for which the attributes are to be converted */ public static RtfAttributes convertAttributes(Block fobj) throws FOPException { @@ -86,7 +86,7 @@ final class TextAttributesConverter { /** * Converts all known text FO properties to RtfAttributes - * @param props list of FO properites, which are to be converted + * @param fobj FObj whose properties are to be converted */ public static RtfAttributes convertBlockContainerAttributes(BlockContainer fobj) throws FOPException { @@ -442,7 +442,7 @@ final class TextAttributesConverter { /** * Reads background-color from bl and writes it to rtfAttr. * - * @param bl the Block object the properties are read from + * @param bph the CommonBorderPaddingBackground from which the properties are read * @param rtfAttr the RtfAttributes object the attributes are written to */ private static void attrBackgroundColor(CommonBorderPaddingBackground bpb, diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmark.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmark.java index f691c211c..7da14061e 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmark.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmark.java @@ -59,8 +59,8 @@ public class RtfBookmark extends RtfElement { * @param writer a <code>Writer</code> value * @param bookmark Name of the bookmark */ - RtfBookmark (RtfContainer parent, Writer w, String bookmark) throws IOException { - super (parent, w); + RtfBookmark (RtfContainer parent, Writer writer, String bookmark) throws IOException { + super (parent, writer); int now = bookmark.length (); diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExternalGraphic.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExternalGraphic.java index 6123ac563..78c747a30 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExternalGraphic.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExternalGraphic.java @@ -87,8 +87,8 @@ public class RtfExternalGraphic extends RtfElement { /** * Convert image data if necessary - for example when format is not supported by rtf. * + * @param format Format type * @param data Image - * @param type Format type */ public FormatBase convert(FormatBase format, byte[] data) { return format; diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFootnote.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFootnote.java index f3b2ebf72..3fe8c6311 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFootnote.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFootnote.java @@ -38,13 +38,22 @@ public class RtfFootnote extends RtfContainer RtfList list = null; boolean bBody = false; - /** Create an RTF list item as a child of given container with default attributes */ + /** + * Create an RTF list item as a child of given container with default attributes. + * @param parent a container + * @param w a writer + * @throws IOException if not caught + */ RtfFootnote(RtfContainer parent, Writer w) throws IOException { super(parent, w); textrunInline = new RtfTextrun(this, writer, null); body = new RtfContainer(this, writer); } + /** + * @return a text run + * @throws IOException if not caught + */ public RtfTextrun getTextrun() throws IOException { if (bBody) { RtfTextrun textrun = RtfTextrun.getTextrun(body, writer, null); diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableCell.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableCell.java index 09c39be12..da11de1bc 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableCell.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableCell.java @@ -181,8 +181,8 @@ public class RtfTableCell } /** used by RtfTableRow to write the <celldef> cell definition control words - * @param widthOffset sum of the widths of preceeding cells in same row - * @return widthOffset + width of this cell + * @param offset sum of the widths of preceeding cells in same row + * @return offset + width of this cell */ int writeCellDef(int offset) throws IOException { /* diff --git a/src/java/org/apache/fop/svg/PDFGraphicsDevice.java b/src/java/org/apache/fop/svg/PDFGraphicsDevice.java index 5da2d50ee..1d3dd6196 100644 --- a/src/java/org/apache/fop/svg/PDFGraphicsDevice.java +++ b/src/java/org/apache/fop/svg/PDFGraphicsDevice.java @@ -39,7 +39,7 @@ class PDFGraphicsDevice extends GraphicsDevice { /** * Create a new PDF graphics device. * - * @param The gc we should reference + * @param gc The graphics configuration we should reference */ PDFGraphicsDevice(PDFGraphicsConfiguration gc) { this.gc = gc; diff --git a/src/java/org/apache/fop/svg/PDFTextPainter.java b/src/java/org/apache/fop/svg/PDFTextPainter.java index e962d5a59..fe8ad1c7e 100644 --- a/src/java/org/apache/fop/svg/PDFTextPainter.java +++ b/src/java/org/apache/fop/svg/PDFTextPainter.java @@ -40,7 +40,7 @@ import org.apache.fop.fonts.FontInfo; import org.apache.fop.util.CharUtilities; /** - * Renders the attributed character iterator of a {@link TextNode}. + * Renders the attributed character iterator of a {@link org.apache.batik.gvt.TextNode}. * This class draws the text directly into the PDFGraphics2D so that * the text is not drawn using shapes which makes the PDF files larger. * If the text is simple enough to draw then it sets the font and calls diff --git a/src/java/org/apache/fop/tools/anttasks/FileCompare.java b/src/java/org/apache/fop/tools/anttasks/FileCompare.java index d9b64226a..697570fb7 100644 --- a/src/java/org/apache/fop/tools/anttasks/FileCompare.java +++ b/src/java/org/apache/fop/tools/anttasks/FileCompare.java @@ -91,7 +91,9 @@ public class FileCompare { /** * Compare the contents of two files. - * @param true if files are same byte-by-byte, false otherwise + * @param file1 the first file to compare + * @param file2 the second file to compare + * @return true if files are same byte-by-byte, false otherwise */ private static boolean compareBytes(File file1, File file2) throws IOException { BufferedInputStream file1Input = @@ -116,7 +118,9 @@ public class FileCompare { /** * Does a file size compare of two files - * @param true if files are same length, false otherwise + * @param file1 the first file to compare + * @param file2 the second file to compare + * @return true if files are same length, false otherwise */ private static boolean compareFileSize(File oldFile, File newFile) { if (oldFile.length() != newFile.length()) { diff --git a/src/java/org/apache/fop/tools/anttasks/Fop.java b/src/java/org/apache/fop/tools/anttasks/Fop.java index cfb8c8ade..d13bd8a56 100644 --- a/src/java/org/apache/fop/tools/anttasks/Fop.java +++ b/src/java/org/apache/fop/tools/anttasks/Fop.java @@ -489,9 +489,6 @@ class FOPTaskStarter { return new File(file.getParentFile(), name); } - /** - * {@inheritDoc} - */ public void run() throws FOPException { //Set base directory if (task.getBasedir() != null) { |