diff --git a/NEWS b/NEWS index 00139015..9a80c1ca 100644 --- a/NEWS +++ b/NEWS @@ -4,6 +4,7 @@ NEWS ( CHANGELOG and HISTORY ) HTMLPurifier 1.0.0rc1, released 2006-??-?? - Fixed broken numeric entity conversion - Malformed UTF-8 and non-SGML character detection and cleaning implemented +- API documentation completed 1.0.0beta, released 2006-08-16 - First public release, most functionality implemented. Notable omissions are: diff --git a/library/HTMLPurifier/URIScheme/ftp.php b/library/HTMLPurifier/URIScheme/ftp.php index df7837ee..0c97d951 100644 --- a/library/HTMLPurifier/URIScheme/ftp.php +++ b/library/HTMLPurifier/URIScheme/ftp.php @@ -2,6 +2,10 @@ require_once 'HTMLPurifier/URIScheme.php'; +/** + * Validates ftp (File Transfer Protocol) URIs as defined by generic RFC 1738. + * @todo Typecode check on path + */ class HTMLPurifier_URIScheme_ftp extends HTMLPurifier_URIScheme { var $default_port = 21; diff --git a/library/HTMLPurifier/URIScheme/http.php b/library/HTMLPurifier/URIScheme/http.php index 4ea0c706..0eeb00c3 100644 --- a/library/HTMLPurifier/URIScheme/http.php +++ b/library/HTMLPurifier/URIScheme/http.php @@ -2,6 +2,9 @@ require_once 'HTMLPurifier/URIScheme.php'; +/** + * Validates http (HyperText Transfer Protocol) as defined by RFC 2616 + */ class HTMLPurifier_URIScheme_http extends HTMLPurifier_URIScheme { var $default_port = 80; diff --git a/library/HTMLPurifier/URIScheme/https.php b/library/HTMLPurifier/URIScheme/https.php index 6798eeab..7f896592 100644 --- a/library/HTMLPurifier/URIScheme/https.php +++ b/library/HTMLPurifier/URIScheme/https.php @@ -2,6 +2,9 @@ require_once 'HTMLPurifier/URIScheme/http.php'; +/** + * Validates https (Secure HTTP) according to http scheme. + */ class HTMLPurifier_URIScheme_https extends HTMLPurifier_URIScheme_http { var $default_port = 443; diff --git a/library/HTMLPurifier/URIScheme/mailto.php b/library/HTMLPurifier/URIScheme/mailto.php index 60969ec1..6a30f7fd 100644 --- a/library/HTMLPurifier/URIScheme/mailto.php +++ b/library/HTMLPurifier/URIScheme/mailto.php @@ -5,6 +5,12 @@ require_once 'HTMLPurifier/URIScheme.php'; // VERY RELAXED! Shouldn't cause problems, not even Firefox checks if the // email is valid, but be careful! +/** + * Validates mailto (for E-mail) according to RFC 2368 + * @todo Validate the email address + * @todo Filter allowed query parameters + */ + class HTMLPurifier_URIScheme_mailto extends HTMLPurifier_URIScheme { function validateComponents( diff --git a/library/HTMLPurifier/URIScheme/news.php b/library/HTMLPurifier/URIScheme/news.php index f78f2e35..5ce8508b 100644 --- a/library/HTMLPurifier/URIScheme/news.php +++ b/library/HTMLPurifier/URIScheme/news.php @@ -2,6 +2,9 @@ require_once 'HTMLPurifier/URIScheme.php'; +/** + * Validates news (Usenet) as defined by generic RFC 1738 + */ class HTMLPurifier_URIScheme_news extends HTMLPurifier_URIScheme { function validateComponents( diff --git a/library/HTMLPurifier/URIScheme/nntp.php b/library/HTMLPurifier/URIScheme/nntp.php index d5ce7d90..78cbf813 100644 --- a/library/HTMLPurifier/URIScheme/nntp.php +++ b/library/HTMLPurifier/URIScheme/nntp.php @@ -2,6 +2,9 @@ require_once 'HTMLPurifier/URIScheme.php'; +/** + * Validates nntp (Network News Transfer Protocol) as defined by generic RFC 1738 + */ class HTMLPurifier_URIScheme_nntp extends HTMLPurifier_URIScheme { var $default_port = 119;