Document core classes up to EntityLookup.php

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

library/HTMLPurifier/ConfigDef.php

@@ -1,15 +1,29 @@
 <?php
 
+/**
+ * Configuration definition, defines directives and their defaults.
+ * @todo Build documentation generation capabilities.
+ */
 class HTMLPurifier_ConfigDef {
     
+    /**
+     * Currently defined directives (and namespaces).
+     * @note This shares the exact same structure as HTMLPurifier_Config::$conf
+     */
     var $info = array();
     
+    /**
+     * Initializes the default namespaces.
+     */
     function initialize() {
         $this->defineNamespace('Core', 'Core features that are always available.');
         $this->defineNamespace('Attr', 'Features regarding attribute validation.');
         $this->defineNamespace('URI', 'Features regarding Uniform Resource Identifiers.');
     }
     
+    /**
+     * Retrieves an instance of the application-wide configuration definition.
+     */
     function &instance($prototype = null) {
         static $instance;
         if ($prototype !== null) {
@@ -21,6 +35,17 @@ class HTMLPurifier_ConfigDef {
         return $instance;
     }
     
+    /**
+     * Defines a directive for configuration
+     * @warning Will fail of directive's namespace is defined
+     * @todo Collect information on description and allow redefinition
+     *       so that multiple files can register a dependency on a
+     *       configuration directive.
+     * @param $namespace Namespace the directive is in
+     * @param $name Key of directive
+     * @param $default Default value of directive
+     * @param $description Description of directive for documentation
+     */
     function define($namespace, $name, $default, $description) {
         $def =& HTMLPurifier_ConfigDef::instance();
         if (!isset($def->info[$namespace])) {
@@ -36,6 +61,11 @@ class HTMLPurifier_ConfigDef {
         $def->info[$namespace][$name] = $default;
     }
     
+    /**
+     * Defines a namespace for directives to be put into.
+     * @param $namespace Namespace's name
+     * @param $description Description of the namespace
+     */
     function defineNamespace($namespace, $description) {
         $def =& HTMLPurifier_ConfigDef::instance();
         if (isset($def->info[$namespace])) {