Browse Source

Fix several iTextCore javadoc issues

DEVSIX-4103

Autoported commit.
Original commit hash: [d3588638f]
Manual files:
kernel/src/main/java/com/itextpdf/kernel/pdf/canvas/parser/listener/RegexBasedLocationExtractionStrategy.java
pull/14/head
Kate Ivanova 5 years ago
parent
commit
b65e09b282
  1. 10
      itext/itext.kernel/itext/kernel/geom/PageSize.cs
  2. 2
      itext/itext.kernel/itext/kernel/geom/Rectangle.cs
  3. 19
      itext/itext.kernel/itext/kernel/geom/Subpath.cs
  4. 21
      itext/itext.kernel/itext/kernel/pdf/PdfDocument.cs
  5. 17
      itext/itext.kernel/itext/kernel/pdf/canvas/parser/listener/RegexBasedLocationExtractionStrategy.cs
  6. 2
      port-hash

10
itext/itext.kernel/itext/kernel/geom/PageSize.cs

@ -107,7 +107,15 @@ namespace iText.Kernel.Geom {
: base(box.GetX(), box.GetY(), box.GetWidth(), box.GetHeight()) {
}
/// <summary>Rotates PageSize clockwise.</summary>
/// <summary>
/// Rotates
/// <see cref="PageSize"/>
/// clockwise.
/// </summary>
/// <returns>
/// the rotated
/// <see cref="PageSize"/>.
/// </returns>
public virtual iText.Kernel.Geom.PageSize Rotate() {
return new iText.Kernel.Geom.PageSize(height, width);
}

2
itext/itext.kernel/itext/kernel/geom/Rectangle.cs

@ -259,7 +259,7 @@ namespace iText.Kernel.Geom {
}
/// <summary>Check if this rectangle and the passed rectangle overlap</summary>
/// <param name="rect"/>
/// <param name="rect">a rectangle which is to be checked if it overlaps the passed rectangle.</param>
/// <returns>true if there is overlap of some kind</returns>
public virtual bool Overlaps(iText.Kernel.Geom.Rectangle rect) {
// Two rectangles do not overlap if any of the following holds

19
itext/itext.kernel/itext/kernel/geom/Subpath.cs

@ -56,8 +56,13 @@ namespace iText.Kernel.Geom {
public Subpath() {
}
/// <summary>Copy constuctor.</summary>
/// <param name="subpath"/>
/// <summary>Copy constructor.</summary>
/// <param name="subpath">
///
/// <see cref="Subpath"/>
/// which contents will be used to create this
/// <see cref="Subpath"/>
/// </param>
public Subpath(iText.Kernel.Geom.Subpath subpath) {
this.startPoint = subpath.startPoint;
this.segments.AddAll(subpath.GetSegments());
@ -65,24 +70,27 @@ namespace iText.Kernel.Geom {
}
/// <summary>Constructs a new subpath starting at the given point.</summary>
/// <param name="startPoint">the point this subpath starts at</param>
public Subpath(Point startPoint)
: this((float)startPoint.GetX(), (float)startPoint.GetY()) {
}
/// <summary>Constructs a new subpath starting at the given point.</summary>
/// <param name="startPointX">x-coordinate of the start point of subpath</param>
/// <param name="startPointY">y-coordinate of the start point of subpath</param>
public Subpath(float startPointX, float startPointY) {
this.startPoint = new Point(startPointX, startPointY);
}
/// <summary>Sets the start point of the subpath.</summary>
/// <param name="startPoint"/>
/// <param name="startPoint">the point this subpath starts at</param>
public virtual void SetStartPoint(Point startPoint) {
SetStartPoint((float)startPoint.GetX(), (float)startPoint.GetY());
}
/// <summary>Sets the start point of the subpath.</summary>
/// <param name="x"/>
/// <param name="y"/>
/// <param name="x">x-coordinate of the start pint</param>
/// <param name="y">y-coordinate of the start pint</param>
public virtual void SetStartPoint(float x, float y) {
this.startPoint = new Point(x, y);
}
@ -165,6 +173,7 @@ namespace iText.Kernel.Geom {
/// See
/// <see cref="IsClosed()"/>
/// </summary>
/// <param name="closed"><c>boolean</c> value indicating whether the path is closed or not.</param>
public virtual void SetClosed(bool closed) {
this.closed = closed;
}

21
itext/itext.kernel/itext/kernel/pdf/PdfDocument.cs

@ -277,6 +277,7 @@ namespace iText.Kernel.Pdf {
}
/// <summary>Gets XMPMetadata.</summary>
/// <returns>the XMPMetadata</returns>
public virtual byte[] GetXmpMetadata() {
return GetXmpMetadata(false);
}
@ -1398,6 +1399,7 @@ namespace iText.Kernel.Pdf {
}
/// <summary>Gets static copy of cross reference table.</summary>
/// <returns>a static copy of cross reference table</returns>
public virtual IList<PdfIndirectReference> ListIndirectReferences() {
CheckClosingStatus();
IList<PdfIndirectReference> indRefs = new List<PdfIndirectReference>(xref.Size());
@ -1737,10 +1739,15 @@ namespace iText.Kernel.Pdf {
/// <see cref="iText.Kernel.Font.PdfFont"/>
/// or load already created one.
/// </summary>
/// <remarks>
/// Create a new instance of
/// <param name="dictionary">
///
/// <see cref="PdfDictionary"/>
/// that presents
/// <see cref="iText.Kernel.Font.PdfFont"/>.
/// </param>
/// <returns>
/// instance of
/// <see cref="iText.Kernel.Font.PdfFont"/>
/// or load already created one.
/// <para />
/// Note, PdfFont which created with
/// <see cref="iText.Kernel.Font.PdfFontFactory.CreateFont(PdfDictionary)"/>
@ -1749,7 +1756,7 @@ namespace iText.Kernel.Pdf {
/// <see cref="iText.Kernel.Pdf.Canvas.PdfCanvas"/>
/// or
/// <see cref="PdfResources"/>.
/// </remarks>
/// </returns>
public virtual PdfFont GetFont(PdfDictionary dictionary) {
System.Diagnostics.Debug.Assert(dictionary.GetIndirectReference() != null);
if (documentFonts.ContainsKey(dictionary.GetIndirectReference())) {
@ -1801,6 +1808,11 @@ namespace iText.Kernel.Pdf {
/// instance to this document so that this font is flushed automatically
/// on document close. As a side effect, the underlying font dictionary is made indirect if it wasn't the case yet
/// </remarks>
/// <param name="font">
/// a
/// <see cref="iText.Kernel.Font.PdfFont"/>
/// instance to add
/// </param>
/// <returns>the same PdfFont instance.</returns>
public virtual PdfFont AddFont(PdfFont font) {
font.MakeIndirect(this);
@ -2111,6 +2123,7 @@ namespace iText.Kernel.Pdf {
/// Update XMP metadata values from
/// <see cref="PdfDocumentInfo"/>.
/// </summary>
/// <returns>the XMPMetadata</returns>
protected internal virtual XMPMeta UpdateDefaultXmpMetadata() {
XMPMeta xmpMeta = XMPMetaFactory.ParseFromBuffer(GetXmpMetadata(true));
XmpMetaInfoConverter.AppendDocumentInfoToMetadata(info, xmpMeta);

17
itext/itext.kernel/itext/kernel/pdf/canvas/parser/listener/RegexBasedLocationExtractionStrategy.cs

@ -156,8 +156,15 @@ namespace iText.Kernel.Pdf.Canvas.Parser.Listener {
/// <c>Rectangle</c>
/// .
/// </summary>
/// <param name="tri"/>
/// <returns/>
/// <param name="tri">
/// <see cref="TextRenderInfo"/>
/// object
/// </param>
/// <returns>a list of
/// <see cref="CharacterRenderInfo"/>s
/// which represents the passed
/// <see cref="TextRenderInfo"/>
/// </returns>
protected internal virtual IList<CharacterRenderInfo> ToCRI(TextRenderInfo tri) {
IList<CharacterRenderInfo> cris = new List<CharacterRenderInfo>();
foreach (TextRenderInfo subTri in tri.GetCharacterRenderInfos()) {
@ -186,8 +193,10 @@ namespace iText.Kernel.Pdf.Canvas.Parser.Listener {
/// <c>Rectangle</c>
/// .
/// </summary>
/// <param name="cris"/>
/// <returns/>
/// <param name="cris">list of
/// <see cref="CharacterRenderInfo"/>
/// objects</param>
/// <returns>an array containing elements of this list</returns>
protected internal virtual IList<Rectangle> ToRectangles(IList<CharacterRenderInfo> cris) {
IList<Rectangle> retval = new List<Rectangle>();
if (cris.IsEmpty()) {

2
port-hash

@ -1 +1 @@
091919e33d849171c0c216eeabc239c41a206359
d3588638ffdd756e6f15570bdf7eb08cdb2c271d
Loading…
Cancel
Save