Skip to content

Commit a77e3e5

Browse files
author
Changjian Wang
committed
Update documentation comments in DocumentSource for clarity on bounding box and source format
1 parent 1fef6f4 commit a77e3e5

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

  • sdk/contentunderstanding/azure-ai-contentunderstanding/src/main/java/com/azure/ai/contentunderstanding/models

sdk/contentunderstanding/azure-ai-contentunderstanding/src/main/java/com/azure/ai/contentunderstanding/models/DocumentSource.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,8 @@ public List<PointF> getPolygon() {
108108

109109
/**
110110
* Gets the axis-aligned bounding rectangle computed from the polygon coordinates,
111-
* or {@code null} when no polygon is available.
111+
* or {@code null} when only a page number is available.
112+
* Useful for drawing highlight rectangles over extracted fields.
112113
*
113114
* @return The bounding box, or {@code null} for page-only sources.
114115
*/
@@ -119,7 +120,7 @@ public RectangleF getBoundingBox() {
119120
/**
120121
* Parses a single document source segment.
121122
*
122-
* @param source The source string in the format {@code D(page,x1,y1,...,xN,yN)} or {@code D(page)}.
123+
* @param source The source string in the format {@code D(page)} or {@code D(page,x1,y1,...,xN,yN)}.
123124
* @return A new {@link DocumentSource}.
124125
* @throws NullPointerException if {@code source} is null.
125126
* @throws IllegalArgumentException if the source string is not in the expected format.

0 commit comments

Comments
 (0)