Document core classes up to EntityLookup.php

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

library/HTMLPurifier/Config.php

@@ -1,7 +1,10 @@
 <?php
 
 /**
- * 
+ * Configuration object that triggers customizable behavior.
+ *
+ * @warning This class is strongly defined: that means that the class
+ *          will fail if an undefined directive is retrieved or set.
  * 
  * @note Many classes that could (although many times don't) use the
  *       configuration object make it a mandatory parameter.  This is
@@ -12,18 +15,34 @@
 class HTMLPurifier_Config
 {
     
+    /**
+     * Two-level associative array of configuration directives
+     */
     var $conf;
     
+    /**
+     * @param $definition HTMLPurifier_ConfigDef that defines what directives
+     *                    are allowed.
+     */
     function HTMLPurifier_Config(&$definition) {
         $this->conf = $definition->info; // set up the defaults
     }
     
+    /**
+     * Convenience constructor that creates a default configuration object.
+     * @return Default HTMLPurifier_Config object.
+     */
     function createDefault() {
         $definition =& HTMLPurifier_ConfigDef::instance();
         $config = new HTMLPurifier_Config($definition);
         return $config;
     }
     
+    /**
+     * Retreives a value from the configuration.
+     * @param $namespace String namespace
+     * @param $key String key
+     */
     function get($namespace, $key) {
         if (!isset($this->conf[$namespace][$key])) {
             trigger_error('Cannot retrieve value of undefined directive',
@@ -33,6 +52,12 @@ class HTMLPurifier_Config
         return $this->conf[$namespace][$key];
     }
     
+    /**
+     * Sets a value to configuration.
+     * @param $namespace String namespace
+     * @param $key String key
+     * @param $value Mixed value
+     */
     function set($namespace, $key, $value) {
         if (!isset($this->conf[$namespace][$key])) {
             trigger_error('Cannot set undefined directive to value',