Document core classes up to EntityLookup.php

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

library/HTMLPurifier/EntityLookup.php

@@ -1,12 +1,22 @@
 <?php
 
+/**
+ * Object that provides entity lookup table from entity name to character
+ */
 class HTMLPurifier_EntityLookup {
     
+    /**
+     * Assoc array of entity name to character represented.
+     * @public
+     */
     var $table;
     
-    function HTMLPurifier_EntityLookup() {}
-    
-    // to enforce Singleton-ness
+    /**
+     * Sets up the entity lookup table from the serialized file contents.
+     * @note The serialized contents are versioned, but were generated
+     *       using the maintenance script generate_entity_file.php
+     * @warning This is not in constructor to help enforce the Singleton
+     */
     function setup($file = false) {
         if (!$file) {
             $file = dirname(__FILE__) . '/EntityLookup/data.txt';
@@ -14,6 +24,10 @@ class HTMLPurifier_EntityLookup {
         $this->table = unserialize(file_get_contents($file));
     }
     
+    /**
+     * Retrieves sole instance of the object.
+     * @param Optional prototype of custom lookup table to overload with.
+     */
     function instance($prototype = false) {
         // no references, since PHP doesn't copy unless modified
         static $instance = null;