[Linpha-cvs] SF.net SVN: linpha: [4455] trunk/linpha2

[<bz...@us...>]

Revision: 4455
Author:   bzrudi
Date:     2006-03-29 08:53:38 -0800 (Wed, 29 Mar 2006)
ViewCVS:  http://svn.sourceforge.net/linpha/?rev=4455&view=rev

Log Message:
-----------
added some phpdoc tags and minor code cleanups

Modified Paths:
--------------
    trunk/linpha2/get_thumb.php
    trunk/linpha2/lib/classes/linpha.filesys.class.php
    trunk/linpha2/lib/classes/linpha.functions.php
    trunk/linpha2/lib/classes/linpha.identify.class.php
    trunk/linpha2/lib/classes/linpha.image.class.php
    trunk/linpha2/lib/classes/linpha.imgview.class.php
    trunk/linpha2/lib/classes/linpha.import.class.php
    trunk/linpha2/lib/classes/linpha.metadata.class.php
    trunk/linpha2/lib/classes/linpha.sql.class.php
    trunk/linpha2/lib/classes/linpha.template.class.php
    trunk/linpha2/lib/lang/language.php
    trunk/linpha2/lib/modules/module.albums.php
    trunk/linpha2/lib/modules/module.basket.php
    trunk/linpha2/lib/modules/module.browse.php
    trunk/linpha2/lib/modules/module.search.php
Modified: trunk/linpha2/get_thumb.php
===================================================================
--- trunk/linpha2/get_thumb.php	2006-03-29 16:52:29 UTC (rev 4454)
+++ trunk/linpha2/get_thumb.php	2006-03-29 16:53:38 UTC (rev 4455)
@@ -1,4 +1,28 @@
 <?php
+/*
+* Copyright (c) 2005 Heiko Rutenbeck <bz...@tu...>
+*                    Florian Angehrn 
+* 
+* This program is free software; you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published by
+* the Free Software Foundation; either version 2 of the License, or
+*  (at your option) any later version.
+*
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with this program; if not, write to the Free Software
+* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+/**
+ * Thumb view related methods and functions
+ * @package Image
+ */
+ 
 if(!defined('LINPHA_DIR')) { define('LINPHA_DIR','.'); }
 
 include_once(LINPHA_DIR.'/lib/classes/linpha.class.php');

Modified: trunk/linpha2/lib/classes/linpha.filesys.class.php
===================================================================
--- trunk/linpha2/lib/classes/linpha.filesys.class.php	2006-03-29 16:52:29 UTC (rev 4454)
+++ trunk/linpha2/lib/classes/linpha.filesys.class.php	2006-03-29 16:53:38 UTC (rev 4455)
@@ -20,6 +20,7 @@
 
 /**
  * This class holds a number of methods for filesys related access
+ * @package Filesystem
  */
 
 

Modified: trunk/linpha2/lib/classes/linpha.functions.php
===================================================================
--- trunk/linpha2/lib/classes/linpha.functions.php	2006-03-29 16:52:29 UTC (rev 4454)
+++ trunk/linpha2/lib/classes/linpha.functions.php	2006-03-29 16:53:38 UTC (rev 4455)
@@ -19,6 +19,11 @@
 */
 
 /**
+ * Just a couple of useful functions
+ * @package Functions
+ */
+ 
+/**
  * Take care of translation
  * 
  * This simple method takes care of all translation related stuff.

Modified: trunk/linpha2/lib/classes/linpha.identify.class.php
===================================================================
--- trunk/linpha2/lib/classes/linpha.identify.class.php	2006-03-29 16:52:29 UTC (rev 4454)
+++ trunk/linpha2/lib/classes/linpha.identify.class.php	2006-03-29 16:53:38 UTC (rev 4455)
@@ -21,6 +21,7 @@
 /**
  * This class takes care of image and file identifying due
  * a couple of possible methods
+ * @package Image
  */
 
 class LinIdentify

Modified: trunk/linpha2/lib/classes/linpha.image.class.php
===================================================================
--- trunk/linpha2/lib/classes/linpha.image.class.php	2006-03-29 16:52:29 UTC (rev 4454)
+++ trunk/linpha2/lib/classes/linpha.image.class.php	2006-03-29 16:53:38 UTC (rev 4455)
@@ -20,6 +20,7 @@
 
 /**
  * This class provides a couple methods for image manipulation/creation
+ * @package Image
  */
 
 class LinImage

