Browse Source

Fix javadocs under java 8

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@1805173 13f79535-47bb-0310-9956-ffa450edef68
pull/6/head
Simon Steiner 6 years ago
parent
commit
f7a782fe06
100 changed files with 134 additions and 154 deletions
  1. 0
    1
      fop-core/src/main/java/org/apache/fop/apps/FopFactory.java
  2. 1
    1
      fop-core/src/main/java/org/apache/fop/apps/FopFactoryBuilder.java
  3. 1
    1
      fop-core/src/main/java/org/apache/fop/area/Block.java
  4. 2
    2
      fop-core/src/main/java/org/apache/fop/area/BookmarkData.java
  5. 1
    1
      fop-core/src/main/java/org/apache/fop/area/Resolvable.java
  6. 1
    1
      fop-core/src/main/java/org/apache/fop/area/inline/InlineArea.java
  7. 2
    2
      fop-core/src/main/java/org/apache/fop/area/inline/InlineParent.java
  8. 1
    1
      fop-core/src/main/java/org/apache/fop/cli/AreaTreeInputHandler.java
  9. 1
    1
      fop-core/src/main/java/org/apache/fop/cli/IFInputHandler.java
  10. 1
    1
      fop-core/src/main/java/org/apache/fop/cli/InputHandler.java
  11. 1
    1
      fop-core/src/main/java/org/apache/fop/complexscripts/fonts/GlyphPositioningTable.java
  12. 4
    4
      fop-core/src/main/java/org/apache/fop/complexscripts/fonts/GlyphSubstitutionTable.java
  13. 3
    3
      fop-core/src/main/java/org/apache/fop/complexscripts/fonts/GlyphTable.java
  14. 1
    1
      fop-core/src/main/java/org/apache/fop/complexscripts/fonts/OTFAdvancedTypographicTableReader.java
  15. 2
    2
      fop-core/src/main/java/org/apache/fop/complexscripts/util/CharAssociation.java
  16. 1
    1
      fop-core/src/main/java/org/apache/fop/complexscripts/util/GlyphSequence.java
  17. 0
    2
      fop-core/src/main/java/org/apache/fop/datatypes/Numeric.java
  18. 1
    1
      fop-core/src/main/java/org/apache/fop/datatypes/URISpecification.java
  19. 1
    1
      fop-core/src/main/java/org/apache/fop/fo/FONode.java
  20. 1
    1
      fop-core/src/main/java/org/apache/fop/fo/FOText.java
  21. 1
    1
      fop-core/src/main/java/org/apache/fop/fo/PropertyList.java
  22. 1
    1
      fop-core/src/main/java/org/apache/fop/fo/StringCharIterator.java
  23. 1
    1
      fop-core/src/main/java/org/apache/fop/fo/expr/NumericProperty.java
  24. 1
    1
      fop-core/src/main/java/org/apache/fop/fo/flow/BlockContainer.java
  25. 2
    2
      fop-core/src/main/java/org/apache/fop/fo/flow/ListBlock.java
  26. 2
    2
      fop-core/src/main/java/org/apache/fop/fo/flow/ListItem.java
  27. 2
    2
      fop-core/src/main/java/org/apache/fop/fo/flow/ListItemBody.java
  28. 2
    2
      fop-core/src/main/java/org/apache/fop/fo/flow/ListItemLabel.java
  29. 2
    2
      fop-core/src/main/java/org/apache/fop/fo/flow/Marker.java
  30. 0
    2
      fop-core/src/main/java/org/apache/fop/fo/flow/Markers.java
  31. 2
    2
      fop-core/src/main/java/org/apache/fop/fo/flow/Wrapper.java
  32. 2
    2
      fop-core/src/main/java/org/apache/fop/fo/flow/table/TableEventProducer.java
  33. 1
    1
      fop-core/src/main/java/org/apache/fop/fo/pagination/RegionBody.java
  34. 1
    1
      fop-core/src/main/java/org/apache/fop/fo/properties/LengthRangeProperty.java
  35. 1
    1
      fop-core/src/main/java/org/apache/fop/fo/properties/URIProperty.java
  36. 1
    1
      fop-core/src/main/java/org/apache/fop/fonts/CustomFont.java
  37. 3
    5
      fop-core/src/main/java/org/apache/fop/fonts/EmbedFontInfo.java
  38. 2
    2
      fop-core/src/main/java/org/apache/fop/fonts/FontCache.java
  39. 1
    1
      fop-core/src/main/java/org/apache/fop/fonts/MultiByteFont.java
  40. 2
    2
      fop-core/src/main/java/org/apache/fop/fonts/SingleByteFont.java
  41. 2
    2
      fop-core/src/main/java/org/apache/fop/fonts/XMLFontMetricsReader.java
  42. 4
    4
      fop-core/src/main/java/org/apache/fop/fonts/apps/PFMReader.java
  43. 4
    4
      fop-core/src/main/java/org/apache/fop/fonts/apps/TTFReader.java
  44. 1
    2
      fop-core/src/main/java/org/apache/fop/fonts/cff/CFFDataReader.java
  45. 3
    6
      fop-core/src/main/java/org/apache/fop/fonts/truetype/OpenFont.java
  46. 1
    1
      fop-core/src/main/java/org/apache/fop/fonts/type1/AdobeStandardEncoding.java
  47. 1
    1
      fop-core/src/main/java/org/apache/fop/fonts/type1/Type1FontLoader.java
  48. 2
    2
      fop-core/src/main/java/org/apache/fop/hyphenation/Hyphenation.java
  49. 4
    4
      fop-core/src/main/java/org/apache/fop/hyphenation/HyphenationTree.java
  50. 1
    1
      fop-core/src/main/java/org/apache/fop/layoutmgr/Adjustment.java
  51. 1
    1
      fop-core/src/main/java/org/apache/fop/layoutmgr/BlockStackingLayoutManager.java
  52. 2
    2
      fop-core/src/main/java/org/apache/fop/layoutmgr/BreakingAlgorithm.java
  53. 1
    1
      fop-core/src/main/java/org/apache/fop/layoutmgr/PageProvider.java
  54. 1
    1
      fop-core/src/main/java/org/apache/fop/layoutmgr/PositionIterator.java
  55. 1
    1
      fop-core/src/main/java/org/apache/fop/layoutmgr/SpaceResolver.java
  56. 1
    1
      fop-core/src/main/java/org/apache/fop/layoutmgr/inline/TextLayoutManager.java
  57. 1
    1
      fop-core/src/main/java/org/apache/fop/pdf/PDFRoot.java
  58. 1
    1
      fop-core/src/main/java/org/apache/fop/pdf/StructureHierarchyMember.java
  59. 0
    1
      fop-core/src/main/java/org/apache/fop/render/AbstractPathOrientedRenderer.java
  60. 1
    1
      fop-core/src/main/java/org/apache/fop/render/ImageHandlerBase.java
  61. 1
    1
      fop-core/src/main/java/org/apache/fop/render/afp/exceptions/RendererRuntimeException.java
  62. 1
    1
      fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPAttribute.java
  63. 1
    1
      fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPElementMapping.java
  64. 1
    2
      fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPIncludeFormMapElement.java
  65. 1
    1
      fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPPageOverlayElement.java
  66. 1
    1
      fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPPageSegmentElement.java
  67. 1
    2
      fop-core/src/main/java/org/apache/fop/render/bitmap/TIFFRenderer.java
  68. 1
    6
      fop-core/src/main/java/org/apache/fop/render/intermediate/BorderPainter.java
  69. 3
    3
      fop-core/src/main/java/org/apache/fop/render/intermediate/IFContext.java
  70. 1
    1
      fop-core/src/main/java/org/apache/fop/render/intermediate/IFSerializer.java
  71. 2
    2
      fop-core/src/main/java/org/apache/fop/render/pcl/PCLGenerator.java
  72. 2
    2
      fop-core/src/main/java/org/apache/fop/render/pcl/PCLPageDefinition.java
  73. 1
    1
      fop-core/src/main/java/org/apache/fop/render/pdf/PDFContentGenerator.java
  74. 1
    1
      fop-core/src/main/java/org/apache/fop/render/ps/AbstractPSTranscoder.java
  75. 1
    1
      fop-core/src/main/java/org/apache/fop/render/ps/EPSTranscoder.java
  76. 3
    3
      fop-core/src/main/java/org/apache/fop/render/ps/PSTextElementBridge.java
  77. 1
    1
      fop-core/src/main/java/org/apache/fop/render/ps/PSTextPainter.java
  78. 1
    1
      fop-core/src/main/java/org/apache/fop/render/ps/PSTranscoder.java
  79. 2
    2
      fop-core/src/main/java/org/apache/fop/render/ps/fonts/PSTTFGenerator.java
  80. 1
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/BorderAttributesConverter.java
  81. 0
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/RTFPlaceHolderHelper.java
  82. 1
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfException.java
  83. 1
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfStructureException.java
  84. 1
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IBorderAttributes.java
  85. 1
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfAfterContainer.java
  86. 1
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfBeforeContainer.java
  87. 1
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfBookmarkContainer.java
  88. 1
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfExternalGraphicContainer.java
  89. 1
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfHyperLinkContainer.java
  90. 1
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfJforCmdContainer.java
  91. 1
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfListContainer.java
  92. 1
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfOptions.java
  93. 1
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageBreakContainer.java
  94. 1
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageContainer.java
  95. 1
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageNumberCitationContainer.java
  96. 1
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageNumberContainer.java
  97. 1
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfParagraphContainer.java
  98. 1
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfParagraphKeepTogetherContainer.java
  99. 1
    1
      fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTableContainer.java
  100. 0
    0
      fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTextContainer.java

