docs: Remove redundant details from DoclingServeConvertApi comments

edeandrea · edeandrea · commit e057f86f8ea3 · 2025-12-15T16:19:05.000-05:00
Simplified method description by removing unnecessary implementation details about async threading and background polling, focusing on core functionality.

Signed-off-by: Eric Deandrea &lt;eric.deandrea@gmail.com&gt;
diff --git a/docling-serve/docling-serve-api/src/main/java/ai/docling/serve/api/DoclingServeConvertApi.java b/docling-serve/docling-serve-api/src/main/java/ai/docling/serve/api/DoclingServeConvertApi.java
@@ -24,9 +24,7 @@ public interface DoclingServeConvertApi {
    * {@link CompletableFuture} that completes when the conversion is done.
    *
    * <p>This method starts the conversion, polls the status in the background, and completes
-   * the future with the result when the conversion finishes. The polling happens on a separate
-   * thread, avoiding potential thread deadlock issues and allowing downstream frameworks
-   * (like Quarkus/Mutiny or Spring/WebFlux) to integrate with their own async APIs.
+   * the future with the result when the conversion finishes.
    *
    * <p>Example usage:
    * <pre>{@code

Original file line number	Diff line number	Diff line change
`@@ -24,9 +24,7 @@ public interface DoclingServeConvertApi {`
`24`	`24`	`* {@link CompletableFuture} that completes when the conversion is done.`
`25`	`25`	`*`
`26`	`26`	`* <p>This method starts the conversion, polls the status in the background, and completes`
`27`		`- * the future with the result when the conversion finishes. The polling happens on a separate`
`28`		`- * thread, avoiding potential thread deadlock issues and allowing downstream frameworks`
`29`		`- * (like Quarkus/Mutiny or Spring/WebFlux) to integrate with their own async APIs.`
	`27`	`+ * the future with the result when the conversion finishes.`
`30`	`28`	`*`
`31`	`29`	`* <p>Example usage:`
`32`	`30`	`* <pre>{@code`