Skip to content

Commit

Permalink
Small documentation cleanup reference Reactor concepts (Azure#44292)
Browse files Browse the repository at this point in the history
  • Loading branch information
alzimmermsft authored Feb 26, 2025
1 parent c5ce9a8 commit 900edb7
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@
/**
* Type to create a proxy implementation for an interface describing REST API methods.
* <p>
* RestProxy can create proxy implementations for interfaces with methods that return deserialized Java objects as well
* as asynchronous Single objects that resolve to a deserialized Java object.
* RestProxy can create proxy implementations for interfaces with methods that return deserialized Java objects.
*/
public final class RestProxy implements InvocationHandler {
private final SwaggerInterfaceParser interfaceParser;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
*/
public interface HttpClient {
/**
* Sends the provided request synchronously with contextual information.
* Sends the provided request with contextual information.
*
* @param request The HTTP request to send.
* @return The response.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,11 @@
@FunctionalInterface
public interface HttpPipelinePolicy {
/**
* Processes the provided HTTP request and invokes the next policy synchronously.
* Processes the provided HTTP request and invokes the next policy.
*
* @param httpRequest The HTTP request.
* @param next The next policy to invoke.
*
* @return A publisher that initiates the request upon subscription and emits a response on completion.
* @return The {@link Response} from the next policy or the HTTP client if there are no more policies.
*/
Response<?> process(HttpRequest httpRequest, HttpPipelineNextPolicy next);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -270,8 +270,8 @@ private static HttpRequest configRequest(HttpRequest request, SwaggerMethodParse
}

/**
* Create a publisher that (1) emits error if the provided response {@code decodedResponse} has 'disallowed status
* code' OR (2) emits provided response if it's status code ia allowed.
* Throws an exception if the provided response {@code decodedResponse} has 'disallowed status code' OR returns a
* response that has 'allowed status code'.
*
* <p>'disallowed status code' is one of the status code defined in the provided SwaggerMethodParser or is in the int[]
* of additional allowed status codes.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
* Implicit context propagation works best in synchronous code. Implicit context propagation may not work in
* asynchronous scenarios depending on the async framework used by the application, implementation details,
* and OpenTelemetry instrumentation's used.
*
* <p>
* When writing asynchronous code, it's recommended to use explicit context propagation.
*
* <p><strong>Pass context explicitly to correlate them with library telemetry in async code</strong></p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -470,8 +470,8 @@ public static BinaryData fromFile(Path file, Long position, Long length, int chu
*
* <p>This method returns a reference to the underlying byte array. Modifying the contents of the returned byte
* array may change the content of this BinaryData instance. If the content source of this BinaryData instance is
* a file, an {@link InputStream}, or a {@code Flux<ByteBuffer>} the source is not modified. To safely update the
* byte array, it is recommended to make a copy of the contents first.</p>
* a file or an {@link InputStream} the source is not modified. To safely update the byte array, it is recommended
* to make a copy of the contents first.</p>
*
* <p>If the {@link BinaryData} is larger than the maximum size allowed for a {@code byte[]} this will throw an
* {@link IllegalStateException}.</p>
Expand Down

0 comments on commit 900edb7

Please sign in to comment.