Generates proper documentation for classes and properties (#1418)

Author: jderusse

src/Enum/ArtifactNamespace.php

@@ -2,22 +2,6 @@
 
 namespace AsyncAws\CodeBuild\Enum;
 
-/**
- * Along with `path` and `name`, the pattern that CodeBuild uses to determine the name and location to store the output
- * artifact:.
- *
- * - If `type` is set to `CODEPIPELINE`, CodePipeline ignores this value if specified. This is because CodePipeline
- *   manages its build output names instead of CodeBuild.
- * - If `type` is set to `NO_ARTIFACTS`, this value is ignored if specified, because no build output is produced.
- * - If `type` is set to `S3`, valid values include:
- *
- *   - `BUILD_ID`: Include the build ID in the location of the build output artifact.
- *   - `NONE`: Do not include the build ID. This is the default if `namespaceType` is not specified.
- *
- *
- * For example, if `path` is set to `MyArtifacts`, `namespaceType` is set to `BUILD_ID`, and `name` is set to
- * `MyArtifact.zip`, the output artifact is stored in `MyArtifacts/<build-ID>/MyArtifact.zip`.
- */
 final class ArtifactNamespace
 {
     public const BUILD_ID = 'BUILD_ID';

src/Enum/ArtifactPackaging.php

@@ -2,18 +2,6 @@
 
 namespace AsyncAws\CodeBuild\Enum;
 
-/**
- * The type of build output artifact to create:.
- *
- * - If `type` is set to `CODEPIPELINE`, CodePipeline ignores this value if specified. This is because CodePipeline
- *   manages its build output artifacts instead of CodeBuild.
- * - If `type` is set to `NO_ARTIFACTS`, this value is ignored if specified, because no build output is produced.
- * - If `type` is set to `S3`, valid values include:
- *
- *   - `NONE`: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if
- *     `packaging` is not specified.
- *   - `ZIP`: CodeBuild creates in the output bucket a ZIP file that contains the build output.
- */
 final class ArtifactPackaging
 {
     public const NONE = 'NONE';

src/Enum/ArtifactsType.php

@@ -2,16 +2,6 @@
 
 namespace AsyncAws\CodeBuild\Enum;
 
-/**
- * The type of build output artifact. Valid values include:.
- *
- * - `CODEPIPELINE`: The build project has build output generated through CodePipeline.
- *
- *   > The `CODEPIPELINE` type is not supported for `secondaryArtifacts`.
- *
- * - `NO_ARTIFACTS`: The build project does not produce any build output.
- * - `S3`: The build project stores build output in Amazon S3.
- */
 final class ArtifactsType
 {
     public const CODEPIPELINE = 'CODEPIPELINE';

src/Enum/BucketOwnerAccess.php

@@ -2,6 +2,36 @@
 
 namespace AsyncAws\CodeBuild\Enum;
 
+/**
+ * Specifies the bucket owner's access for objects that another account uploads to their Amazon S3 bucket. By default,
+ * only the account that uploads the objects to the bucket has access to these objects. This property allows you to give
+ * the bucket owner access to these objects.
+ *
+ * > To use this property, your CodeBuild service role must have the `s3:PutBucketAcl` permission. This permission
+ * > allows CodeBuild to modify the access control list for the bucket.
+ *
+ * This property can be one of the following values:
+ *
+ * - `NONE`:
+ *
+ *   The bucket owner does not have access to the objects. This is the default.
+ * - `READ_ONLY`:
+ *
+ *   The bucket owner has read-only access to the objects. The uploading account retains ownership of the objects.
+ * - `FULL`:
+ *
+ *   The bucket owner has full access to the objects. Object ownership is determined by the following criteria:
+ *
+ *   - If the bucket is configured with the **Bucket owner preferred** setting, the bucket owner owns the objects. The
+ *     uploading account will have object access as specified by the bucket's policy.
+ *   -
+ *   - Otherwise, the uploading account retains ownership of the objects.
+ *
+ *   For more information about Amazon S3 object ownership, see Controlling ownership of uploaded objects using S3
+ *   Object Ownership [^1] in the *Amazon Simple Storage Service User Guide*.
+ *
+ * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html
+ */
 final class BucketOwnerAccess
 {
     public const FULL = 'FULL';

src/Enum/BuildPhaseType.php

@@ -2,21 +2,6 @@
 
 namespace AsyncAws\CodeBuild\Enum;
 
-/**
- * The name of the build phase. Valid values include:.
- *
- * - `BUILD`: Core build activities typically occur in this build phase.
- * - `COMPLETED`: The build has been completed.
- * - `DOWNLOAD_SOURCE`: Source code is being downloaded in this build phase.
- * - `FINALIZING`: The build process is completing in this build phase.
- * - `INSTALL`: Installation activities typically occur in this build phase.
- * - `POST_BUILD`: Post-build activities typically occur in this build phase.
- * - `PRE_BUILD`: Pre-build activities typically occur in this build phase.
- * - `PROVISIONING`: The build environment is being set up.
- * - `QUEUED`: The build has been submitted and is queued behind other submitted builds.
- * - `SUBMITTED`: The build has been submitted.
- * - `UPLOAD_ARTIFACTS`: Build output artifacts are being uploaded to the output location.
- */
 final class BuildPhaseType
 {
     public const BUILD = 'BUILD';

src/Enum/CacheType.php

@@ -2,13 +2,6 @@
 
 namespace AsyncAws\CodeBuild\Enum;
 
-/**
- * The type of cache used by the build project. Valid values include:.
- *
- * - `NO_CACHE`: The build project does not use any cache.
- * - `S3`: The build project reads and writes from and to S3.
- * - `LOCAL`: The build project stores a cache locally on a build host that is only available to that build host.
- */
 final class CacheType
 {
     public const LOCAL = 'LOCAL';

src/Enum/ComputeType.php

@@ -2,27 +2,6 @@
 
 namespace AsyncAws\CodeBuild\Enum;
 
-/**
- * Information about the compute resources the build project uses. Available values include:.
- *
- * - `BUILD_GENERAL1_SMALL`: Use up to 3 GB memory and 2 vCPUs for builds.
- * - `BUILD_GENERAL1_MEDIUM`: Use up to 7 GB memory and 4 vCPUs for builds.
- * - `BUILD_GENERAL1_LARGE`: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.
- * - `BUILD_GENERAL1_2XLARGE`: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute
- *   type supports Docker images up to 100 GB uncompressed.
- *
- * If you use `BUILD_GENERAL1_LARGE`:
- *
- * - For environment type `LINUX_CONTAINER`, you can use up to 15 GB memory and 8 vCPUs for builds.
- * - For environment type `LINUX_GPU_CONTAINER`, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs
- *   for builds.
- * - For environment type `ARM_CONTAINER`, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for
- *   builds.
- *
- * For more information, see Build Environment Compute Types in the *CodeBuild User Guide.*
- *
- * @see https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html
- */
 final class ComputeType
 {
     public const BUILD_GENERAL1_2XLARGE = 'BUILD_GENERAL1_2XLARGE';

src/Enum/CredentialProviderType.php

@@ -2,10 +2,6 @@
 
 namespace AsyncAws\CodeBuild\Enum;
 
-/**
- * The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is
- * for Secrets Manager.
- */
 final class CredentialProviderType
 {
     public const SECRETS_MANAGER = 'SECRETS_MANAGER';

src/Enum/EnvironmentType.php

@@ -2,26 +2,6 @@
 
 namespace AsyncAws\CodeBuild\Enum;
 
-/**
- * The type of build environment to use for related builds.
- *
- * - The environment type `ARM_CONTAINER` is available only in regions US East (N. Virginia), US East (Ohio), US West
- *   (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt).
- * - The environment type `LINUX_CONTAINER` with compute type `build.general1.2xlarge` is available only in regions US
- *   East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt),
- *   Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and
- *   China (Ningxia).
- * - The environment type `LINUX_GPU_CONTAINER` is available only in regions US East (N. Virginia), US East (Ohio), US
- *   West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific
- *   (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).
- *
- * - The environment types `WINDOWS_CONTAINER` and `WINDOWS_SERVER_2019_CONTAINER` are available only in regions US East
- *   (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).
- *
- * For more information, see Build environment compute types in the *CodeBuild user guide*.
- *
- * @see https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html
- */
 final class EnvironmentType
 {
     public const ARM_CONTAINER = 'ARM_CONTAINER';

src/Enum/EnvironmentVariableType.php

@@ -2,18 +2,6 @@
 
 namespace AsyncAws\CodeBuild\Enum;
 
-/**
- * The type of environment variable. Valid values include:.
- *
- * - `PARAMETER_STORE`: An environment variable stored in Systems Manager Parameter Store. To learn how to specify a
- *   parameter store environment variable, see env/parameter-store in the *CodeBuild User Guide*.
- * - `PLAINTEXT`: An environment variable in plain text format. This is the default value.
- * - `SECRETS_MANAGER`: An environment variable stored in Secrets Manager. To learn how to specify a secrets manager
- *   environment variable, see env/secrets-manager in the *CodeBuild User Guide*.
- *
- * @see https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store
- * @see https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager
- */
 final class EnvironmentVariableType
 {
     public const PARAMETER_STORE = 'PARAMETER_STORE';

src/Enum/FileSystemType.php

@@ -2,9 +2,6 @@
 
 namespace AsyncAws\CodeBuild\Enum;
 
-/**
- * The type of the file system. The one supported type is `EFS`.
- */
 final class FileSystemType
 {
     public const EFS = 'EFS';

src/Enum/ImagePullCredentialsType.php

@@ -2,16 +2,6 @@
 
 namespace AsyncAws\CodeBuild\Enum;
 
-/**
- * The type of credentials CodeBuild uses to pull images in your build. There are two valid values:.
- *
- * - `CODEBUILD` specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository
- *   policy to trust CodeBuild service principal.
- * - `SERVICE_ROLE` specifies that CodeBuild uses your build project's service role.
- *
- * When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an
- * CodeBuild curated image, you must use CODEBUILD credentials.
- */
 final class ImagePullCredentialsType
 {
     public const CODEBUILD = 'CODEBUILD';

src/Enum/LogsConfigStatusType.php

@@ -2,12 +2,6 @@
 
 namespace AsyncAws\CodeBuild\Enum;
 
-/**
- * The current status of the logs in CloudWatch Logs for a build project. Valid values are:.
- *
- * - `ENABLED`: CloudWatch Logs are enabled for this build project.
- * - `DISABLED`: CloudWatch Logs are not enabled for this build project.
- */
 final class LogsConfigStatusType
 {
     public const DISABLED = 'DISABLED';

src/Enum/SourceAuthType.php

@@ -2,11 +2,6 @@
 
 namespace AsyncAws\CodeBuild\Enum;
 
-/**
- * > This data type is deprecated and is no longer accurate or used.
- *
- * The authorization type to use. The only valid value is `OAUTH`, which represents the OAuth authorization type.
- */
 final class SourceAuthType
 {
     public const OAUTH = 'OAUTH';

src/Enum/SourceType.php

@@ -2,17 +2,6 @@
 
 namespace AsyncAws\CodeBuild\Enum;
 
-/**
- * The type of repository that contains the source code to be built. Valid values include:.
- *
- * - `BITBUCKET`: The source code is in a Bitbucket repository.
- * - `CODECOMMIT`: The source code is in an CodeCommit repository.
- * - `CODEPIPELINE`: The source code settings are specified in the source action of a pipeline in CodePipeline.
- * - `GITHUB`: The source code is in a GitHub or GitHub Enterprise Cloud repository.
- * - `GITHUB_ENTERPRISE`: The source code is in a GitHub Enterprise Server repository.
- * - `NO_SOURCE`: The project does not have input source code.
- * - `S3`: The source code is in an Amazon S3 bucket.
- */
 final class SourceType
 {
     public const BITBUCKET = 'BITBUCKET';

src/Enum/StatusType.php

@@ -2,16 +2,6 @@
 
 namespace AsyncAws\CodeBuild\Enum;
 
-/**
- * The current status of the build phase. Valid values include:.
- *
- * - `FAILED`: The build phase failed.
- * - `FAULT`: The build phase faulted.
- * - `IN_PROGRESS`: The build phase is still in progress.
- * - `STOPPED`: The build phase stopped.
- * - `SUCCEEDED`: The build phase succeeded.
- * - `TIMED_OUT`: The build phase timed out.
- */
 final class StatusType
 {
     public const FAILED = 'FAILED';