Document URISchemes, this completes internal API documentation.

git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@311 48356398-32a2-884e-a903-53898d9a118a

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:

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;

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;

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;

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(

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(

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;