Permalink
Browse files

MINOR Documentation (from r104402)

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/cms/trunk@112452 467b73ca-7a2a-4603-9d3b-597d59a354a9
  • Loading branch information...
1 parent e9b8594 commit ece834e9479fbbc8e22b88fa4d324920243151a5 @chillu chillu committed Oct 15, 2010
Showing with 16 additions and 0 deletions.
  1. +16 −0 code/sitefeatures/SSAkismet.php
View
16 code/sitefeatures/SSAkismet.php
@@ -1,5 +1,21 @@
<?php
/**
+ * The SSAkismet class provides spam detection for comments using http://akismet.com/.
+ * In order to use it, you must get an API key, which you can get free for non-commercial use by signing
+ * up for a http://www.wordpress.com account. Commercial keys can be bought at http://akismet.com/commercial/.
+ *
+ * To enable spam detection, set your API key in _config.php.
+ * The following lines should be added to **mysite/_config.php**
+ * (or to the _config.php in another folder if you're not using mysite).
+ *
+ * <code>
+ * SSAkismet::setAPIKey('<your-key>');
+ * </code>
+ *
+ * You can then view spam for a page by appending <i>?showspam=1</i> to the url, or use the {@link CommentAdmin} in the CMS.
+ *
+ * @see http://demo.silverstripe.com/blog Demo of SSAkismet in action
+ *
* @package cms
* @subpackage comments
*/

0 comments on commit ece834e

Please sign in to comment.