[Fusionforge-commits] r11709 - trunk/src/common/include

Franck VILLAUME nerville at libremir.placard.fr.eu.org
Mon Dec 6 09:04:01 CET 2010


Author: nerville
Date: 2010-12-06 09:04:01 +0100 (Mon, 06 Dec 2010)
New Revision: 11709

Modified:
   trunk/src/common/include/Plugin.class.php
Log:
cleanup

Modified: trunk/src/common/include/Plugin.class.php
===================================================================
--- trunk/src/common/include/Plugin.class.php	2010-12-05 16:55:57 UTC (rev 11708)
+++ trunk/src/common/include/Plugin.class.php	2010-12-06 08:04:01 UTC (rev 11709)
@@ -33,6 +33,7 @@
 	/**
 	 * Plugin() - constructor
 	 *
+	 * @param	int	id
 	 */
 	function Plugin($id=0) {
 		$this->Error();
@@ -51,7 +52,7 @@
 	/**
 	 * _addHooks() - add a hook to the list of hooks.
 	 *
-	 * @return	string
+	 * @return	string	name of the added hook
 	 */
 	function _addHook($name) {
 		return $this->hooks[]=$name;
@@ -91,7 +92,7 @@
 	 * Added for Codendi compatibility
 	 * getPluginPath() - get installation dir for the plugin.
 	 *
-	 * @return the directory where the plugin should be linked.
+	 * @return	string	the directory where the plugin should be linked.
 	 */
 	function getPluginPath() {
 		if (isset($this->installdir) && $this->installdir)
@@ -128,11 +129,16 @@
 		
 		for ($i=0; $i<$rows; $i++) {
 			$group_id = db_result($res,$i,'group_id');
-			$result[] = group_get_object ($group_id);
+			$result[] = group_get_object($group_id);
 		}
 		return $result;
 	}
 
+	/*
+	 * getThemePath - returns the directory of the theme for this plugin
+	 *
+	 * @return	string	the directory
+	 */
 	function getThemePath(){
 		return util_make_url('plugins/'.$this->name.'/themes/default');
 	}




More information about the Fusionforge-commits mailing list