Merge pull request aws#835 from jeskew/fix/update-docblock-on-ses-client

Add a docblock to the generateSmtpPassword method
casualuser · Dec 4, 2015 · 9f3b6e0 · 9f3b6e0
2 parents 56f1329 + 5dcef91
commit 9f3b6e0
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/src/Ses/SesClient.php b/src/Ses/SesClient.php
@@ -87,6 +87,17 @@
  */
 class SesClient extends \Aws\AwsClient
 {
+    /**
+     * Create an SMTP password for a given IAM user's credentials.
+     *
+     * The SMTP username is the Access Key ID for the provided credentials.
+     *
+     * @link http://docs.aws.amazon.com/ses/latest/DeveloperGuide/smtp-credentials.html#smtp-credentials-convert
+     *
+     * @param CredentialsInterface $creds
+     *
+     * @return string
+     */
     public static function generateSmtpPassword(CredentialsInterface $creds)
     {
         static $version = "\x02";