MINOR: Fix documentation for Diff::cleanHTML

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/cms/branches/2.4@98477 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
Luke Hudson 2010-02-08 23:17:28 +00:00 committed by Sam Minnee
parent 166b5fb95b
commit 4192dcdf07

View File

@ -664,13 +664,10 @@ class Diff
/** /**
* Attempt to clean invalid HTML, which messes up diffs. * Attempt to clean invalid HTML, which messes up diffs.
* This checks for various methods and cleans code if possible. * This cleans code if possible, using an instance of HTMLCleaner
* *
* NB: By default, only extremely simple tidying is performed, * NB: By default, only extremely simple tidying is performed,
* by passing through DomDocument::loadHTML and saveXML * by passing through DomDocument::loadHTML and saveXML
* You will either need to install the php_tidy module
* See: http://www.php.net/manual/en/tidy.installation.php
* See also: http://htmlpurifier.org
* *
* @param string $content HTML content * @param string $content HTML content
* @param object $cleaner Optional instance of a HTMLCleaner class to * @param object $cleaner Optional instance of a HTMLCleaner class to