+ 0
- 1
fop-core/src/main/java/org/apache/fop/apps/FopFactory.java View File

@@ -163,7 +163,6 @@ public final class FopFactory implements ImageContext {
* are particular to a rendering run. Don't reuse instances over multiple rendering runs but
* instead create a new one each time and reuse the FopFactory.
* @return the newly created FOUserAgent instance initialized with default values
* @throws FOPException
*/
public FOUserAgent newFOUserAgent() {
FOUserAgent userAgent = new FOUserAgent(this, resolver);

+ 1
- 1
fop-core/src/main/java/org/apache/fop/apps/FopFactoryBuilder.java View File

@@ -63,7 +63,7 @@ public final class FopFactoryBuilder {
/**
* A builder class for {@link FopFactory} which can be used for setting configuration. This is
* a helper constructor that uses the default URI resolver implementation that FOP packages
* provide ({@link org.apache.fop.apps.io.ResourceResolverFactory.DefaultResourceResolver}).
* provide.
*
* @param defaultBaseURI the default base URI for resolving URIs against
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/area/Block.java View File

@@ -169,7 +169,7 @@ public class Block extends BlockParent {
/**
* Sets the location in the source XML of the FO that generated this area.
*
* @location the line and column location
* @param location the line and column location
*/
public void setLocation(String location) {
this.location = location;

+ 2
- 2
fop-core/src/main/java/org/apache/fop/area/BookmarkData.java View File

@@ -95,7 +95,7 @@ public class BookmarkData extends AbstractOffDocumentItem implements Resolvable
/**
* Create a new bookmark data root object.
* This constructor is called by the AreaTreeParser when the
* <bookmarkTree> element is read from the XML file
* &lt;bookmarkTree&gt; element is read from the XML file
*/
public BookmarkData() {
idRef = null;
@@ -106,7 +106,7 @@ public class BookmarkData extends AbstractOffDocumentItem implements Resolvable
/**
* Create a new bookmark data object.
* This constructor is called by the AreaTreeParser when a
* <bookmark> element is read from the XML file.
* &lt;bookmark&gt; element is read from the XML file.
*
* @param title the bookmark's title
* @param showChildren whether to initially display the bookmark's children

+ 1
- 1
fop-core/src/main/java/org/apache/fop/area/Resolvable.java View File

@@ -23,7 +23,7 @@ import java.util.List;

/**
* Resolvable Interface. Classes that implement this interface contain
* idrefs (see Section 5.11 of spec for definition of <idref> datatype)
* idrefs (see Section 5.11 of spec for definition of &lt;idref&gt; datatype)
* that are resolved when their target IDs are added to the area tree.
*/
public interface Resolvable {

+ 1
- 1
fop-core/src/main/java/org/apache/fop/area/inline/InlineArea.java View File

@@ -291,7 +291,7 @@ public class InlineArea extends Area {
* elements.
*
* @return the offset that this area would have if the before-edge of its
* content-rectangle were coinciding with the <q>beforest</q> before-edge of its
* content-rectangle were coinciding with the beforest before-edge of its
* children allocation-rectangles.
* @see #getVirtualBPD()
* @see BasicLinkArea

+ 2
- 2
fop-core/src/main/java/org/apache/fop/area/inline/InlineParent.java View File

@@ -42,11 +42,11 @@ public class InlineParent extends InlineArea {
/** Controls whether the IPD is automatically adjusted based on the area's children. */
protected transient boolean autoSize;

/** The offset of the <q>beforest</q> child area of this area. */
/** The offset of the beforest child area of this area. */
protected int minChildOffset;

/**
* The offset of the <q>afterest</q> child area of this area. Offset from the
* The offset of the afterest child area of this area. Offset from the
* before-edge of this area's content-rectangle and the after-edge of the child area's
* allocation-rectangle.
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/cli/AreaTreeInputHandler.java View File

@@ -41,7 +41,7 @@ import org.apache.fop.fonts.FontInfo;
public class AreaTreeInputHandler extends InputHandler {

/**
* Constructor for XML->XSLT->area tree XML input
* Constructor for XML-&gt;XSLT-&gt;area tree XML input
* @param xmlfile XML file
* @param xsltfile XSLT file
* @param params Vector of command-line parameters (name, value,

+ 1
- 1
fop-core/src/main/java/org/apache/fop/cli/IFInputHandler.java View File

@@ -40,7 +40,7 @@ import org.apache.fop.render.intermediate.IFUtil;
public class IFInputHandler extends InputHandler {

/**
* Constructor for XML->XSLT->intermediate XML input
* Constructor for XML-&gt;XSLT-&gt;intermediate XML input
* @param xmlfile XML file
* @param xsltfile XSLT file
* @param params Vector of command-line parameters (name, value,

+ 1
- 1
fop-core/src/main/java/org/apache/fop/cli/InputHandler.java View File

@@ -72,7 +72,7 @@ public class InputHandler implements ErrorListener, Renderable {
protected Log log = LogFactory.getLog(InputHandler.class);

/**
* Constructor for XML->XSLT->FO input
* Constructor for XML-&gt;XSLT-&gt;FO input
*
* @param xmlfile XML file
* @param xsltfile XSLT file

+ 1
- 1
fop-core/src/main/java/org/apache/fop/complexscripts/fonts/GlyphPositioningTable.java View File

@@ -1791,7 +1791,7 @@ public class GlyphPositioningTable extends GlyphTable {
}

/**
* Find device adjustment.
* Find device adjustment. asf.todo at present, assumes that 1 device unit equals one point
* @param fontSize the font size to search for
* @return an adjustment if font size matches an entry
*/

+ 4
- 4
fop-core/src/main/java/org/apache/fop/complexscripts/fonts/GlyphSubstitutionTable.java View File

@@ -1315,8 +1315,8 @@ public class GlyphSubstitutionTable extends GlyphTable {

/**
* The <code>Ligature</code> class implements a ligature lookup result in terms of
* a ligature glyph (code) and the <emph>N+1...</emph> components that comprise the ligature,
* where the <emph>Nth</emph> component was consumed in the coverage table lookup mapping to
* a ligature glyph (code) and the N+1... components that comprise the ligature,
* where the Nth component was consumed in the coverage table lookup mapping to
* this ligature instance.
*/
public static class Ligature {
@@ -1327,7 +1327,7 @@ public class GlyphSubstitutionTable extends GlyphTable {
/**
* Instantiate a ligature.
* @param ligature glyph id
* @param components sequence of <emph>N+1...</emph> component glyph (or character) identifiers
* @param components sequence of N+1... component glyph (or character) identifiers
*/
public Ligature(int ligature, int[] components) {
if ((ligature < 0) || (ligature > 65535)) {
@@ -1350,7 +1350,7 @@ public class GlyphSubstitutionTable extends GlyphTable {
return ligature;
}

/** @return array of <emph>N+1...</emph> components */
/** @return array of N+1... components */
public int[] getComponents() {
return components;
}

+ 3
- 3
fop-core/src/main/java/org/apache/fop/complexscripts/fonts/GlyphTable.java View File

@@ -175,7 +175,7 @@ public class GlyphTable {
}

/**
* Match lookup specifications according to <script,language,feature> tuple, where
* Match lookup specifications according to &lt;script,language,feature&gt; tuple, where
* '*' is a wildcard for a tuple component.
* @param script a script identifier
* @param language a language identifier
@@ -208,7 +208,7 @@ public class GlyphTable {
}

/**
* Match lookup specifications according to <script,language,feature> tuple, where
* Match lookup specifications according to &lt;script,language,feature&gt; tuple, where
* '*' is a wildcard for a tuple component.
* @param script a script identifier
* @param language a language identifier
@@ -346,7 +346,7 @@ public class GlyphTable {
}

/**
* A structure class encapsulating a lookup specification as a <script,language,feature> tuple.
* A structure class encapsulating a lookup specification as a &lt;script,language,feature&gt; tuple.
*/
public static class LookupSpec implements Comparable {


+ 1
- 1
fop-core/src/main/java/org/apache/fop/complexscripts/fonts/OTFAdvancedTypographicTableReader.java View File

@@ -63,7 +63,7 @@ public final class OTFAdvancedTypographicTableReader {

/**
* Construct an <code>OTFAdvancedTypographicTableReader</code> instance.
* @param ttf parent font file reader (must be non-null)
* @param otf parent font file reader (must be non-null)
* @param in font file reader (must be non-null)
*/
public OTFAdvancedTypographicTableReader(OpenFont otf, FontFileReader in) {

+ 2
- 2
fop-core/src/main/java/org/apache/fop/complexscripts/util/CharAssociation.java View File

@@ -145,7 +145,7 @@ public class CharAssociation implements Cloneable {
}

/**
* Set predication <KEY,VALUE>.
* Set predication &lt;KEY,VALUE&gt;.
* @param key predication key
* @param value predication value
*/
@@ -172,7 +172,7 @@ public class CharAssociation implements Cloneable {
}

/**
* Merge predication <KEY,VALUE>.
* Merge predication &lt;KEY,VALUE&gt;.
* @param key predication key
* @param value predication value
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/complexscripts/util/GlyphSequence.java View File

@@ -303,7 +303,7 @@ public class GlyphSequence implements Cloneable {
}

/**
* Set predication <KEY,VALUE> at glyph sequence OFFSET.
* Set predication &lt;KEY,VALUE&gt; at glyph sequence OFFSET.
* @param offset offset (index) into glyph sequence
* @param key predication key
* @param value predication value

+ 0
- 2
fop-core/src/main/java/org/apache/fop/datatypes/Numeric.java View File

@@ -35,7 +35,6 @@ public interface Numeric {
/**
* Return the value of this Numeric
* @return the computed value.
* @throws PropertyException if a property exception occurs
*/
double getNumericValue();

@@ -43,7 +42,6 @@ public interface Numeric {
* Return the value of this Numeric
* @param context The context for the length calculation (for percentage based lengths)
* @return the computed value.
* @throws PropertyException if a property exception occurs
*/
double getNumericValue(PercentBaseContext context);


+ 1
- 1
fop-core/src/main/java/org/apache/fop/datatypes/URISpecification.java View File

@@ -23,7 +23,7 @@ import java.io.UnsupportedEncodingException;


/**
* This class contains method to deal with the <uri-specification> datatype from XSL-FO.
* This class contains method to deal with the &lt;uri-specification&gt; datatype from XSL-FO.
*/
public final class URISpecification {


+ 1
- 1
fop-core/src/main/java/org/apache/fop/fo/FONode.java View File

@@ -1013,7 +1013,7 @@ public abstract class FONode implements Cloneable {

/**
* Base iterator interface over a FO's children, offering three methods on top of the base interface
* methods {@see java.util.ListIterator}.
* methods.
*/
public interface FONodeIterator extends ListIterator<FONode> {


+ 1
- 1
fop-core/src/main/java/org/apache/fop/fo/FOText.java View File

@@ -212,7 +212,7 @@ public class FOText extends FONode implements CharSequence, TextFragment {
* Check if this text node will create an area.
* This means either there is non-whitespace or it is
* preserved whitespace.
* Maybe this just needs to check length > 0, since char iterators
* Maybe this just needs to check length &gt; 0, since char iterators
* handle whitespace.
*
* @return true if this will create an area in the output

+ 1
- 1
fop-core/src/main/java/org/apache/fop/fo/PropertyList.java View File

@@ -335,7 +335,7 @@ public abstract class PropertyList {
* <li>number-columns-spanned</li>
* <li>font</li>
* <li>font-size</li>
* <li><emph>all others in order of appearance</emph></li>
* <li>all others in order of appearance</li>
* </ol>
*
* @param attributes Collection of attributes passed to us from the parser.

+ 1
- 1
fop-core/src/main/java/org/apache/fop/fo/StringCharIterator.java View File

@@ -31,7 +31,7 @@ public class StringCharIterator extends CharIterator {

/**
* Constructor
* @param c the character that this iterator should iterate.
* @param s the character that this iterator should iterate.
*/
public StringCharIterator(String s) {
this.index = -1;

+ 1
- 1
fop-core/src/main/java/org/apache/fop/fo/expr/NumericProperty.java View File

@@ -42,7 +42,7 @@ public class NumericProperty extends Property implements Numeric, Length {
* including absolute length, percent length, table units.
* @param value The value of the numeric.
* @param dim The dimension of the value. 0 for a Number, 1 for a Length
* (any type), >1, <0 if Lengths have been multiplied or divided.
* (any type), &gt;1, &lt;0 if Lengths have been multiplied or divided.
*/
protected NumericProperty(double value, int dim) {
this.value = value;

+ 1
- 1
fop-core/src/main/java/org/apache/fop/fo/flow/BlockContainer.java View File

@@ -112,7 +112,7 @@ public class BlockContainer extends FObj implements BreakPropertySet, WritingMod
/**
* {@inheritDoc}
* <br>XSL Content Model: marker* (%block;)+
* <br><i><b>BUT</b>: "In addition an fo:block-container that does not generate an
* <br><b>BUT</b>: "In addition an fo:block-container that does not generate an
* absolutely positioned area may have a sequence of zero or more
* fo:markers as its initial children."
* The latter refers to block-containers with absolute-position="absolute"

+ 2
- 2
fop-core/src/main/java/org/apache/fop/fo/flow/ListBlock.java View File

@@ -35,8 +35,8 @@ import org.apache.fop.fo.properties.CommonMarginBlock;
import org.apache.fop.fo.properties.KeepProperty;

/**
* Class modelling the <a href=http://www.w3.org/TR/xsl/#fo_list-block">
* <code>fo:list-block</code></a> object.
* Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_list-block">list block</a>
* <code>fo:list-block</code> object.
*/
public class ListBlock extends FObj implements BreakPropertySet, CommonAccessibilityHolder {
// The value of properties relevant for fo:list-block.

+ 2
- 2
fop-core/src/main/java/org/apache/fop/fo/flow/ListItem.java View File

@@ -37,8 +37,8 @@ import org.apache.fop.fo.properties.CommonMarginBlock;
import org.apache.fop.fo.properties.KeepProperty;

/**
* Class modelling the <a href=http://www.w3.org/TR/xsl/#fo_list-item">
* <code>fo:list-item</code></a> object.
* Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_list-item">list item</a>
* <code>fo:list-item</code> object.
*/
public class ListItem extends FObj implements BreakPropertySet, CommonAccessibilityHolder {
// The value of properties relevant for fo:list-item.

+ 2
- 2
fop-core/src/main/java/org/apache/fop/fo/flow/ListItemBody.java View File

@@ -23,8 +23,8 @@ import org.apache.fop.apps.FOPException;
import org.apache.fop.fo.FONode;

/**
* Class modelling the <a href=http://www.w3.org/TR/xsl/#fo_list-item-body">
* <code>fo:list-item-body object</code></a>.
* Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_list-item-body">list item</a>
* <code>fo:list-item-body object</code>.
*/
public class ListItemBody extends AbstractListItemPart {


+ 2
- 2
fop-core/src/main/java/org/apache/fop/fo/flow/ListItemLabel.java View File

@@ -23,8 +23,8 @@ import org.apache.fop.apps.FOPException;
import org.apache.fop.fo.FONode;

/**
* Class modelling the <a href=http://www.w3.org/TR/xsl/#fo_list-item-label">
* <code>fo:list-item-label</code></a> object.
* Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_list-item-label">list item</a>
* <code>fo:list-item-label</code> object.
*/
public class ListItemLabel extends AbstractListItemPart {


+ 2
- 2
fop-core/src/main/java/org/apache/fop/fo/flow/Marker.java View File

@@ -36,8 +36,8 @@ import org.apache.fop.fo.properties.Property;
import org.apache.fop.fo.properties.PropertyCache;

/**
* Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_marker">
* <code>fo:marker<code></a> object.
* Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_marker">marker</a>
* <code>fo:marker</code>object.
*/
public class Marker extends FObjMixed {
// The value of properties relevant for fo:marker.

+ 0
- 2
fop-core/src/main/java/org/apache/fop/fo/flow/Markers.java View File

@@ -145,8 +145,6 @@ public final class Markers {

/**
* Retrieves the best candidate marker for the given position.
* @param name the key used to register the marker
* @param pos the retrieval scope position
* @return a Marker instance
*/
public Marker resolve(AbstractRetrieveMarker arm) {

+ 2
- 2
fop-core/src/main/java/org/apache/fop/fo/flow/Wrapper.java View File

@@ -32,8 +32,8 @@ import org.apache.fop.fo.properties.CommonAccessibility;
import org.apache.fop.fo.properties.CommonAccessibilityHolder;

/**
* Class modelling the <a href=http://www.w3.org/TR/xsl/#fo_wrapper">
* <code>fo:wrapper</code></a> object.
* Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_wrapper">fo wrapper</a>
* <code>fo:wrapper</code> object.
* The <code>fo:wrapper</code> object serves as a property holder for
* its child node objects.
*/

+ 2
- 2
fop-core/src/main/java/org/apache/fop/fo/flow/table/TableEventProducer.java View File

@@ -117,8 +117,8 @@ public interface TableEventProducer extends EventProducer {
int actualValue, Locator loc) throws PropertyException;

/**
* table-layout=\"fixed\" and column-width unspecified
* => falling back to proportional-column-width(1)
* table-layout=fixed and column-width unspecified
* =&gt; falling back to proportional-column-width(1)
* @param source the event source
* @param loc the location of the error or null
* @event.severity WARN

+ 1
- 1
fop-core/src/main/java/org/apache/fop/fo/pagination/RegionBody.java View File

@@ -81,7 +81,7 @@ public class RegionBody extends Region {
}

/**
* Return the value of the <code>column-count<code> property.
* Return the value of the <code>column-count</code> property.
* @return the "column-count" property.
*/
public int getColumnCount() {

+ 1
- 1
fop-core/src/main/java/org/apache/fop/fo/properties/LengthRangeProperty.java View File

@@ -182,7 +182,7 @@ public class LengthRangeProperty extends Property implements CompoundDatatype {


/**
* Set maximum value to max if it is >= optimum or optimum isn't set.
* Set maximum value to max if it is &gt;= optimum or optimum isn't set.
* @param max A Length value specifying the maximum value for this
* @param bIsDefault If true, this is set as a "default" value
* and not a user-specified explicit value.

+ 1
- 1
fop-core/src/main/java/org/apache/fop/fo/properties/URIProperty.java View File

@@ -31,7 +31,7 @@ import org.apache.fop.util.CompareUtil;
import static org.apache.fop.fo.Constants.PR_X_XML_BASE;

/**
* Class modeling a property that has a value of type &lt;uri-specification>.
* Class modeling a property that has a value of type &lt;uri-specification&gt;.
* The purpose is mainly to support resolution of a specified
* relative URI against a specified or inherited <code>xml:base</code>
* during the property refinement stage.

+ 1
- 1
fop-core/src/main/java/org/apache/fop/fonts/CustomFont.java View File

@@ -515,7 +515,7 @@ public abstract class CustomFont extends Typeface

/**
* Replaces the existing kerning map with a new one.
* @param kerningMap the kerning map (Map<Integer, Map<Integer, Integer>, the integers are
* @param kerningMap the kerning map (the integers are
* character codes)
*/
public void replaceKerningMap(Map<Integer, Map<Integer, Integer>> kerningMap) {

+ 3
- 5
fop-core/src/main/java/org/apache/fop/fonts/EmbedFontInfo.java View File

@@ -27,7 +27,7 @@ import java.util.List;
/**
* FontInfo contains meta information on fonts (where is the metrics file etc.)
* TODO: We need to remove this class and think about more intelligent design patterns
* (Data classes => Procedural code)
* (Data classes =&gt; Procedural code)
*/
public class EmbedFontInfo implements Serializable {

@@ -60,11 +60,10 @@ public class EmbedFontInfo implements Serializable {

/**
* Main constructor
* @param metricsURI the URI of the XML resource containing font metrics
* @param fontUris the URI of the XML resource containing font metrics
* @param kerning True if kerning should be enabled
* @param advanced true if advanced typography features should be enabled
* @param fontTriplets List of font triplets to associate with this font
* @param embedURI Path to the embeddable font file (may be null)
* @param subFontName the sub-fontname used for TrueType Collections (null otherwise)
* @param encodingMode the encoding mode to use for this font
*/
@@ -84,10 +83,9 @@ public class EmbedFontInfo implements Serializable {

/**
* Main constructor
* @param metricsURI the URI of the XML resource containing font metrics
* @param fontUris the URI of the XML resource containing font metrics
* @param kerning True if kerning should be enabled
* @param fontTriplets List of font triplets to associate with this font
* @param embedURI Path to the embeddable font file (may be null)
* @param subFontName the sub-fontname used for TrueType Collections (null otherwise)
*/
public EmbedFontInfo(FontUris fontUris, boolean kerning, boolean advanced,

+ 2
- 2
fop-core/src/main/java/org/apache/fop/fonts/FontCache.java View File

@@ -71,14 +71,14 @@ public final class FontCache implements Serializable {
private final boolean[] changeLock = new boolean[1];

/**
* master mapping of font url -> font info. This needs to be a list, since a
* master mapping of font url -&gt; font info. This needs to be a list, since a
* TTC file may contain more than 1 font.
* @serial
*/
private Map<String, CachedFontFile> fontfileMap;

/**
* mapping of font url -> file modified date (for all fonts that have failed
* mapping of font url -&gt; file modified date (for all fonts that have failed
* to load)
* @serial
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/fonts/MultiByteFont.java View File

@@ -304,7 +304,7 @@ public class MultiByteFont extends CIDFont implements Substitutable, Positionabl
* Returns the Unicode scalar value that corresponds to the glyph index. If more than
* one correspondence exists, then the first one is returned (ordered by bfentries[]).
* @param gi glyph index
* @returns unicode scalar value
* @return unicode scalar value
*/
// [TBD] - needs optimization, i.e., change from linear search to binary search
private int findCharacterFromGlyphIndex(int gi, boolean augment) {

+ 2
- 2
fop-core/src/main/java/org/apache/fop/fonts/SingleByteFont.java View File

@@ -421,7 +421,7 @@ public class SingleByteFont extends CustomFont {
* Sets the version of the PostScript table stored in the TrueType font represented by
* this instance.
*
* @param version version of the <q>post</q> table
* @param version version of the post table
*/
public void setTrueTypePostScriptVersion(PostScriptVersion version) {
ttPostScriptVersion = version;
@@ -431,7 +431,7 @@ public class SingleByteFont extends CustomFont {
* Returns the version of the PostScript table stored in the TrueType font represented by
* this instance.
*
* @return the version of the <q>post</q> table
* @return the version of the post table
*/
public PostScriptVersion getTrueTypePostScriptVersion() {
assert getFontType() == FontType.TRUETYPE;

+ 2
- 2
fop-core/src/main/java/org/apache/fop/fonts/XMLFontMetricsReader.java View File

@@ -46,8 +46,8 @@ import org.apache.fop.fonts.apps.TTFReader;
* <p>Class for reading a metric.xml file and creating a font object.
* Typical usage:</p>
* <pre>
* XMLFontMetricsReader reader = new XMLFontMetricsReader(<path til metrics.xml>);
* reader.setFontEmbedPath(<path to a .ttf or .pfb file or null to diable embedding>);
* XMLFontMetricsReader reader = new XMLFontMetricsReader(&lt;path til metrics.xml&gt;);
* reader.setFontEmbedPath(&lt;path to a .ttf or .pfb file or null to diable embedding&gt;);
* reader.useKerning(true);
* Font f = reader.getFont();
* </pre>

+ 4
- 4
fop-core/src/main/java/org/apache/fop/fonts/apps/PFMReader.java View File

@@ -65,16 +65,16 @@ public class PFMReader extends AbstractFontReader {
*
* @param args Command-line arguments: [options] metricfile.pfm xmlfile.xml
* where options can be:
* -fn <fontname>
* -fn fontname
* default is to use the fontname in the .pfm file, but you can override
* that name to make sure that the embedded font is used instead of installed
* fonts when viewing documents with Acrobat Reader.
* -cn <classname>
* -cn classname
* default is to use the fontname
* -ef <path to the Type1 .pfb fontfile>
* -ef path to the Type1 .pfb fontfile
* will add the possibility to embed the font. When running fop, fop will look
* for this file to embed it
* -er <path to Type1 fontfile relative to org/apache/fop/render/pdf/fonts>
* -er path to Type1 fontfile relative to org/apache/fop/render/pdf/fonts
* you can also include the fontfile in the fop.jar file when building fop.
* You can use both -ef and -er. The file specified in -ef will be searched first,
* then the -er file.

+ 4
- 4
fop-core/src/main/java/org/apache/fop/fonts/apps/TTFReader.java View File

@@ -91,16 +91,16 @@ public class TTFReader extends AbstractFontReader {
*
* @param args Command-line arguments: [options] fontfile.ttf xmlfile.xml
* where options can be:
* -fn <fontname>
* -fn fontname
* default is to use the fontname in the .ttf file, but you can override
* that name to make sure that the embedded font is used instead of installed
* fonts when viewing documents with Acrobat Reader.
* -cn <classname>
* -cn classname
* default is to use the fontname
* -ef <path to the truetype fontfile>
* -ef path to the truetype fontfile
* will add the possibility to embed the font. When running fop, fop will look
* for this file to embed it
* -er <path to truetype fontfile relative to org/apache/fop/render/pdf/fonts>
* -er path to truetype fontfile relative to org/apache/fop/render/pdf/fonts
* you can also include the fontfile in the fop.jar file when building fop.
* You can use both -ef and -er. The file specified in -ef will be searched first,
* then the -er file.

+ 1
- 2
fop-core/src/main/java/org/apache/fop/fonts/cff/CFFDataReader.java View File

@@ -344,7 +344,7 @@ public class CFFDataReader {
/**
* Retrieves the SID for the given GID object
* @param charsetOffset The offset of the charset data
* @param GID The GID for which to retrieve the SID
* @param gid The GID for which to retrieve the SID
* @return Returns the SID as an integer
*/
public int getSIDFromGID(int charsetOffset, int gid) throws IOException {
@@ -458,7 +458,6 @@ public class CFFDataReader {

/**
* Parses the char string index from the CFF byte data
* @param offset The offset to the char string index
* @return Returns the char string index object
* @throws IOException Throws an IO Exception if an error occurs
*/

+ 3
- 6
fop-core/src/main/java/org/apache/fop/fonts/truetype/OpenFont.java View File

@@ -232,7 +232,7 @@ public abstract class OpenFont {
protected OTFAdvancedTypographicTableReader advancedTableReader;

/**
* Version of the PostScript table (<q>post</q>) contained in this font.
* Version of the PostScript table (post) contained in this font.
*/
public static enum PostScriptVersion {
/** PostScript table version 1.0. */
@@ -763,9 +763,6 @@ public abstract class OpenFont {
* Reads a font.
*
* @param in FontFileReader to read from
* @param name Name to be checked for in the font file
* @param glyphs Map of glyphs (glyphs has old index as (Integer) key and
* new index as (Integer) value)
* @throws IOException in case of an I/O problem
*/
public void readFont(FontFileReader in, String header, MultiByteFont mbfont) throws IOException {
@@ -993,8 +990,8 @@ public abstract class OpenFont {

/**
* Returns the index of the last character, but this is for WinAnsiEncoding
* only, so the last char is < 256.
* @return short Index of the last character (<256)
* only, so the last char is &lt; 256.
* @return short Index of the last character (&lt;256)
*/
public short getLastChar() {
return lastChar;

+ 1
- 1
fop-core/src/main/java/org/apache/fop/fonts/type1/AdobeStandardEncoding.java View File

@@ -23,7 +23,7 @@ import java.util.HashMap;
import java.util.Map;

/**
* Enumerates the {@linkplain http://unicode.org/Public/MAPPINGS/VENDORS/ADOBE/stdenc.txt} for
* Enumerates the linkplain http://unicode.org/Public/MAPPINGS/VENDORS/ADOBE/stdenc.txt for
* characters found in a Type1 font.
*/
public enum AdobeStandardEncoding {

+ 1
- 1
fop-core/src/main/java/org/apache/fop/fonts/type1/Type1FontLoader.java View File

@@ -56,7 +56,7 @@ public class Type1FontLoader extends FontLoader {

/**
* Constructs a new Type 1 font loader.
* @param fontFileURI the URI to the PFB file of a Type 1 font
* @param fontUris the URI to the PFB file of a Type 1 font
* @param embedded indicates whether the font is embedded or referenced
* @param useKerning indicates whether to load kerning information if available
* @param resourceResolver the font resolver used to resolve URIs

+ 2
- 2
fop-core/src/main/java/org/apache/fop/hyphenation/Hyphenation.java View File

@@ -20,9 +20,9 @@
package org.apache.fop.hyphenation;

/**
* <p.This class represents a hyphenated word.</p>
* This class represents a hyphenated word.
*
* <p>This work was authored by Carlos Villegas (cav@uniscope.co.jp).</p>
* This work was originally authored by Carlos Villegas cav@uniscope.co.jp
*/
public class Hyphenation {


+ 4
- 4
fop-core/src/main/java/org/apache/fop/hyphenation/HyphenationTree.java View File

@@ -38,11 +38,11 @@ import org.xml.sax.InputSource;
import org.apache.commons.io.IOUtils;

/**
* <p>This tree structure stores the hyphenation patterns in an efficient
* This tree structure stores the hyphenation patterns in an efficient
* way for fast lookup. It provides the provides the method to
* hyphenate a word.</p>
* hyphenate a word.
*
* <p>This work was authored by Carlos Villegas (cav@uniscope.co.jp).</p>
* This work was originally authored by Carlos Villegas cav@uniscope.co.jp
*/
public class HyphenationTree extends TernaryTree implements PatternConsumer {

@@ -232,7 +232,7 @@ public class HyphenationTree extends TernaryTree implements PatternConsumer {
* at index an update interletter values. In other words, it
* does something like:</p>
* <code>
* for(i=0; i<patterns.length; i++) {
* for(i=0; i&lt;patterns.length; i++) {
* if ( word.substring(index).startsWidth(patterns[i]) )
* update_interletter_values(patterns[i]);
* }

+ 1
- 1
fop-core/src/main/java/org/apache/fop/layoutmgr/Adjustment.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.layoutmgr;

/**
* @see KnuthGlue
* @see "http://www.leverkruid.eu/GKPLinebreaking/elements.html"
* http://www.leverkruid.eu/GKPLinebreaking/elements.html
*/
public final class Adjustment {


+ 1
- 1
fop-core/src/main/java/org/apache/fop/layoutmgr/BlockStackingLayoutManager.java View File

@@ -182,7 +182,7 @@ public abstract class BlockStackingLayoutManager extends AbstractLayoutManager

/**
* @param len length in millipoints to span with bp units
* @return the minimum integer n such that n * bpUnit >= len
* @return the minimum integer n such that n * bpUnit &gt;= len
*/
protected int neededUnits(int len) {
return (int) Math.ceil((float)len / bpUnit);

+ 2
- 2
fop-core/src/main/java/org/apache/fop/layoutmgr/BreakingAlgorithm.java View File

@@ -100,7 +100,7 @@ public abstract class BreakingAlgorithm {
/** Demerit for consecutive lines belonging to incompatible fitness classes . */
protected int incompatibleFitnessDemerit = KnuthPenalty.FLAGGED_PENALTY;
/** Maximum number of consecutive lines ending with a flagged penalty.
* Only a value >= 1 is a significant limit.
* Only a value &gt;= 1 is a significant limit.
*/
protected int maxFlaggedPenaltiesCount;

@@ -767,7 +767,7 @@ public abstract class BreakingAlgorithm {

/**
* Handle a {@link KnuthBox}.
* <br/><em>Note: default implementation just adds the box's width
* <br><em>Note: default implementation just adds the box's width
* to the total content width. Subclasses that do not keep track
* of this themselves, but override this method, should remember
* to call {@code super.handleBox(box)} to avoid unwanted side-effects.</em>

+ 1
- 1
fop-core/src/main/java/org/apache/fop/layoutmgr/PageProvider.java View File

@@ -242,7 +242,7 @@ public class PageProvider implements Constants {
}

/**
* Returns the part index (0<x<partCount) which denotes the first part on the last page
* Returns the part index (0&lt;x&lt;partCount) which denotes the first part on the last page
* generated by the current element list.
* @param partCount Number of parts determined by the breaking algorithm
* @return the requested part index

+ 1
- 1
fop-core/src/main/java/org/apache/fop/layoutmgr/PositionIterator.java View File

@@ -26,7 +26,7 @@ import java.util.NoSuchElementException;
* An iterator over {@link Position} instances, that is wrapped around
* another 'parent' {@link Iterator}. The parent can be either another
* {@code PositionIterator}, or an iterator over {@link KnuthElement}s,
* for example.<br/>
* for example.<br>
* The {@link #next()} method always returns a {@link Position}. The
* {@link #getPos(Object)} method can be overridden in subclasses
* to take care of obtaining the {@link LayoutManager} or {@link Position}

+ 1
- 1
fop-core/src/main/java/org/apache/fop/layoutmgr/SpaceResolver.java View File

@@ -679,7 +679,7 @@ public final class SpaceResolver {
* @param startElementIndex index of the first element in the part to be processed
* @param endElementIndex index of the last element in the part to be processed
* @param prevBreak index of the the break possibility just before this part (used to
* identify a break condition, lastBreak <= 0 represents a no-break condition)
* identify a break condition, lastBreak &lt;= 0 represents a no-break condition)
*/
public static void performConditionalsNotification(List effectiveList,
int startElementIndex, int endElementIndex, int prevBreak) {

+ 1
- 1
fop-core/src/main/java/org/apache/fop/layoutmgr/inline/TextLayoutManager.java View File

@@ -693,7 +693,7 @@ public class TextLayoutManager extends LeafNodeLayoutManager {

/**
* The <code>GlyphMapping</code> stores information about spaces.
* <p/>
* <p>
* Add the spaces - except zero-width spaces - to the TextArea.
*/
private void addSpaces() {

+ 1
- 1
fop-core/src/main/java/org/apache/fop/pdf/PDFRoot.java View File

@@ -69,7 +69,7 @@ public class PDFRoot extends PDFDictionary {
* it is about to be written (immediately before the xref
* table as part of the trailer). (mark-fop@inomial.com)
*
* @param objnum the object's number
* @param document TODO
* @param pages the PDFPages object
*/
public PDFRoot(PDFDocument document, PDFPages pages) {

+ 1
- 1
fop-core/src/main/java/org/apache/fop/pdf/StructureHierarchyMember.java View File

@@ -23,7 +23,7 @@ package org.apache.fop.pdf;
* An element in the document's structure tree. This can be either the structure tree root
* or a structure element.
*
* @see "Section 10.6, <q>Logical Structure</q> of the PDF Reference, 4th edition (PDF 1.5)"
* "Section 10.6, Logical Structure of the PDF Reference, 4th edition (PDF 1.5)"
*/
public abstract class StructureHierarchyMember extends PDFDictionary {


+ 0
- 1
fop-core/src/main/java/org/apache/fop/render/AbstractPathOrientedRenderer.java View File

@@ -326,7 +326,6 @@ public abstract class AbstractPathOrientedRenderer extends PrintRenderer {
* @param bpsAfter the border-after traits
* @param bpsStart the border-start traits
* @param bpsEnd the border-end traits
* @param innerBackgroundColor the background color of the block
*/
protected void clipBackground(float startx, float starty,
float width, float height,

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/ImageHandlerBase.java View File

@@ -32,7 +32,7 @@ public interface ImageHandlerBase {
* Returns the priority for this image handler. A lower value means higher priority. This
* information is used to build the ordered/prioritized list of supported ImageFlavors.
* The built-in handlers use priorities between 100 and 999.
* @return a positive integer (>0) indicating the priority
* @return a positive integer (&gt;0) indicating the priority
*/
int getPriority();


+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/afp/exceptions/RendererRuntimeException.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.afp.exceptions;

/**
* A runtime exception for handling fatal errors in rendering.
* <p/>
* <p>
*/
public class RendererRuntimeException extends NestedRuntimeException {


+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPAttribute.java View File

@@ -28,7 +28,7 @@ import org.apache.fop.fo.properties.StringProperty;
* in order to provide a static property maker. The object facilitates
* extraction of attributes from formatted objects based on the static list
* as defined in the AFPElementMapping implementation.
* <p/>
* <p>
*/
public class AFPAttribute extends StringProperty.Maker {


+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPElementMapping.java View File

@@ -29,7 +29,7 @@ import org.apache.fop.fo.FONode;
* for custom AFP extensions not supported by the FO schema. Examples include
* adding overlays or indexing a document using the tag logical element
* structured field.
* <p/>
* <p>
*/
public class AFPElementMapping extends ElementMapping {


+ 1
- 2
fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPIncludeFormMapElement.java View File

@@ -32,8 +32,7 @@ import org.apache.fop.fo.PropertyList;
import org.apache.fop.fo.extensions.ExtensionAttachment;

/**
* This class extends the {@link org.apache.fop.fo.extensions.ExtensionObj} class.
* It represents the "include-form-map" extension in the FO tree.
* Represents the "include-form-map" extension in the FO tree.
*/
public class AFPIncludeFormMapElement extends AbstractAFPExtensionObject {


+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPPageOverlayElement.java View File

@@ -35,7 +35,7 @@ import org.apache.fop.fo.extensions.ExtensionAttachment;
/**
* This class extends the org.apache.fop.render.afp.extensions.AbstractAFPExtensionObject class.
* This object will be used to map the page overlay object in AFPElementMapping.
* <p/>
* <p>
*/
public class AFPPageOverlayElement extends AbstractAFPExtensionObject {


+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPPageSegmentElement.java View File

@@ -34,7 +34,7 @@ import org.apache.fop.fo.extensions.ExtensionAttachment;
* This class extends the org.apache.fop.extensions.ExtensionObj class. The
* object faciliates extraction of elements from formatted objects based on
* the static list as defined in the AFPElementMapping implementation.
* <p/>
* <p>
*/
public class AFPPageSegmentElement extends AFPPageSetupElement {


+ 1
- 2
fop-core/src/main/java/org/apache/fop/render/bitmap/TIFFRenderer.java View File

@@ -65,8 +65,7 @@ import static org.apache.fop.render.bitmap.TIFFCompressionValue.PACKBITS;
* <li>JPEG-in-TIFF compression</li>
* <li>DEFLATE lossless compression (also known as "Zip-in-TIFF")</li>
* <li>LZW compression</li>
* TODO
* <p>
* </ul>
* This class actually does not render itself, instead it extends
* <code>org.apache.fop.render.java2D.Java2DRenderer</code> and just encode
* rendering results into TIFF format using Batik's image codec

+ 1
- 6
fop-core/src/main/java/org/apache/fop/render/intermediate/BorderPainter.java View File

@@ -58,7 +58,7 @@ public class BorderPainter {

/** The ratio between a solid dash and the white-space in a dashed-border */
public static final float DASHED_BORDER_SPACE_RATIO = 0.5f;
/** The length of the dash as a factor of the border width i.e. 2 -> dashWidth = 2*borderWidth */
/** The length of the dash as a factor of the border width i.e. 2 -&gt; dashWidth = 2*borderWidth */
protected static final float DASHED_BORDER_LENGTH_FACTOR = 2.0f;

private final GraphicsPainter graphicsPainter;
@@ -284,7 +284,6 @@ public class BorderPainter {
* condition that corners start on a dash and end with a dash (rather than ending with a white space).
* @param borderLength The length of the border.
* @param borderWidth The width/thickness of the border.
* @param dashSpaceRatio The ratio between dashes and white-space.
* @return returns the length of the dash such that it fits the criteria above.
*/
public static float dashWidthCalculator(float borderLength, float borderWidth) {
@@ -299,10 +298,6 @@ public class BorderPainter {

/** TODO merge with drawRectangularBorders?
* @param borderRect the border rectangle
* @param bpsBefore the border specification on the before side
* @param bpsAfter the border specification on the after side
* @param bpsStart the border specification on the start side
* @param bpsEnd the border specification on the end side
* @throws IOException on io exception
* */
protected void drawRoundedBorders(Rectangle borderRect,

+ 3
- 3
fop-core/src/main/java/org/apache/fop/render/intermediate/IFContext.java View File

@@ -88,7 +88,7 @@ public class IFContext {

/**
* Returns the currently applicable foreign attributes.
* @return a Map<QName, Object>
* @return a Map&lt;QName, Object&gt;
*/
public Map getForeignAttributes() {
return this.foreignAttributes;
@@ -105,7 +105,7 @@ public class IFContext {

/**
* Sets the currently applicable foreign attributes.
* @param foreignAttributes a Map<QName, Object> or null to reset
* @param foreignAttributes a Map&lt;QName, Object&gt; or null to reset
*/
public void setForeignAttributes(Map foreignAttributes) {
if (foreignAttributes != null) {
@@ -190,7 +190,7 @@ public class IFContext {
/**
* Sets the location of the object enclosing the current content.
*
* @location the line and column location of the object in the source FO file
* location the line and column location of the object in the source FO file
*/
public void setLocation(String location) {
this.location = location;

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/intermediate/IFSerializer.java View File

@@ -72,7 +72,7 @@ implements IFConstants, IFPainter, IFDocumentNavigationHandler {
* in the root element of the IF document, the initial value of which
* is set to '2.0' to signify that something preceded it (but didn't
* happen to be marked as such), and that this version is not necessarily
* backwards compatible with the unmarked (<2.0) version.
* backwards compatible with the unmarked (&lt;2.0) version.
*/
public static final String VERSION = "2.0";


+ 2
- 2
fop-core/src/main/java/org/apache/fop/render/pcl/PCLGenerator.java View File

@@ -573,8 +573,8 @@ public class PCLGenerator {

/**
* Select the current pattern
* @param patternID the pattern ID (<ESC>*c#G command)
* @param pattern the pattern type (<ESC>*v#T command)
* @param patternID the pattern ID (&lt;ESC&gt;*c#G command)
* @param pattern the pattern type (&lt;ESC&gt;*v#T command)
* @throws IOException In case of an I/O error
*/
public void selectCurrentPattern(int patternID, int pattern) throws IOException {

+ 2
- 2
fop-core/src/main/java/org/apache/fop/render/pcl/PCLPageDefinition.java View File

@@ -46,7 +46,7 @@ public class PCLPageDefinition {
/**
* Main constructor
* @param name the name of the page definition
* @param selector the selector used by the <ESC>&l#A command (page size)
* @param selector the selector used by the &lt;ESC&gt; command (page size)
* @param physicalPageSize the physical page size
* @param logicalPageRect the rectangle defining the logical page
* @param landscape true if it is a landscape format
@@ -65,7 +65,7 @@ public class PCLPageDefinition {
return this.name;
}

/** @return the selector used by the <ESC>&l#A command (page size) */
/** @return the selector used by the &lt;ESC&gt; command (page size) */
public int getSelector() {
return this.selector;
}

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/pdf/PDFContentGenerator.java View File

@@ -329,7 +329,7 @@ public class PDFContentGenerator {
* @param mcid sequence number
* @param actualText the replacement text for the marked content
* @see #beginTextObject()
* @see #beginMarkedContentSequence(String, int, String))
* @see #beginMarkedContentSequence
*/
protected void beginTextObject(String structElemType, int mcid, String actualText) {
if (!textutil.isInTextObject()) {

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/ps/AbstractPSTranscoder.java View File

@@ -61,7 +61,7 @@ import org.apache.fop.svg.font.FOPFontFamilyResolverImpl;
* processor can be specified:
*
* <p><code>KEY_LANGUAGE</code> to set the default language to use (may be
* used by a &lt;switch> SVG element for example),
* used by a &lt;switch&gt; SVG element for example),
* <code>KEY_USER_STYLESHEET_URI</code> to fix the URI of a user
* stylesheet, and <code>KEY_PIXEL_TO_MM</code> to specify the pixel to
* millimeter conversion factor.

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/ps/EPSTranscoder.java View File

@@ -41,7 +41,7 @@ import org.apache.xmlgraphics.java2d.ps.EPSDocumentGraphics2D;
* processor can be specified:
*
* <p><code>KEY_LANGUAGE</code> to set the default language to use (may be
* used by a &lt;switch> SVG element for example),
* used by a &lt;switch&gt; SVG element for example),
* <code>KEY_USER_STYLESHEET_URI</code> to fix the URI of a user
* stylesheet, and <code>KEY_PIXEL_TO_MM</code> to specify the pixel to
* millimeter conversion factor.

+ 3
- 3
fop-core/src/main/java/org/apache/fop/render/ps/PSTextElementBridge.java View File

@@ -28,16 +28,16 @@ import org.apache.batik.bridge.TextPainter;
import org.apache.batik.gvt.GraphicsNode;

/**
* <p>Bridge class for the &lt;text> element.
* Bridge class for the &lt;text&gt; element.
* This bridge will use the direct text painter if the text
* for the element is simple.</p>
* for the element is simple.
*/
public class PSTextElementBridge extends SVGTextElementBridge {

private TextPainter textPainter;

/**
* Constructs a new bridge for the &lt;text> element.
* Constructs a new bridge for the &lt;text&gt; element.
* @param textPainter the text painter to use
*/
public PSTextElementBridge(TextPainter textPainter) {

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/ps/PSTextPainter.java View File

@@ -47,7 +47,7 @@ import org.apache.fop.svg.NativeTextPainter;
import org.apache.fop.util.HexEncoder;

/**
* Renders the attributed character iterator of a {@link org.apache.batik.gvt.TextNode TextNode}.
* Renders the attributed character iterator of a {@link org.apache.batik.bridge.TextNode TextNode}.
* This class draws the text directly using PostScript text operators so
* the text is not drawn using shapes which makes the PS files larger.
* <p>

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/ps/PSTranscoder.java View File

@@ -41,7 +41,7 @@ import org.apache.xmlgraphics.java2d.ps.PSDocumentGraphics2D;
* processor can be specified:
*
* <p><code>KEY_LANGUAGE</code> to set the default language to use (may be
* used by a &lt;switch> SVG element for example),
* used by a &lt;switch&gt; SVG element for example),
* <code>KEY_USER_STYLESHEET_URI</code> to fix the URI of a user
* stylesheet, and <code>KEY_PIXEL_TO_MM</code> to specify the pixel to
* millimeter conversion factor.

+ 2
- 2
fop-core/src/main/java/org/apache/fop/render/ps/fonts/PSTTFGenerator.java View File

@@ -79,7 +79,7 @@ public class PSTTFGenerator {
* @param byteArray byte[] a byte array
* @param offset the position in the byte array where the streaming must start
* @param length the number of bytes to stream. This MUST be less than
* {@link #MAX_BUFFER_SIZE} - 1 since strings are suffixed by '00' (see Section 4.2 of
* MAX_BUFFER_SIZE - 1 since strings are suffixed by '00' (see Section 4.2 of
* Adobe Technical Note #5012, <em>The Type 42 Font Format Specification</em>.).
*/
public void streamBytes(byte[] byteArray, int offset, int length) throws IOException {
@@ -91,7 +91,7 @@ public class PSTTFGenerator {
}

/**
* Finishes writing a string by appending '00' and '>' to the end.
* Finishes writing a string by appending '00' and '&gt;' to the end.
*/
public void endString() throws IOException {
/* Appends a '00' to the end of the string as specified in the spec */

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/BorderAttributesConverter.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.rtf;

/*
* 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
* 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.
*/

+ 0
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/RTFPlaceHolderHelper.java View File

@@ -47,7 +47,6 @@ public class RTFPlaceHolderHelper {
* A method to create an object which is missing and required from the
* RTF structure.
* @param containerClass The class which is missing
* @throws Exception
*/
public void createRTFPlaceholder(Class containerClass) throws RtfException {
if (containerClass == RtfTableRow.class) {

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfException.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.exceptions;

/*
* 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
* 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.
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfStructureException.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.exceptions;

/*
* 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
* 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.
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IBorderAttributes.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc;

/*
* 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
* 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.
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfAfterContainer.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc;

/*
* 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
* 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.
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfBeforeContainer.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc;

/*
* 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
* 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.
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfBookmarkContainer.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc;

/*
* 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
* 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.
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfExternalGraphicContainer.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc;

/*
* 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
* 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.
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfHyperLinkContainer.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc;

/*
* 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
* 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.
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfJforCmdContainer.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc;

/*
* 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
* 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.
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfListContainer.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc;

/*
* 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
* 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.
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfOptions.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc;

/*
* 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
* 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.
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageBreakContainer.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc;

/*
* 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
* 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.
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageContainer.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc;

/*
* 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
* 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.
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageNumberCitationContainer.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc;

/*
* 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
* 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.
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageNumberContainer.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc;

/*
* 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
* 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.
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfParagraphContainer.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc;

/*
* 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
* 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.
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfParagraphKeepTogetherContainer.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc;

/*
* 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
* 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.
*/

+ 1
- 1
fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTableContainer.java View File

@@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc;

/*
* 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
* 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.
*/

+ 0
- 0
fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTextContainer.java View File


Some files were not shown because too many files changed in this diff

Loading…
Cancel
Save