added many function comments for phpDocumentor

git-svn-id: file:///var/lib/svn/phpfspot/trunk@210 fa6a889d-dae6-447d-9e79-4ba9a3039384

1 files changed, 14 insertions, 0 deletions

diff --git a/phpfspot_img.php b/phpfspot_img.php
index bd811e8..194b534 100644
--- a/phpfspot_img.php
+++ b/phpfspot_img.php
@@ -28,6 +28,9 @@ class PHPFSPOT_IMG {
    var $db;
    var $parent;
 
+   /**
+    * PHPFSPOT_IMG class constructor
+    */
    public function __construct()
    {
       $this->parent = new PHPFSPOT;
@@ -35,11 +38,22 @@ class PHPFSPOT_IMG {
 
    } // __construct()
 
+   /**
+    * PHPFSPOT_IMG class destructor
+    */
    public function __destruct()
    {
 
    } // __desctruct()
 
+   /**
+    * sends the specified image to the browser
+    *
+    * this function will send the specified image to 
+    * the client - in the specified width. it also try's
+    * to create on-the-fly missing thumbnails via PHPFSPOT
+    * gen_thumbs function.
+    */
    public function show($idx, $width = 0)
    {
       $details = $this->parent->get_photo_details($idx);