Fix documentation and method name for setting post permalink in const…

…ructor. git-svn-id: http://svn.php.net/repository/pear/packages/Services_Akismet/trunk@272076 c90b9560-bf6c-de11-be94-00142212c4b1
pear · Dec 28, 2008 · 0b5d206 · 0b5d206
1 parent d4a4978
commit 0b5d206
Showing 1 changed file with 9 additions and 7 deletions.
diff --git a/Akismet/Comment.php b/Akismet/Comment.php
@@ -7,11 +7,12 @@
  *
  * Example Usage:
  * <code>
- * $comment = new Services_Akismet_Comment();
- * $comment->setAuthor('Test Author');
- * $comment->setAuthorEmail('test@example.com');
- * $comment->setAuthorUri('http://example.com/');
- * $comment->setContent('Hello, World!');
+ * $comment = new Services_Akismet_Comment(array(
+ *     'author'      => 'Test Author',
+ *     'authorEmail' => 'test@example.com',
+ *     'authorUri'   => 'http://example.com/',
+ *     'content'     => 'Hello, World!'
+ * ));
  *
  * echo $comment;
  * </code>
@@ -168,7 +169,8 @@ class Services_Akismet_Comment
      * - <kbd>string authorUri</kbd>   - a link provided by the comment
      *                                   author.
      * - <kbd>string content</kbd>     - the content of the comment.
-     * - <kbd>string permalink</kbd>   - permalink of the comment.
+     * - <kbd>string permalink</kbd>   - permalink of the post to which the
+     *                                   comment is being added.
      * - <kbd>string referrer</kbd>    - HTTP referrer. If not specified, the
      *                                   HTTP referrer of the current request
      *                                   is used.
@@ -220,7 +222,7 @@ public function __construct(array $fields = array())
         }
 
         if (array_key_exists('permalink', $fields)) {
-            $this->setPermalink($fields['permalink']);
+            $this->setPostPermalink($fields['permalink']);
         }
 
         if (array_key_exists('referrer', $fields)) {