Skip to content

Commit

Permalink
[Form recognizer] Fix Javadoc improvements JDK 20 (#36700)
Browse files Browse the repository at this point in the history
  • Loading branch information
samvaity authored Sep 13, 2023
1 parent a088538 commit fa6f086
Show file tree
Hide file tree
Showing 72 changed files with 556 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,14 @@ public final class FormRecognizerClientBuilder implements
EndpointTrait<FormRecognizerClientBuilder>,
HttpTrait<FormRecognizerClientBuilder>,
TokenCredentialTrait<FormRecognizerClientBuilder> {

/**
* Constructs a {@link FormRecognizerClientBuilder} object.
*/
public FormRecognizerClientBuilder() {
httpLogOptions = new HttpLogOptions();
}

private final ClientLogger logger = new ClientLogger(FormRecognizerClientBuilder.class);

private final List<HttpPipelinePolicy> perCallPolicies = new ArrayList<>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,12 @@ public final class DocumentAnalysisClientBuilder implements
TokenCredentialTrait<DocumentAnalysisClientBuilder> {
private final ClientLogger logger = new ClientLogger(DocumentAnalysisClientBuilder.class);

/**
* Create a DocumentAnalysisClientBuilder instance.
*/
public DocumentAnalysisClientBuilder() {
}

private final List<HttpPipelinePolicy> perCallPolicies = new ArrayList<>();
private final List<HttpPipelinePolicy> perRetryPolicies = new ArrayList<>();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,14 @@ public final class DocumentModelAdministrationClientBuilder implements
EndpointTrait<DocumentModelAdministrationClientBuilder>,
HttpTrait<DocumentModelAdministrationClientBuilder>,
TokenCredentialTrait<DocumentModelAdministrationClientBuilder> {

/**
* Constructs a DocumentModelAdministrationClientBuilder object.
*/
public DocumentModelAdministrationClientBuilder() {
httpLogOptions = new HttpLogOptions();
}

private final ClientLogger logger = new ClientLogger(DocumentModelAdministrationClientBuilder.class);

private final List<HttpPipelinePolicy> perCallPolicies = new ArrayList<>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ public final class BuildDocumentClassifierOptions {

private String classifierId;

/**
* Create a BuildDocumentClassifierOptions instance.
*/
public BuildDocumentClassifierOptions() {
}

/**
* Get the model description.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ public final class BuildDocumentModelOptions {

private String modelId;

/**
* Create a BuildDocumentModelOptions instance.
*/
public BuildDocumentModelOptions() {
}

/**
* Get the model description.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ public final class ComposeDocumentModelOptions {
private Map<String, String> tags;
private String modelId;

/**
* Create a ComposeDocumentModelOptions instance.
*/
public ComposeDocumentModelOptions() {
}

/**
* Get the optional model description defined by the user.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@
/** Type of content source. */
public final class ContentSourceKind extends ExpandableStringEnum<ContentSourceKind> {

/**
* Creates or finds a ContentSourceKind from its string representation.
* @deprecated Use the {@link #fromString(String)} factory method.
*/
@Deprecated
public ContentSourceKind() {
}

/** Enum value azureBlob. */
public static final ContentSourceKind AZURE_BLOB = fromString("azureBlob");

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ public final class CopyAuthorizationOptions {
private Map<String, String> tags;
private String modelId;

/**
* Create a CopyAuthorizationOptions instance.
*/
public CopyAuthorizationOptions() {
}

/**
* Get the model description.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@
*/
@Immutable
public final class DocumentFieldSchema {

/**
* Constructs a DocumentFieldSchema object.
*/
public DocumentFieldSchema() {
}

/*
* Semantic data type of the field value.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@
@Immutable
public final class DocumentModelBuildMode extends ExpandableStringEnum<DocumentModelBuildMode> {

/**
* Creates a DocumentModelBuildMode object.
* @deprecated Use the {@link #fromString(String)} factory method.
*/
@Deprecated
public DocumentModelBuildMode() {
}

/**
* Used for documents with fixed visual templates.
*/
Expand All @@ -32,7 +40,10 @@ public static DocumentModelBuildMode fromString(String name) {
return fromString(name, DocumentModelBuildMode.class);
}

/** @return known DocumentModelBuildMode values. */
/**
* Returns known DocumentModelBuildMode values.
* @return known DocumentModelBuildMode values.
*/
public static Collection<DocumentModelBuildMode> values() {
return values(DocumentModelBuildMode.class);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@
/** Build document model operation details */
@Immutable
public final class DocumentModelBuildOperationDetails extends OperationDetails {

/**
* Creates a DocumentModelBuildOperationDetails object.
*/
public DocumentModelBuildOperationDetails() {
super();
}

/*
* Operation result upon success.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@
/** Compose document model operation details */
@Immutable
public final class DocumentModelComposeOperationDetails extends OperationDetails {

/**
* Creates a DocumentModelComposeOperationDetails object.
*/
public DocumentModelComposeOperationDetails() {
super();
}

/*
* Operation result upon success.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@
/** Copy document model operation details. */
@Immutable
public final class DocumentModelCopyToOperationDetails extends OperationDetails {

/**
* Creates a DocumentModelCopyToOperationDetails object.
*/
public DocumentModelCopyToOperationDetails() {
super();
}

/*
* Operation result upon success.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@
@Immutable
public final class DocumentModelDetails {

/**
* Creates a DocumentModelDetails object.
*/
public DocumentModelDetails() {
}

/*
* Unique model identifier.
*/
Expand Down Expand Up @@ -119,7 +125,7 @@ public OffsetDateTime getExpiresOn() {
private void setExpiresOn(OffsetDateTime expiresOn) {
this.expiresOn = expiresOn;
}

/**
* Get the Service version used to create this document classifier.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@
*/
@Immutable
public final class DocumentModelSummary {

/**
* Creates a DocumentModelSummary object.
*/
public DocumentModelSummary() {
}

/*
* Unique model identifier.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@
*/
@Immutable
public final class DocumentTypeDetails {

/**
* Creates a DocumentTypeDetails instance.
*/
public DocumentTypeDetails() {
}

/*
* Model description.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@
* The OperationDetails model.
*/
public class OperationDetails {

/**
* Creates an instance of OperationDetails.
*/
public OperationDetails() {
}

private String operationId;
private OperationStatus status;
private Integer percentCompleted;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@
/** Known values for type of operation. */
@Immutable
public final class OperationKind extends ExpandableStringEnum<OperationKind> {

/**
* Creates a OperationKind object.
* @deprecated Use the {@link #fromString(String)} factory method.
*/
@Deprecated
public OperationKind() {
}

/** Static value documentModelBuild for OperationKind. */
public static final OperationKind DOCUMENT_MODEL_BUILD = fromString("documentModelBuild");

Expand All @@ -30,7 +39,10 @@ public static OperationKind fromString(String name) {
return fromString(name, OperationKind.class);
}

/** @return known OperationKind values. */
/**
* Returns known OperationKind values.
* @return known OperationKind values.
*/
public static Collection<OperationKind> values() {
return values(OperationKind.class);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@
/** Known values for operation status. */
@Immutable
public final class OperationStatus extends ExpandableStringEnum<OperationStatus> {

/**
* Creates a OperationStatus object.
* @deprecated Use the {@link #fromString(String)} factory method.
*/
@Deprecated
public OperationStatus() {
}

/** Static value notStarted for OperationStatus. */
public static final OperationStatus NOT_STARTED = fromString("notStarted");

Expand All @@ -36,7 +45,10 @@ public static OperationStatus fromString(String name) {
return fromString(name, OperationStatus.class);
}

/** @return known OperationStatus values. */
/**
* Returns known OperationStatus values.
* @return known OperationStatus values.
*/
public static Collection<OperationStatus> values() {
return values(OperationStatus.class);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@
/** OperationSummary. */
@Immutable
public final class OperationSummary {

/**
* Creates a OperationSummary object.
*/
public OperationSummary() {
}

/*
* Operation ID
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@
/** Quota used, limit, and next reset date/time. */
@Immutable
public final class QuotaDetails {

/**
* Creates a QuotaDetails object.
*/
public QuotaDetails() {
}

/*
* Amount of the resource quota used.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ public final class ResourceDetails {

private QuotaDetails customNeuralDocumentModelQuota;

/**
* Creates a ResourceDetails object.
*/
public ResourceDetails() {
}

/**
* Get the current count of built document analysis models
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@
public final class FormRecognizerClientImpl {
/**
* Supported Cognitive Services endpoints (protocol and hostname, for example:
* <a href="https://westus2.api.cognitive.microsoft.com">here</a>).
* https://westus2.api.cognitive.microsoft.com).
*/
private final String endpoint;

/**
* Gets Supported Cognitive Services endpoints (protocol and hostname, for example:
* <a href="https://westus2.api.cognitive.microsoft.com">here</a>).
* https://westus2.api.cognitive.microsoft.com).
*
* @return the endpoint value.
*/
Expand Down Expand Up @@ -106,7 +106,7 @@ public DocumentClassifiersImpl getDocumentClassifiers() {
* Initializes an instance of FormRecognizerClient client.
*
* @param endpoint Supported Cognitive Services endpoints (protocol and hostname, for example:
* <a href="https://westus2.api.cognitive.microsoft.com">here</a>).
* https://westus2.api.cognitive.microsoft.com).
* @param apiVersion Api Version.
*/
FormRecognizerClientImpl(String endpoint, String apiVersion) {
Expand All @@ -124,7 +124,7 @@ public DocumentClassifiersImpl getDocumentClassifiers() {
*
* @param httpPipeline The HTTP pipeline to send requests through.
* @param endpoint Supported Cognitive Services endpoints (protocol and hostname, for example:
* <a href="https://westus2.api.cognitive.microsoft.com">here</a>).
* https://westus2.api.cognitive.microsoft.com).
* @param apiVersion Api Version.
*/
FormRecognizerClientImpl(HttpPipeline httpPipeline, String endpoint, String apiVersion) {
Expand All @@ -137,7 +137,7 @@ public DocumentClassifiersImpl getDocumentClassifiers() {
* @param httpPipeline The HTTP pipeline to send requests through.
* @param serializerAdapter The serializer to serialize an object into a string.
* @param endpoint Supported Cognitive Services endpoints (protocol and hostname, for example:
* <a href="https://westus2.api.cognitive.microsoft.com">here</a>).
* https://westus2.api.cognitive.microsoft.com).
* @param apiVersion Api Version.
*/
FormRecognizerClientImpl(
Expand Down
Loading

0 comments on commit fa6f086

Please sign in to comment.