Modified: trunk/linpha2/lib/classes/linpha.imgview.class.php
===================================================================
--- trunk/linpha2/lib/classes/linpha.imgview.class.php	2006-03-29 16:52:29 UTC (rev 4454)
+++ trunk/linpha2/lib/classes/linpha.imgview.class.php	2006-03-29 16:53:38 UTC (rev 4455)
@@ -20,6 +20,7 @@
 
 /**
  * This class takes care of all different views (thumb view, menus...)
+ * @package Image
  */
 if(!defined('LINPHA_DIR')) { exit(1); }
 

Modified: trunk/linpha2/lib/classes/linpha.import.class.php
===================================================================
--- trunk/linpha2/lib/classes/linpha.import.class.php	2006-03-29 16:52:29 UTC (rev 4454)
+++ trunk/linpha2/lib/classes/linpha.import.class.php	2006-03-29 16:53:38 UTC (rev 4455)
@@ -20,8 +20,9 @@
 
 /**
  * This class takes automagic care of added/deleted images and albums 
+ * @package Image
  */
-class linImport
+class LinImport
 {
 
 /**

Modified: trunk/linpha2/lib/classes/linpha.metadata.class.php
===================================================================
--- trunk/linpha2/lib/classes/linpha.metadata.class.php	2006-03-29 16:52:29 UTC (rev 4454)
+++ trunk/linpha2/lib/classes/linpha.metadata.class.php	2006-03-29 16:53:38 UTC (rev 4455)
@@ -1,11 +1,8 @@
 <?php
-/**
- * This class handles all the EXIF and IPTC stuff used in LinPHA
- */
- 
 /*
-* Copyright (c) 2002-2005 Heiko Rutenbeck <bz...@tu...>
-*
+* Copyright (c) 2005 Heiko Rutenbeck <bz...@tu...>
+*                    Florian Angehrn 
+* 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
@@ -21,6 +18,11 @@
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
+/**
+ * This class handles all the EXIF and IPTC stuff used in LinPHA
+ * @package Metadata
+ */
+ 
 if(!defined('LINPHA_DIR')) { exit(1); }
 
 class MetaData {

Modified: trunk/linpha2/lib/classes/linpha.sql.class.php
===================================================================
--- trunk/linpha2/lib/classes/linpha.sql.class.php	2006-03-29 16:52:29 UTC (rev 4454)
+++ trunk/linpha2/lib/classes/linpha.sql.class.php	2006-03-29 16:53:38 UTC (rev 4455)
@@ -1,7 +1,8 @@
 <?php
 /*
 * Copyright (c) 2005 Heiko Rutenbeck <bz...@tu...>
-*
+*                    Florian Angehrn 
+* 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
@@ -17,8 +18,12 @@
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
+/**
+ * This class holds database related methods
+ * @package Database
+ */
 
-class linSql
+class LinSql
 {
 public $passed;
 public $config;	// sub class $linpha->sql->config
@@ -26,7 +31,7 @@
 /**
  * constructor
  */
-function linSql()
+function __construct()
 {
 	
 }
@@ -401,7 +406,7 @@
  * 
  * read all config values in $linpha->sql->config->*
  */
-function linSqlConfig()
+function LinSqlConfig()
 {
 	$this->reloadConfig();
 }

Modified: trunk/linpha2/lib/classes/linpha.template.class.php
===================================================================
--- trunk/linpha2/lib/classes/linpha.template.class.php	2006-03-29 16:52:29 UTC (rev 4454)
+++ trunk/linpha2/lib/classes/linpha.template.class.php	2006-03-29 16:53:38 UTC (rev 4455)
@@ -1,6 +1,28 @@
 <?php
+/*
+* Copyright (c) 2005 Heiko Rutenbeck <bz...@tu...>
+*                    Florian Angehrn 
+* 
+* This program is free software; you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published by
+* the Free Software Foundation; either version 2 of the License, or
+*  (at your option) any later version.
+*
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with this program; if not, write to the Free Software
+* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
 
-class linTemplate
+/**
+ * This class takes care of LinPHAs template layouts
+ * @package Template 
+ */
+class LinTemplate
 {
 	public $template_name;
 	public $output;

Modified: trunk/linpha2/lib/lang/language.php
===================================================================
--- trunk/linpha2/lib/lang/language.php	2006-03-29 16:52:29 UTC (rev 4454)
+++ trunk/linpha2/lib/lang/language.php	2006-03-29 16:53:38 UTC (rev 4455)
@@ -1,7 +1,8 @@
 <?php
 /*
-* Copyright (c) 2006 Heiko Rutenbeck <bz...@tu...>
-*
+* Copyright (c) 2005 Heiko Rutenbeck <bz...@tu...>
+*                    Florian Angehrn 
+* 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
@@ -16,6 +17,15 @@
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
+
+/**
+ * This file takes care of all translation related things.
+ * Like updates for language files, listing of all currently used phrases and
+ * the option to let users create new files via webinterface.
+ * @todo take care of removed entries
+ * @package Translation
+ */
+ 
 if(!defined('LINPHA_DIR')) { define('LINPHA_DIR','../..'); }
 
 print_xhtml_header();

Modified: trunk/linpha2/lib/modules/module.albums.php
===================================================================
--- trunk/linpha2/lib/modules/module.albums.php	2006-03-29 16:52:29 UTC (rev 4454)
+++ trunk/linpha2/lib/modules/module.albums.php	2006-03-29 16:53:38 UTC (rev 4455)
@@ -1,4 +1,27 @@
 <?php
+/*
+* Copyright (c) 2005 Heiko Rutenbeck <bz...@tu...>
+*                    Florian Angehrn 
+* 
+* This program is free software; you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published by
+* the Free Software Foundation; either version 2 of the License, or
+*  (at your option) any later version.
+*
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with this program; if not, write to the Free Software
+* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+/**
+ * Albums view related methods and functions
+ * @package Template
+ */
 if(!defined('LINPHA_DIR')) { exit(1); }
 
 /**

Modified: trunk/linpha2/lib/modules/module.basket.php
===================================================================
--- trunk/linpha2/lib/modules/module.basket.php	2006-03-29 16:52:29 UTC (rev 4454)
+++ trunk/linpha2/lib/modules/module.basket.php	2006-03-29 16:53:38 UTC (rev 4455)
@@ -1,4 +1,27 @@
 <?php
+/*
+* Copyright (c) 2005 Heiko Rutenbeck <bz...@tu...>
+*                    Florian Angehrn 
+* 
+* This program is free software; you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published by
+* the Free Software Foundation; either version 2 of the License, or
+*  (at your option) any later version.
+*
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with this program; if not, write to the Free Software
+* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+/**
+ * Basket view related methods and functions
+ * @package Template
+ */
 if(!defined('LINPHA_DIR')) { exit(1); }
 
 /**

Modified: trunk/linpha2/lib/modules/module.browse.php
===================================================================
--- trunk/linpha2/lib/modules/module.browse.php	2006-03-29 16:52:29 UTC (rev 4454)
+++ trunk/linpha2/lib/modules/module.browse.php	2006-03-29 16:53:38 UTC (rev 4455)
@@ -1,4 +1,27 @@
 <?php
+/*
+* Copyright (c) 2005 Heiko Rutenbeck <bz...@tu...>
+*                    Florian Angehrn 
+* 
+* This program is free software; you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published by
+* the Free Software Foundation; either version 2 of the License, or
+*  (at your option) any later version.
+*
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with this program; if not, write to the Free Software
+* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+/**
+ * Navigation view related methods and functions
+ * @package Template
+ */
 if(!defined('LINPHA_DIR')) { exit(1); }
 
 /**

Modified: trunk/linpha2/lib/modules/module.search.php
===================================================================
--- trunk/linpha2/lib/modules/module.search.php	2006-03-29 16:52:29 UTC (rev 4454)
+++ trunk/linpha2/lib/modules/module.search.php	2006-03-29 16:53:38 UTC (rev 4455)
@@ -0,0 +1,26 @@
+<?php
+/*
+* Copyright (c) 2005 Heiko Rutenbeck <bz...@tu...>
+*                    Florian Angehrn 
+* 
+* This program is free software; you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published by
+* the Free Software Foundation; either version 2 of the License, or
+*  (at your option) any later version.
+*
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with this program; if not, write to the Free Software
+* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+/**
+ * Albums view related methods and functions
+ * @package Template
+ */
+ ?>
+ 
\ No newline at end of file


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.