Generates proper documentation for classes and properties (#1418)

Author: jderusse

src/CodeCommitClient.php

@@ -131,6 +131,9 @@ public function createRepository($input): CreateRepositoryOutput
     /**
      * Deletes a repository. If a specified repository was already deleted, a null repository ID is returned.
      *
+     * ! Deleting a repository also deletes all associated objects and metadata. After a repository is deleted, all future
+     * ! push calls to the deleted repository fail.
+     *
      * @see https://docs.aws.amazon.com/codecommit/latest/APIReference/API_DeleteRepository.html
      * @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-codecommit-2015-04-13.html#deleterepository
      *

src/Enum/ChangeTypeEnum.php

@@ -2,9 +2,6 @@
 
 namespace AsyncAws\CodeCommit\Enum;
 
-/**
- * Whether the change type of the difference is an addition (A), deletion (D), or modification (M).
- */
 final class ChangeTypeEnum
 {
     public const A = 'A';

src/Enum/OrderEnum.php

@@ -2,9 +2,6 @@
 
 namespace AsyncAws\CodeCommit\Enum;
 
-/**
- * The order in which to sort the results of a list repositories operation.
- */
 final class OrderEnum
 {
     public const ASCENDING = 'ascending';

src/Enum/SortByEnum.php

@@ -2,9 +2,6 @@
 
 namespace AsyncAws\CodeCommit\Enum;
 
-/**
- * The criteria used to sort the results of a list repositories operation.
- */
 final class SortByEnum
 {
     public const LAST_MODIFIED_DATE = 'lastModifiedDate';

src/Exception/FileTooLargeException.php

@@ -6,9 +6,9 @@
 
 /**
  * The specified file exceeds the file size limit for AWS CodeCommit. For more information about limits in AWS
- * CodeCommit, see AWS CodeCommit User Guide.
+ * CodeCommit, see AWS CodeCommit User Guide [^1].
  *
- * @see https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html
+ * [^1]: https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html
  */
 final class FileTooLargeException extends ClientException
 {

src/Input/CreateRepositoryInput.php

@@ -15,6 +15,12 @@ final class CreateRepositoryInput extends Input
     /**
      * The name of the new repository to be created.
      *
+     * > The repository name must be unique across the calling AWS account. Repository names are limited to 100
+     * > alphanumeric, dash, and underscore characters, and cannot include certain characters. For more information about
+     * > the limits on repository names, see Limits [^1] in the *AWS CodeCommit User Guide*. The suffix .git is prohibited.
+     *
+     * [^1]: https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html
+     *
      * @required
      *
      * @var string|null
@@ -24,6 +30,11 @@ final class CreateRepositoryInput extends Input
     /**
      * A comment or description about the new repository.
      *
+     * > The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications
+     * > that do not HTML-encode the description and display it in a webpage can expose users to potentially malicious code.
+     * > Make sure that you HTML-encode the description field in any application that uses this API to display the
+     * > repository description on a webpage.
+     *
      * @var string|null
      */
     private $repositoryDescription;

src/ValueObject/BlobMetadata.php

@@ -3,7 +3,7 @@
 namespace AsyncAws\CodeCommit\ValueObject;
 
 /**
- * Information about a `beforeBlob` data type object, including the ID, the file mode permission code, and the path.
+ * Returns information about a specific Git blob object.
  */
 final class BlobMetadata
 {
@@ -19,6 +19,14 @@ final class BlobMetadata
 
     /**
      * The file mode permissions of the blob. File mode permission codes include:.
+     *
+     * - `100644` indicates read/write
+     * -
+     * - `100755` indicates read/write/execute
+     * -
+     * - `160000` indicates a submodule
+     * -
+     * - `120000` indicates a symlink
      */
     private $mode;
 

src/ValueObject/BranchInfo.php

@@ -3,7 +3,7 @@
 namespace AsyncAws\CodeCommit\ValueObject;
 
 /**
- * The name of the branch.
+ * Returns information about a branch.
  */
 final class BranchInfo
 {

src/ValueObject/Commit.php

@@ -3,7 +3,7 @@
 namespace AsyncAws\CodeCommit\ValueObject;
 
 /**
- * A commit data type object that contains information about the specified commit.
+ * Returns information about a specific commit.
  */
 final class Commit
 {
@@ -37,6 +37,11 @@ final class Commit
      * Information about the person who committed the specified commit, also known as the committer. Information includes
      * the date in timestamp format with GMT offset, the name of the committer, and the email address for the committer, as
      * configured in Git.
+     *
+     * For more information about the difference between an author and a committer in Git, see Viewing the Commit History
+     * [^1] in Pro Git by Scott Chacon and Ben Straub.
+     *
+     * [^1]: http://git-scm.com/book/ch2-3.html
      */
     private $committer;
 

src/ValueObject/RepositoryMetadata.php

@@ -3,7 +3,7 @@
 namespace AsyncAws\CodeCommit\ValueObject;
 
 /**
- * Information about the newly created repository.
+ * Information about a repository.
  */
 final class RepositoryMetadata
 {