diff options
Diffstat (limited to 'src/java/org/apache/fop/render')
9 files changed, 24 insertions, 29 deletions
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 { /* |