MidCOM svn: r14328 - in trunk/midcom: build cc.kaktus.exhibitions com.magnettechnologies.contactgrabber com.magnettechnologies.contactgrabber/lib/gmail com.magnettechnologies.contactgrabber/lib/myspace com.mag...

flack midcom-commits at lists.midgard-project.org
Tue Jan 8 23:44:24 CET 2008


Author: flack
Date: Tue Jan  8 23:44:22 2008
New Revision: 14328
URL: http://trac.midgard-project.org/software/changeset/14328

Log:
added @static tags to functions where docs said they were static only

improved docblock layout in some cases and fixed other

plus the usual spelling fixes along the way

Modified:
   trunk/midcom/build/installMidcomCore.php
   trunk/midcom/build/packageMidCOMcore.php
   trunk/midcom/cc.kaktus.exhibitions/navigation.php
   trunk/midcom/com.magnettechnologies.contactgrabber/config.php
   trunk/midcom/com.magnettechnologies.contactgrabber/contactgrabber.php
   trunk/midcom/com.magnettechnologies.contactgrabber/lib/gmail/libgmailer.php
   trunk/midcom/com.magnettechnologies.contactgrabber/lib/myspace/grabMyspace.class.php
   trunk/midcom/com.magnettechnologies.contactgrabber/lib/orkut/grabOrkut.class.php
   trunk/midcom/com.magnettechnologies.contactgrabber/lib/rediff/grabRediff.class.php
   trunk/midcom/com.magnettechnologies.contactgrabber/lib/yahoo/class.GrabYahoo.php
   trunk/midcom/com.magnettechnologies.contactgrabber/lib/yahoo/config.php
   trunk/midcom/de.bitfolge.feedcreator/feedcreator.php
   trunk/midcom/midcom.admin.styleeditor/admin.php
   trunk/midcom/midcom.core/documentation/INSTALL
   trunk/midcom/midcom.core/midcom/application.php
   trunk/midcom/midcom.core/midcom/baseclasses/components/interface.php
   trunk/midcom/midcom.core/midcom/baseclasses/components/request_admin.php
   trunk/midcom/midcom.core/midcom/baseclasses/core/dbobject.php
   trunk/midcom/midcom.core/midcom/core/group.php
   trunk/midcom/midcom.core/midcom/core/group_midgard.php
   trunk/midcom/midcom.core/midcom/core/group_virtual.php
   trunk/midcom/midcom.core/midcom/core/privilege.php
   trunk/midcom/midcom.core/midcom/core/querybuilder.php
   trunk/midcom/midcom.core/midcom/db/article.php
   trunk/midcom/midcom.core/midcom/db/element.php
   trunk/midcom/midcom.core/midcom/db/event.php
   trunk/midcom/midcom.core/midcom/db/eventmember.php
   trunk/midcom/midcom.core/midcom/db/group.php
   trunk/midcom/midcom.core/midcom/db/host.php
   trunk/midcom/midcom.core/midcom/db/member.php
   trunk/midcom/midcom.core/midcom/db/page.php
   trunk/midcom/midcom.core/midcom/db/pageelement.php
   trunk/midcom/midcom.core/midcom/db/person.php
   trunk/midcom/midcom.core/midcom/db/style.php
   trunk/midcom/midcom.core/midcom/db/topic.php
   trunk/midcom/midcom.core/midcom/exec/convert_legacy_metadata.php
   trunk/midcom/midcom.core/midcom/helper/_basicnav.php
   trunk/midcom/midcom.core/midcom/helper/_dbfactory.php
   trunk/midcom/midcom.core/midcom/helper/_styleloader.php
   trunk/midcom/midcom.core/midcom/helper/formatters.php
   trunk/midcom/midcom.core/midcom/helper/imagefilter.php
   trunk/midcom/midcom.core/midcom/helper/itemlist.php
   trunk/midcom/midcom.core/midcom/helper/misc.php
   trunk/midcom/midcom.core/midcom/request.php
   trunk/midcom/midcom.core/midcom/services/indexer/backend/solr.php
   trunk/midcom/midcom.core/midcom/services/metadata.php
   trunk/midcom/midcom.core/midcom/services/rcs/backend/rcs.php
   trunk/midcom/midcom.core/midcom/services/rcs/handler/rcs.php
   trunk/midcom/midcom.helper.datamanager/datatype.php
   trunk/midcom/midcom.helper.datamanager/helpers_select_lists.php
   trunk/midcom/midcom.helper.datamanager/widget_checkbox.php
   trunk/midcom/midcom.helper.datamanager2/controller.php
   trunk/midcom/midcom.helper.datamanager2/type/blobs.php
   trunk/midcom/midcom.helper.filesync/exporter.php
   trunk/midcom/midcom.helper.filesync/importer.php
   trunk/midcom/midcom.helper.replicator/exporter.php
   trunk/midcom/midcom.helper.replicator/importer.php
   trunk/midcom/midcom.helper.replicator/queuemanager.php
   trunk/midcom/midcom.helper.replicator/transporter.php
   trunk/midcom/midcom.helper.replicator/transporter/archive.php
   trunk/midcom/midcom.helper.replicator/transporter/email.php
   trunk/midcom/midcom.helper.replicator/transporter/http.php
   trunk/midcom/midgard.admin.asgard/handler/object/rcs.php
   trunk/midcom/midgard.admin.sitegroup/creation/config/config.php
   trunk/midcom/midgard.admin.sitegroup/creation/host.php
   trunk/midcom/net.nehmer.branchenbuch/branche.php
   trunk/midcom/net.nehmer.branchenbuch/entry.php
   trunk/midcom/net.nehmer.buddylist/entry.php
   trunk/midcom/net.nehmer.buddylist/viewer.php
   trunk/midcom/net.nehmer.comments/viewer.php
   trunk/midcom/net.nehmer.jobmarket/viewer.php
   trunk/midcom/net.nemein.attention/exporter.php
   trunk/midcom/net.nemein.attention/importer.php
   trunk/midcom/net.nemein.beaexporter/main.php
   trunk/midcom/net.nemein.bookmarks/style/admin_welcome.php
   trunk/midcom/net.nemein.featured/handler/featured.php
   trunk/midcom/net.nemein.featured/handler/view.php
   trunk/midcom/net.nemein.registrations/event.php
   trunk/midcom/net.nemein.registrations/registrar.php
   trunk/midcom/net.nemein.registrations/registration.php
   trunk/midcom/net.nemein.wiki/wikipage.php
   trunk/midcom/no.bergfald.rcs/aegir_handler.php
   trunk/midcom/no.bergfald.rcs/backends/aegirrcs.php
   trunk/midcom/no.bergfald.rcs/backends/nemein_rcs_functions.php
   trunk/midcom/no.bergfald.rcs/handler.php
   trunk/midcom/no.bergfald.rcs/rcs.php
   trunk/midcom/no.odindata.quickform2/factory.php
   trunk/midcom/org.maemo.devcodes/application.php
   trunk/midcom/org.maemo.gforgeprofileupdater/gforge/user.php
   trunk/midcom/org.openpsa.contacts/mfa.php
   trunk/midcom/org.openpsa.reports/reports_handler_base.php
   trunk/midcom/org.routamc.photostream/importer.php
   trunk/midcom/org.routamc.positioning/geocoder.php
   trunk/midcom/org.routamc.positioning/importer.php
   trunk/midcom/org.routamc.statusmessage/importer.php
   trunk/midcom/pl.olga.tellafriend/viewer.php
   trunk/midcom/pl.olga.windguru/windguru.php
   trunk/midcom/se.anykey.mmslib/mmslib.php

Modified: trunk/midcom/build/installMidcomCore.php
==============================================================================
--- trunk/midcom/build/installMidcomCore.php	(original)
+++ trunk/midcom/build/installMidcomCore.php	Tue Jan  8 23:44:22 2008
@@ -150,7 +150,7 @@
         
         /***
          * Symlink core MgdSchema
-         **/
+         */
         $module_name = 'midcom_core';
         $schema = sprintf("%s/config/mgdschema/midcom_dbobjects.xml", $this->from);
         if (!file_exists($schema))

Modified: trunk/midcom/build/packageMidCOMcore.php
==============================================================================
--- trunk/midcom/build/packageMidCOMcore.php	(original)
+++ trunk/midcom/build/packageMidCOMcore.php	Tue Jan  8 23:44:22 2008
@@ -74,9 +74,9 @@
 	{
 		$this->returnProperty = $r;
 	}
-    /*
+    /**
      * the template pacakge.xml file to use. 
-     * */
+     */
     public function setTemplate($t) {
         $this->template = $t;
     }
@@ -90,7 +90,9 @@
 
     // todo: add a setVersion from the commandline
     protected $copyfiles = array ();
-    /* array of files in the static dir. */
+    /**
+     * array of files in the static dir. 
+     */
     protected $staticFiles ;
 
 	/**
@@ -149,9 +151,9 @@
     protected function getNotes($package) {
         // todo add release notes...
     }
-    /*
+    /**
      * This method builds the list of files in the static dir and adds them to the 
-     * */
+     */
     protected function addStatic($package) 
     {
 
@@ -187,10 +189,10 @@
         $list->close();
     }
 
-    /*
+    /**
      * sets up the basic packageobject
-     * @returns the package object
-     * */
+     * @return the package object
+     */
     protected function makeBase($options) {
         PEAR::setErrorHandling(PEAR_ERROR_DIE);
         //$package = new PEAR_PackageFileManager2();

Modified: trunk/midcom/cc.kaktus.exhibitions/navigation.php
==============================================================================
--- trunk/midcom/cc.kaktus.exhibitions/navigation.php	(original)
+++ trunk/midcom/cc.kaktus.exhibitions/navigation.php	Tue Jan  8 23:44:22 2008
@@ -12,7 +12,6 @@
  * 
  * @package cc.kaktus.exhibitions
  */
-
 class cc_kaktus_exhibitions_navigation extends midcom_baseclasses_components_navigation
 {
     /**

Modified: trunk/midcom/com.magnettechnologies.contactgrabber/config.php
==============================================================================
--- trunk/midcom/com.magnettechnologies.contactgrabber/config.php	(original)
+++ trunk/midcom/com.magnettechnologies.contactgrabber/config.php	Tue Jan  8 23:44:22 2008
@@ -27,7 +27,7 @@
   * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-  **/
+  */
 
 // Write full path to this istallation directory
 // example: '/home/user/public_html/contacts' (linux)

Modified: trunk/midcom/com.magnettechnologies.contactgrabber/contactgrabber.php
==============================================================================
--- trunk/midcom/com.magnettechnologies.contactgrabber/contactgrabber.php	(original)
+++ trunk/midcom/com.magnettechnologies.contactgrabber/contactgrabber.php	Tue Jan  8 23:44:22 2008
@@ -31,7 +31,7 @@
     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
     *
     * @package com.magnettechnologies.contactgrabber
-    **/
+    */
 class com_magnettechnologies_contactgrabber extends midcom_baseclasses_components_purecode
 {
 

Modified: trunk/midcom/com.magnettechnologies.contactgrabber/lib/gmail/libgmailer.php
==============================================================================
--- trunk/midcom/com.magnettechnologies.contactgrabber/lib/gmail/libgmailer.php	(original)
+++ trunk/midcom/com.magnettechnologies.contactgrabber/lib/gmail/libgmailer.php	Tue Jan  8 23:44:22 2008
@@ -21,7 +21,7 @@
   * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-  **/
+  */
 
 
 ob_start();

Modified: trunk/midcom/com.magnettechnologies.contactgrabber/lib/myspace/grabMyspace.class.php
==============================================================================
--- trunk/midcom/com.magnettechnologies.contactgrabber/lib/myspace/grabMyspace.class.php	(original)
+++ trunk/midcom/com.magnettechnologies.contactgrabber/lib/myspace/grabMyspace.class.php	Tue Jan  8 23:44:22 2008
@@ -21,7 +21,7 @@
   * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-  **/
+  */
 
 class myspace
 {

Modified: trunk/midcom/com.magnettechnologies.contactgrabber/lib/orkut/grabOrkut.class.php
==============================================================================
--- trunk/midcom/com.magnettechnologies.contactgrabber/lib/orkut/grabOrkut.class.php	(original)
+++ trunk/midcom/com.magnettechnologies.contactgrabber/lib/orkut/grabOrkut.class.php	Tue Jan  8 23:44:22 2008
@@ -21,7 +21,7 @@
   * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-  **/
+  */
 
     
 class orkut

Modified: trunk/midcom/com.magnettechnologies.contactgrabber/lib/rediff/grabRediff.class.php
==============================================================================
--- trunk/midcom/com.magnettechnologies.contactgrabber/lib/rediff/grabRediff.class.php	(original)
+++ trunk/midcom/com.magnettechnologies.contactgrabber/lib/rediff/grabRediff.class.php	Tue Jan  8 23:44:22 2008
@@ -21,7 +21,7 @@
   * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-  **/
+  */
 
 
 class rediff

Modified: trunk/midcom/com.magnettechnologies.contactgrabber/lib/yahoo/class.GrabYahoo.php
==============================================================================
--- trunk/midcom/com.magnettechnologies.contactgrabber/lib/yahoo/class.GrabYahoo.php	(original)
+++ trunk/midcom/com.magnettechnologies.contactgrabber/lib/yahoo/class.GrabYahoo.php	Tue Jan  8 23:44:22 2008
@@ -21,7 +21,7 @@
     * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-    **/
+    */
 
 
 /**

Modified: trunk/midcom/com.magnettechnologies.contactgrabber/lib/yahoo/config.php
==============================================================================
--- trunk/midcom/com.magnettechnologies.contactgrabber/lib/yahoo/config.php	(original)
+++ trunk/midcom/com.magnettechnologies.contactgrabber/lib/yahoo/config.php	Tue Jan  8 23:44:22 2008
@@ -21,7 +21,7 @@
   * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-  **/
+  */
 
 // Write full path to this istallation directory
 // example: '/home/user/public_html/contacts' (linux)

Modified: trunk/midcom/de.bitfolge.feedcreator/feedcreator.php
==============================================================================
--- trunk/midcom/de.bitfolge.feedcreator/feedcreator.php	(original)
+++ trunk/midcom/de.bitfolge.feedcreator/feedcreator.php	Tue Jan  8 23:44:22 2008
@@ -180,7 +180,7 @@
 
 /**
  * Version string.
- **/
+ */
 define("FEEDCREATOR_VERSION", "FeedCreator 1.7.6(BH)");
 
 
@@ -527,9 +527,9 @@
 	var $syndicationURL, $image, $language, $copyright, $pubDate, $lastBuildDate, $editor, $editorEmail, $webmaster, $category, $docs, $ttl, $rating, $skipHours, $skipDays;
 
 	/**
-	* The url of the external xsl stylesheet used to format the naked rss feed.
-	* Ignored in the output when empty.
-	*/
+	 * The url of the external xsl stylesheet used to format the naked rss feed.
+	 * Ignored in the output when empty.
+	 */
 	var $xslStyleSheet = "";
 
 
@@ -538,7 +538,7 @@
 	 */
 	var $items = Array();
 
-	/*
+	/**
 	 * Generator string
 	 *
 	 */
@@ -556,7 +556,7 @@
 	/**
 	 * This feed's character encoding.
 	 * @since 1.6.1
-	 **/
+	 */
 	var $encoding = "UTF-8"; //"ISO-8859-1";
 
 
@@ -585,7 +585,7 @@
 	 *
 	 *
 	 *
-	 **/
+	 */
 	 function version() {
 
 	 	return FEEDCREATOR_VERSION." (".$this->generator.")";

Modified: trunk/midcom/midcom.admin.styleeditor/admin.php
==============================================================================
--- trunk/midcom/midcom.admin.styleeditor/admin.php	(original)
+++ trunk/midcom/midcom.admin.styleeditor/admin.php	Tue Jan  8 23:44:22 2008
@@ -13,12 +13,17 @@
 
     var $msg;
 
-	/* the current topic we are in
+	/**
+	 * the current topic we are in
+	 * 
 	 * @var current_topic
 	 * @access public
-	 **/
+	 */
 	var $_current_topic = 0;
-    /* pointer to midcom_session_object */
+	
+    /**
+     * pointer to midcom_session_object 
+     */
     var $_session = null;
 
     /**

Modified: trunk/midcom/midcom.core/documentation/INSTALL
==============================================================================
--- trunk/midcom/midcom.core/documentation/INSTALL	(original)
+++ trunk/midcom/midcom.core/documentation/INSTALL	Tue Jan  8 23:44:22 2008
@@ -12,13 +12,13 @@
 MidCOM 2.6 requires at least Midgard 1.7, as the new MgdSchema core is 
 now integrated into the MidCOM core. There are no known 
 problems with mod_midgard_preparser or the Apache 2 mod_midgard, but it
-has not been throughoutly tested.
+has not been thoroughly tested.
 
 PHP 5.1.x is required at least, 5.2 or newer is strongly recommended. You
 need the following PHP modules available:
 
 * iconv for character translation in the I18n subsystem
-* dba for flat file database support, one of the Berkly DB Handlers
+* dba for flat file database support, one of the Berkeley DB Handlers
   is strongly recommended here, they are the only ones tested (db2, db3 or db4)
 * The Multibyte String extensions are required.
 * The build-in EXIF functions are strongly recommended if you plan to use

Modified: trunk/midcom/midcom.core/midcom/application.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/application.php	(original)
+++ trunk/midcom/midcom.core/midcom/application.php	Tue Jan  8 23:44:22 2008
@@ -2519,7 +2519,7 @@
      * Returns basically the object returned by mgd_get_midgard(), but the the variable
      * "self" is fixed by appending the MidCOM site prefix.
      *
-     * @returns MidgardObject    Midgard status information.
+     * @return MidgardObject    Midgard status information.
      */
     function get_midgard()
     {

Modified: trunk/midcom/midcom.core/midcom/baseclasses/components/interface.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/baseclasses/components/interface.php	(original)
+++ trunk/midcom/midcom.core/midcom/baseclasses/components/interface.php	Tue Jan  8 23:44:22 2008
@@ -65,7 +65,7 @@
  *
  * The most important change is that all four original component interface concepts
  * have been unified into a single class supporting the full interface. Obviously,
- * MidCOMs component loader had to be adapted to this operation.
+ * MidCOM's component loader had to be adapted to this operation.
  *
  * At this time, the core will not be able to handle the original pre-2.4 interface
  * any longer. Though it would be possible to implement an according proxy class, I
@@ -107,7 +107,7 @@
  * The average component will require something like this, part one is the component
  * Manifest:
  *
- * <pre>
+ * <code>
  * 'name' => 'net.nehmer.static',
  * 'purecode' => false,
  * 'version' => 1,
@@ -117,7 +117,7 @@
  *     'write' => Array (MIDCOM_PRIVILEGE_DENY, MIDCOM_PRIVILEGE_ALLOW)
  * ),
  * 'class_definitions' => Array('my_sepcial_mgd_schema_class.inc'),
- * </pre>
+ * </code>
  *
  * See the class midcom_core_manifest for further details.
  *
@@ -864,7 +864,7 @@
     // ===================== START OF THE EVENT HANDLERS =====================
 
     /**#@+
-     * This is an event handler which is called during MidCOMs component interaction.
+     * This is an event handler which is called during MidCOM's component interaction.
      * For most basic components, the default implementation should actually be enough.
      *
      * @access protected

Modified: trunk/midcom/midcom.core/midcom/baseclasses/components/request_admin.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/baseclasses/components/request_admin.php	(original)
+++ trunk/midcom/midcom.core/midcom/baseclasses/components/request_admin.php	Tue Jan  8 23:44:22 2008
@@ -1,5 +1,4 @@
 <?php
-
 /**
  * @package midcom.baseclasses
  * @author The Midgard Project, http://www.midgard-project.org
@@ -41,7 +40,6 @@
  * Full configuration example:
  *
  * <code>
- * <?php
  *  $this->_request_switch[] = Array
  *  (
  *  	'handler' => 'config_dm',
@@ -50,7 +48,6 @@
  *      'schema' => 'config',
  *      'disable_return_to_topic' => false
  *  );
- * ?>
  * </code>
  *
  *
@@ -117,7 +114,7 @@
 
         if (! $this->_request_switch)
         {
-            // Generic and personal welcom pages
+            // Generic and personal welcome pages
             $this->_request_switch['welcome'] = Array
             (
                 'handler' => 'welcome_deprecated',

Modified: trunk/midcom/midcom.core/midcom/baseclasses/core/dbobject.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/baseclasses/core/dbobject.php	(original)
+++ trunk/midcom/midcom.core/midcom/baseclasses/core/dbobject.php	Tue Jan  8 23:44:22 2008
@@ -30,6 +30,7 @@
  * Parameters natively.
  *
  * @package midcom.baseclasses
+ * @static
  */
 class midcom_baseclasses_core_dbobject
 {
@@ -37,7 +38,10 @@
      * "Pre-flight" checks for update method
      *
      * Separated so that dbfactory->import() can reuse the code
-     **/
+     * 
+     * @param MidgardObject $object A class inherited from one of the MgdSchema driven Midgard classes supporting the above callbacks.
+     * @return bool Indicating success.
+     */
     function update_pre_checks(&$object)
     {
         debug_push_class($object, __FUNCTION__);
@@ -102,7 +106,9 @@
      * Post object creation operations for create
      *
      * Separated so that dbfactory->import() can reuse the code
-     **/
+     * 
+     * @param MidgardObject $object A class inherited from one of the MgdSchema driven Midgard classes supporting the above callbacks.
+     */
     function update_post_ops(&$object)
     {
         debug_push_class($object, __FUNCTION__);
@@ -272,7 +278,9 @@
      * "Pre-flight" checks for create method
      *
      * Separated so that dbfactory->import() can reuse the code
-     **/
+     * 
+     * @param MidgardObject $object A class inherited from one of the MgdSchema driven Midgard classes supporting the above callbacks.
+     */
     function create_pre_checks(&$object)
     {
         debug_push_class($object, __FUNCTION__);
@@ -360,7 +368,9 @@
      * Post object creation operations for create
      *
      * Separated so that dbfactory->import() can reuse the code
-     **/
+     * 
+     * @param MidgardObject $object A class inherited from one of the MgdSchema driven Midgard classes supporting the above callbacks.
+     */
     function create_post_ops(&$object)
     {
         debug_push_class($object, __FUNCTION__);
@@ -427,7 +437,9 @@
      * "Pre-flight" checks for delete method
      *
      * Separated so that dbfactory->import() can reuse the code
-     **/
+     * 
+     * @param MidgardObject $object A class inherited from one of the MgdSchema driven Midgard classes supporting the above callbacks.
+     */
     function delete_pre_checks(&$object)
     {
         debug_push_class($object, __FUNCTION__);
@@ -527,7 +539,9 @@
      * Post object creation operations for delete
      *
      * Separated so that dbfactory->import() can reuse the code
-     **/
+     * 
+     * @param MidgardObject $object A class inherited from one of the MgdSchema driven Midgard classes supporting the above callbacks.
+     */
     function delete_post_ops(&$object)
     {
         debug_push_class($object, __FUNCTION__);
@@ -906,6 +920,8 @@
     
     /**
      * Generates URL-safe name for an object and stores it if needed
+     * 
+     * @param MidgardObject $object A class inherited from one of the MgdSchema driven Midgard classes supporting the above callbacks.
      */
     function generate_urlname($object, $titlefield = 'title')
     {

Modified: trunk/midcom/midcom.core/midcom/core/group.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/core/group.php	(original)
+++ trunk/midcom/midcom.core/midcom/core/group.php	Tue Jan  8 23:44:22 2008
@@ -145,6 +145,7 @@
      *
      * @param midcom_core_user $user The user that should be looked-up.
      * @return Array An array of member groups or false on failure.
+     * @static
      */
     function list_memberships($user)
     {

Modified: trunk/midcom/midcom.core/midcom/core/group_midgard.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/core/group_midgard.php	(original)
+++ trunk/midcom/midcom.core/midcom/core/group_midgard.php	Tue Jan  8 23:44:22 2008
@@ -193,6 +193,7 @@
      *
      * @param midcom_core_user $user The user that should be looked-up.
      * @return Array An array of member groups or false on failure, indexed by their ID.
+     * @static
      */
     function list_memberships($user)
     {

Modified: trunk/midcom/midcom.core/midcom/core/group_virtual.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/core/group_virtual.php	(original)
+++ trunk/midcom/midcom.core/midcom/core/group_virtual.php	Tue Jan  8 23:44:22 2008
@@ -22,7 +22,6 @@
  *
  * @package midcom
  */
-
 class midcom_core_group_virtual extends midcom_core_group
 {
     /**
@@ -160,6 +159,7 @@
      *
      * @param midcom_core_user $user The user that should be looked-up.
      * @return Array An array of member groups or false on failure, indexed by their id..
+     * @static
      */
     function list_memberships($user)
     {

Modified: trunk/midcom/midcom.core/midcom/core/privilege.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/core/privilege.php	(original)
+++ trunk/midcom/midcom.core/midcom/core/privilege.php	Tue Jan  8 23:44:22 2008
@@ -363,6 +363,7 @@
      * @access protected
      * @param object $the_object A reference to the object or GUID to query.
      * @return Array A list of midcom_core_privilege instances.
+     * @static
      */
     function get_content_privileges($guid)
     {
@@ -390,6 +391,7 @@
      * @access protected
      * @param object $the_object A reference to the object or GUID to query.
      * @return Array A list of midcom_core_privilege instances.
+     * @static
      */
     function get_self_privileges($guid)
     {
@@ -417,6 +419,7 @@
      * @access protected
      * @param string GUID the GUID of the object for which we should look up privileges.
      * @return Array A list of midcom_core_privilege instances.
+     * @static
      */
     function get_all_privileges($guid)
     {
@@ -450,6 +453,7 @@
      * @access protected
      * @param string $guid The GUID of the object for which to query ACL data.
      * @return Array A list of midcom_core_privilege instances.
+     * @static
      */
     function _query_all_privileges($guid)
     {
@@ -518,6 +522,7 @@
      * @param string $assignee The identifier of the assignee to query.
      * @param string $classname The optional classname required only for class-limited SELF privileges.
      * @return midcom_core_privilege The privilege matching the constraints.
+     * @static
      */
     function get_privilege(&$object, $name, $assignee, $classname = '')
     {
@@ -598,6 +603,7 @@
      * @param mixed $object A reference to the GUID or the full object instance for which we should load privileges.
      * @param midcom_core_user The MidCOM user for which we should collect the privileges, null uses the currently authenticated user.
      * @return Array An array of privilege_name => privilege_value pairs valid for the given user.
+     * @static
      */
     function collect_content_privileges(&$arg, $user = null)
     {

Modified: trunk/midcom/midcom.core/midcom/core/querybuilder.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/core/querybuilder.php	(original)
+++ trunk/midcom/midcom.core/midcom/core/querybuilder.php	Tue Jan  8 23:44:22 2008
@@ -46,9 +46,9 @@
         $this->new_key .= "{$key}_$val";
     }
 
-    /*
+    /**
      * Makes sure that all calls are catched.
-     * */
+     */
     function __call($name, $args)
     {
         if ($this->qb == NULL)

Modified: trunk/midcom/midcom.core/midcom/db/article.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/db/article.php	(original)
+++ trunk/midcom/midcom.core/midcom/db/article.php	Tue Jan  8 23:44:22 2008
@@ -42,6 +42,8 @@
      * We need a better solution here in DBA core actually, but it will be difficult to
      * do this as we cannot determine the current class in a polymorphic environment without
      * having a this (this call is static).
+     * 
+     * @static
      */
     function new_query_builder()
     {

Modified: trunk/midcom/midcom.core/midcom/db/element.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/db/element.php	(original)
+++ trunk/midcom/midcom.core/midcom/db/element.php	Tue Jan  8 23:44:22 2008
@@ -42,6 +42,8 @@
      * We need a better solution here in DBA core actually, but it will be difficult to
      * do this as we cannot determine the current class in a polymorphic environment without
      * having a this (this call is static).
+     * 
+     * @static
      */
     function new_query_builder()
     {

Modified: trunk/midcom/midcom.core/midcom/db/event.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/db/event.php	(original)
+++ trunk/midcom/midcom.core/midcom/db/event.php	Tue Jan  8 23:44:22 2008
@@ -41,6 +41,8 @@
      * We need a better solution here in DBA core actually, but it will be difficult to
      * do this as we cannot determine the current class in a polymorphic environment without
      * having a this (this call is static).
+     * 
+     * @static
      */
     function new_query_builder()
     {

Modified: trunk/midcom/midcom.core/midcom/db/eventmember.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/db/eventmember.php	(original)
+++ trunk/midcom/midcom.core/midcom/db/eventmember.php	Tue Jan  8 23:44:22 2008
@@ -42,6 +42,8 @@
      * We need a better solution here in DBA core actually, but it will be difficult to
      * do this as we cannot determine the current class in a polymorphic environment without
      * having a this (this call is static).
+     * 
+     * @static
      */
     function new_query_builder()
     {

Modified: trunk/midcom/midcom.core/midcom/db/group.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/db/group.php	(original)
+++ trunk/midcom/midcom.core/midcom/db/group.php	Tue Jan  8 23:44:22 2008
@@ -42,6 +42,8 @@
      * We need a better solution here in DBA core actually, but it will be difficult to
      * do this as we cannot determine the current class in a polymorphic environment without
      * having a this (this call is static).
+     * 
+     * @static
      */
     function new_query_builder()
     {
@@ -50,7 +52,7 @@
 
     /**
      * Helper function, adds the given person to this group. The current user must have
-     * midgard:create privileges on this objectg for this to succeed. If the person is
+     * midgard:create privileges on this object for this to succeed. If the person is
      * already a member of this group, nothing is done.
      *
      * @param midcom_baseclasses_database_person The person to add.

Modified: trunk/midcom/midcom.core/midcom/db/host.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/db/host.php	(original)
+++ trunk/midcom/midcom.core/midcom/db/host.php	Tue Jan  8 23:44:22 2008
@@ -42,6 +42,8 @@
      * We need a better solution here in DBA core actually, but it will be difficult to
      * do this as we cannot determine the current class in a polymorphic environment without
      * having a this (this call is static).
+     * 
+     * @static
      */
     function new_query_builder()
     {

Modified: trunk/midcom/midcom.core/midcom/db/member.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/db/member.php	(original)
+++ trunk/midcom/midcom.core/midcom/db/member.php	Tue Jan  8 23:44:22 2008
@@ -42,6 +42,8 @@
      * We need a better solution here in DBA core actually, but it will be difficult to
      * do this as we cannot determine the current class in a polymorphic environment without
      * having a this (this call is static).
+     * 
+     * @static
      */
     function new_query_builder()
     {

Modified: trunk/midcom/midcom.core/midcom/db/page.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/db/page.php	(original)
+++ trunk/midcom/midcom.core/midcom/db/page.php	Tue Jan  8 23:44:22 2008
@@ -42,6 +42,8 @@
      * We need a better solution here in DBA core actually, but it will be difficult to
      * do this as we cannot determine the current class in a polymorphic environment without
      * having a this (this call is static).
+     * 
+     * @static
      */
     function new_query_builder()
     {

Modified: trunk/midcom/midcom.core/midcom/db/pageelement.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/db/pageelement.php	(original)
+++ trunk/midcom/midcom.core/midcom/db/pageelement.php	Tue Jan  8 23:44:22 2008
@@ -42,6 +42,8 @@
      * We need a better solution here in DBA core actually, but it will be difficult to
      * do this as we cannot determine the current class in a polymorphic environment without
      * having a this (this call is static).
+     * 
+     * @static
      */
     function new_query_builder()
     {

Modified: trunk/midcom/midcom.core/midcom/db/person.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/db/person.php	(original)
+++ trunk/midcom/midcom.core/midcom/db/person.php	Tue Jan  8 23:44:22 2008
@@ -42,6 +42,8 @@
      * We need a better solution here in DBA core actually, but it will be difficult to
      * do this as we cannot determine the current class in a polymorphic environment without
      * having a this (this call is static).
+     * 
+     * @static
      */
     function new_query_builder()
     {
@@ -49,7 +51,7 @@
     }
 
     /**
-     * Adds a user to a given Midgard Group. Calle must ensure access permissions
+     * Adds a user to a given Midgard Group. Caller must ensure access permissions
      * are right.
      *
      * @param string $name The name of the group we should be added to.

Modified: trunk/midcom/midcom.core/midcom/db/style.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/db/style.php	(original)
+++ trunk/midcom/midcom.core/midcom/db/style.php	Tue Jan  8 23:44:22 2008
@@ -42,6 +42,8 @@
      * We need a better solution here in DBA core actually, but it will be difficult to
      * do this as we cannot determine the current class in a polymorphic environment without
      * having a this (this call is static).
+     * 
+     * @static
      */
     function new_query_builder()
     {

Modified: trunk/midcom/midcom.core/midcom/db/topic.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/db/topic.php	(original)
+++ trunk/midcom/midcom.core/midcom/db/topic.php	Tue Jan  8 23:44:22 2008
@@ -42,6 +42,8 @@
      * We need a better solution here in DBA core actually, but it will be difficult to
      * do this as we cannot determine the current class in a polymorphic environment without
      * having a this (this call is static).
+     * 
+     * @static
      */
     function new_query_builder()
     {

Modified: trunk/midcom/midcom.core/midcom/exec/convert_legacy_metadata.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/exec/convert_legacy_metadata.php	(original)
+++ trunk/midcom/midcom.core/midcom/exec/convert_legacy_metadata.php	Tue Jan  8 23:44:22 2008
@@ -96,9 +96,9 @@
     }
 }
 
-/*
-* @ignore
-*/
+/**
+ * @ignore
+ */
 function hide_unapproved_photos($topic)
 {
     // TODO: this supports only local gallery config, not the one in sitegroup-config
@@ -117,8 +117,8 @@
 }
 
 /**
-* @ignore
-*/
+ * @ignore
+ */
 function convert_aegir($node_id)
 {
     $nap = new midcom_helper_nav();

Modified: trunk/midcom/midcom.core/midcom/helper/_basicnav.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/helper/_basicnav.php	(original)
+++ trunk/midcom/midcom.core/midcom/helper/_basicnav.php	Tue Jan  8 23:44:22 2008
@@ -956,7 +956,7 @@
 
     /**
      * This function is the controlling instance of the loading mechanism. It
-     * is able to load the navigation data of any topic within MidCOMs topic
+     * is able to load the navigation data of any topic within MidCOM's topic
      * tree into memory. Any uplink nodes that are not loaded into memory will
      * be loaded until any other known topic is encountered. After the
      * necessary data has been loaded with calls to _loadNodeData.
@@ -966,7 +966,7 @@
      * in $midcom_errstr.
      *
      * @param int $node_id	The ID of the topic to be loaded
-     * @return int			MIDCOM_ERROK on succes, one of the MIDCOM_ERR... constants upon an error
+     * @return int			MIDCOM_ERROK on success, one of the MIDCOM_ERR... constants upon an error
      * @access private
      */
     function _loadNode($node_id)

Modified: trunk/midcom/midcom.core/midcom/helper/_dbfactory.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/helper/_dbfactory.php	(original)
+++ trunk/midcom/midcom.core/midcom/helper/_dbfactory.php	Tue Jan  8 23:44:22 2008
@@ -114,7 +114,8 @@
      * @param string $domain The domain property of the collector instance
      * @param mixed $value Value match for the collector instance
      * @return midcom_core_collector The initialized instance of the collector.
-     * @see midcom_core_querybuilder
+     * @see midcom_core_collector
+     * @static
      */
     function new_collector($classname, $domain, $value)
     {
@@ -133,6 +134,7 @@
      * @param string $classname The name of the class for which you want to create a query builder.
      * @return midcom_core_querybuilder The initialized instance of the query builder.
      * @see midcom_core_querybuilder
+     * @static
      */
     function new_query_builder($classname)
     {

Modified: trunk/midcom/midcom.core/midcom/helper/_styleloader.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/helper/_styleloader.php	(original)
+++ trunk/midcom/midcom.core/midcom/helper/_styleloader.php	Tue Jan  8 23:44:22 2008
@@ -661,7 +661,7 @@
      * component.
      *
      * @param MidgardTopic $topic the current componenttopic.
-     * @returns mixed the path to the components styledirectory.
+     * @return mixed the path to the components styledirectory.
      */
     function _getComponentSnippetdir($topic)
     {

Modified: trunk/midcom/midcom.core/midcom/helper/formatters.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/helper/formatters.php	(original)
+++ trunk/midcom/midcom.core/midcom/helper/formatters.php	Tue Jan  8 23:44:22 2008
@@ -355,7 +355,7 @@
 
 /**
  * Chained
-**/
+*/
 
 function midcom_helper_formatters_links_and_obfmaillinks($content)
 {
@@ -399,7 +399,7 @@
 
 /**
  * Helpers
-**/
+ */
 
 function _midcom_helper_formatters_register_filter($name, $method=null)
 {

Modified: trunk/midcom/midcom.core/midcom/helper/imagefilter.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/helper/imagefilter.php	(original)
+++ trunk/midcom/midcom.core/midcom/helper/imagefilter.php	Tue Jan  8 23:44:22 2008
@@ -118,7 +118,7 @@
      * @todo Use ImageMagick Identify to check for a valid image.
      *
      * @param string filename The file to be edited.
-     * @returns true, if the file is valid, false otherwise.
+     * @return boolean true, if the file is valid, false otherwise.
      */
     function set_file($filename)
     {
@@ -149,7 +149,7 @@
      * Processing stops as soon as one filter command fails.
      *
      * @param string chain The filter chain to be processed (filter1();filter2();...)
-     * @returns true, if all filters have been successfully applied, false otherwise.
+     * @return boolean true, if all filters have been successfully applied, false otherwise.
      */
     function process_chain($chain)
     {
@@ -189,7 +189,7 @@
      * result in a NULL operation) and will ignore excessive arguments.
      *
      * @param string cmd The command to be executed.
-     * @returns true, if the filter executed successfully, false otherwise.
+     * @return boolean true, if the filter executed successfully, false otherwise.
      */
     function process_command($cmd)
     {
@@ -322,7 +322,7 @@
      *
      * @param string $command  The name of the callback to execute
      * @param array $args      The arguments passed to the callback
-     * @returns The return code of the callback.
+     * @return The return code of the callback.
      */
     function execute_user_callback($command, $args) {
         if (! function_exists($command))
@@ -352,7 +352,7 @@
      * Where $gamma is a positive floating point number, e.g. 1.2
      *
      * @param $gamma Gamma adjustment value.
-     * @returns true on success.
+     * @return boolean true on success.
      */
     function gamma($gamma)
     {
@@ -458,7 +458,7 @@
      *
      * Filter Syntax: exifrotate()
      *
-     * @returns true on success.
+     * @return boolean true on success.
      */
     function exifrotate()
     {
@@ -575,7 +575,7 @@
      * and less then 360; if omitted, a NULL operation is done.
      *
      * @param $rotate Degrees of rotation clockwise, negative amounts possible
-     * @returns true on success.
+     * @return boolean true on success.
      */
     function rotate($rotate)
     {
@@ -651,11 +651,11 @@
      * value.
      *
      * The resize will be done only if it would not increase the image
-     * as this won't gain you any benifit.
+     * as this won't gain you any benefit.
      *
      * @param int $x Width
      * @param int $y Height
-     * @returns true on success.
+     * @return boolean true on success.
      */
     function rescale($x, $y)
     {

Modified: trunk/midcom/midcom.core/midcom/helper/itemlist.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/helper/itemlist.php	(original)
+++ trunk/midcom/midcom.core/midcom/helper/itemlist.php	Tue Jan  8 23:44:22 2008
@@ -76,12 +76,13 @@
     }
 
     
-   /* get style. If the elements should use a special style, return that here. 
+   /**
+    * get style. If the elements should use a special style, return that here. 
     * if not. use default.
     * 
     * 
     * @return string Midcom stylename.
-    * */
+    */
     
     /** @ignore */
     function get_style()
@@ -89,7 +90,8 @@
         return false;
     }
     
-    /* factory generate the object you want to use for getting a list of items for a certain topic.
+    /**
+     * factory generate the object you want to use for getting a list of items for a certain topic.
      * Use this function to create sorted lists. Example:
      *     require_once 'itemlist.php';
      *     $nav_object = midcom_helper_itemlist::factory( $navorder, &$this, $parent_topic);
@@ -133,11 +135,12 @@
         return $sortclass;
     } 
 
-   /* get_config_parameters - get a list of which configuration parameters 
+   /**
+    * get_config_parameters - get a list of which configuration parameters 
     * may be set for this object.
-    * @param none
+    *
     * @return array to be added to the configuration object.
-    * */
+    */
     /** @ignore */
     function get_config_parameters () 
     {

Modified: trunk/midcom/midcom.core/midcom/helper/misc.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/helper/misc.php	(original)
+++ trunk/midcom/midcom.core/midcom/helper/misc.php	Tue Jan  8 23:44:22 2008
@@ -463,7 +463,7 @@
  * @param MidgardObject $object	The object at which to save the data.
  * @param mixed $var			The variable that should be saved.
  * @param string $name			The identifier to use for storage.
- * @return bool	Indicating succes.
+ * @return bool	Indicating success.
  */
 function mgd_save_var_as_attachment($object, &$var, $name) {
     $att = $object->getattachment($name);
@@ -871,7 +871,7 @@
  * @author       Aidan Lister <aidan at php.net>
  * @param        string     $file       Name of the file to look for
  * @return       bool       TRUE if the file exists, FALSE if it does not
- **/
+ */
 function midcom_file_exists_incpath ($file)
 {
     $paths = explode(PATH_SEPARATOR, get_include_path());

Modified: trunk/midcom/midcom.core/midcom/request.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/request.php	(original)
+++ trunk/midcom/midcom.core/midcom/request.php	Tue Jan  8 23:44:22 2008
@@ -9,8 +9,11 @@
 /**
  * This class wraps the _POST and _REQUEST and argv arrays and should be used
  * to fetch variables.
+ * 
+ * @package midcom
  */
-class midcom_request {
+class midcom_request 
+{
     protected $vars = array();
     public function __construct($request_array = array(), $argv = array()) {
         $this->vars = $request_array;
@@ -43,7 +46,7 @@
      *  Get a trimmed version of a variable.
      *  @return mixed the request variable, but trimmed.
      *  @param $name the variable name
-     *  @param $deafult what to return if the variable does not exist.
+     *  @param $default what to return if the variable does not exist.
      */
     public function getTrim($name, $default = "")
     {
@@ -57,20 +60,20 @@
  */
 class midcom_url_notfound_exception extends Exception {    }
 
-/*
+/**
  * this class is responsible for building the urlparser filters that will handle the
  * different parts of the parsing process.
  *
  *
- * */
+ */
 class midcom_urlparserfactory {
 
-    /*
+    /**
      * Builds the list of filters that should be applied. Note that the filters are
      * applied in sequence and that the next filter will get information from the one
      * before.
      *
-     * */
+     */
     function __construct($config) {
         $this->config = $config;
     }
@@ -81,7 +84,7 @@
      * While most frameworks these days link parts of the urls directly to the
      * command name, we let the midcom be linked to the database instead. This makes
      * it easier for others to build the site without worrying about how to configure the command
-     * interprenter.
+     * interpreter.
      * @return midcom_url_paramcollector
      */
     function execute ($argv) {
@@ -130,7 +133,8 @@
      * The style to use for this request.
      */
     private $style = null;
-    /*
+    
+    /**
      * If the style may be overridden. gets set to true if
      * we got midcom-substyle...
      * Public as I didn't want to implement getters and setters.
@@ -197,8 +201,8 @@
     /**
      * Getter for config options
      * @param $name name of option
-     * @deafult default value of option,
-     **/
+     * @param $default default value of option,
+     */
     public function get_config($name, $default = false)
     {
         return (isset($this->config[$name])) ? $this->config[$name] : $default;

Modified: trunk/midcom/midcom.core/midcom/services/indexer/backend/solr.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/services/indexer/backend/solr.php	(original)
+++ trunk/midcom/midcom.core/midcom/services/indexer/backend/solr.php	Tue Jan  8 23:44:22 2008
@@ -190,9 +190,9 @@
 
 class midcom_services_indexer_solrDocumentFactory {
 
-    /*
+    /**
      * The xml document to post.
-     * */
+     */
     var $document = null;
 
     public function __construct()
@@ -230,6 +230,7 @@
         }
 
     }
+    
     /**
      * Deletes one element
      * @param $id the element id
@@ -284,9 +285,9 @@
 
 class midcom_services_indexer_solrRequest {
 
-    /*
+    /**
      * the HTTP_Request object
-     * */
+     */
     var $request = null;
 
     /**
@@ -302,9 +303,10 @@
         return $this->do_post($this->factory->to_xml());
 
     }
-    /*
+    
+    /**
      * posts the xml to the suggested url using HTTP_Request.
-     * */
+     */
     function do_post($xml)
     {
         debug_push_class(__CLASS__, __FUNCTION__);

Modified: trunk/midcom/midcom.core/midcom/services/metadata.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/services/metadata.php	(original)
+++ trunk/midcom/midcom.core/midcom/services/metadata.php	Tue Jan  8 23:44:22 2008
@@ -180,7 +180,7 @@
         $this->bind_metadata_to_object(MIDCOM_METADATA_VIEW, $object);
     }
     
-    /*
+    /**
      * Binds object to given metadata type.
      */
     function bind_metadata_to_object($metadata_type, &$object, $context_id = null)

Modified: trunk/midcom/midcom.core/midcom/services/rcs/backend/rcs.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/services/rcs/backend/rcs.php	(original)
+++ trunk/midcom/midcom.core/midcom/services/rcs/backend/rcs.php	Tue Jan  8 23:44:22 2008
@@ -286,7 +286,7 @@
 
     /**
      * This function returns a list of the revisions as a
-     * key => value par where the key is the index of thhe revision
+     * key => value par where the key is the index of the revision
      * and the value is the revision id.
      * Order: revision 0 is the newest.
      * @return array
@@ -306,7 +306,7 @@
     }
     /**
      * Lists the number of changes that has been done to the object
-     * @param none
+     * 
      * @return array list of changeids
      */
     function list_history()
@@ -673,7 +673,7 @@
 
                         if ($renderer_style == 'inline')
                         {
-                            // Mofify the output for nicer rendering
+                            // Modify the output for nicer rendering
                             $return[$attribute]['diff'] = str_replace('<del>', "<span class=\"deleted\" title=\"removed in {$latest_revision}\">", $return[$attribute]['diff']);
                             $return[$attribute]['diff'] = str_replace('</del>', '</span>', $return[$attribute]['diff']);
                             $return[$attribute]['diff'] = str_replace('<ins>', "<span class=\"inserted\" title=\"added in {$latest_revision}\">", $return[$attribute]['diff']);
@@ -683,7 +683,7 @@
                 }
                 elseif (!is_null($GLOBALS['midcom_config']['utility_diff']))
                 {
-                    /* this doesnt work */
+                    /* this doesn't work */
                     $command = $GLOBALS['midcom_config']['utility_diff'] . " -u <(echo \"{$oldest_value}\") <(echo \"{$newest[$attribute]}\")";
 
                     $output = array();

Modified: trunk/midcom/midcom.core/midcom/services/rcs/handler/rcs.php
==============================================================================
--- trunk/midcom/midcom.core/midcom/services/rcs/handler/rcs.php	(original)
+++ trunk/midcom/midcom.core/midcom/services/rcs/handler/rcs.php	Tue Jan  8 23:44:22 2008
@@ -113,7 +113,7 @@
                         $return[$attribute]['diff'] = $renderer->render($diff);
                     }
                 } elseif (!is_null($GLOBALS['midcom_config']['utility_diff'])){
-                    /* this doesnt work */
+                    /* this doesn't work */
                     $command = $GLOBALS['midcom_config']['utility_diff'] . " -u <(echo \"$oldest_value\") <(echo \"{$newest[$attribute]}\") ";
 
                     $output = array();
@@ -185,7 +185,7 @@
 
     /**
      * Lists the number of changes that has been done to the object
-     * @param none
+     * 
      * @return array list of changeids
      */
     function list_diffs()
@@ -233,7 +233,7 @@
 
    /**
      * Lists the number of changes that has been done to the object
-     * @param none
+     * 
      * @return array list of changeids or empty array if no changes.
      */
     function list_history()

Modified: trunk/midcom/midcom.helper.datamanager/datatype.php
==============================================================================
--- trunk/midcom/midcom.helper.datamanager/datatype.php	(original)
+++ trunk/midcom/midcom.helper.datamanager/datatype.php	Tue Jan  8 23:44:22 2008
@@ -361,7 +361,7 @@
     /**
      * Returns the empty value for the widget.
      *
-     * The calle will automatically revert to this if and only if no default
+     * The call will automatically revert to this if and only if no default
      * value has been specified in the schema.
      *
      * This member should be overwritten in subclasses that do not use a simple
@@ -399,7 +399,7 @@
      * It is up to the
      * datatypes what part of their internal representation they return here. It is
      * safe to return multiline-strings, quoting is handled by the datamanager here,
-     * sou you just return the unencoded data.
+     * so you just return the unencoded data.
      *
      * This member should be overwritten if no simple textual datatypes
      * are in use.

Modified: trunk/midcom/midcom.helper.datamanager/helpers_select_lists.php
==============================================================================
--- trunk/midcom/midcom.helper.datamanager/helpers_select_lists.php	(original)
+++ trunk/midcom/midcom.helper.datamanager/helpers_select_lists.php	Tue Jan  8 23:44:22 2008
@@ -80,7 +80,7 @@
 /**
  * Lists all groups recursively, using four spaces to indent subgroups.
  *
- * A no-selection element is added ontop of the list having an empty
+ * A no-selection element is added on top of the list having an empty
  * string as key.
  *
  * @return Array select datatype compatible group listing, indexed by guid.
@@ -153,7 +153,7 @@
 }
 
 /* TN: Where does this $id come from? disabling the function it seems broken. Please document
- * throughoutly!
+ * thoroughly!
 function midcom_helper_datamanager_get_next_score ()
 {
     $topics = mgd_list_topics($id, 'score');

Modified: trunk/midcom/midcom.helper.datamanager/widget_checkbox.php
==============================================================================
--- trunk/midcom/midcom.helper.datamanager/widget_checkbox.php	(original)
+++ trunk/midcom/midcom.helper.datamanager/widget_checkbox.php	Tue Jan  8 23:44:22 2008
@@ -40,14 +40,14 @@
      * check if the text should be shown before or after the checkbox.
      * @access private
      * @var boolean
-     **/
+     */
     var $_textafter = true;
 
     /**
      * check if the HTML should be allowed in a description
      * @access private
      * @var boolean
-     **/
+     */
     var $_allow_html = false;
 
     function _constructor (&$datamanager, $field, $defaultvalue)

Modified: trunk/midcom/midcom.helper.datamanager2/controller.php
==============================================================================
--- trunk/midcom/midcom.helper.datamanager2/controller.php	(original)
+++ trunk/midcom/midcom.helper.datamanager2/controller.php	Tue Jan  8 23:44:22 2008
@@ -205,6 +205,7 @@
      *
      * @param string $type The type of the controller (the file name from the controller directory).
      * @return midcom_helper_datamanager2_controller A reference to the newly created controller instance.
+     * @static
      */
     function & create($type)
     {

Modified: trunk/midcom/midcom.helper.datamanager2/type/blobs.php
==============================================================================
--- trunk/midcom/midcom.helper.datamanager2/type/blobs.php	(original)
+++ trunk/midcom/midcom.helper.datamanager2/type/blobs.php	Tue Jan  8 23:44:22 2008
@@ -11,7 +11,7 @@
  * Datamanager 2 Blob management type.
  *
  * This type allows you to control an arbitrary number of attachments on a given object.
- * It can only operate if the storage implementaion provides it with a Midgard Object.
+ * It can only operate if the storage implementation provides it with a Midgard Object.
  * The storage location provided by the schema is unused at this time, as attachment
  * operations cannot be undone. Instead, the direct parameter calls are used to manage
  * the list of attachments in a parameter associated to the domain of the type. The

Modified: trunk/midcom/midcom.helper.filesync/exporter.php
==============================================================================
--- trunk/midcom/midcom.helper.filesync/exporter.php	(original)
+++ trunk/midcom/midcom.helper.filesync/exporter.php	Tue Jan  8 23:44:22 2008
@@ -34,6 +34,7 @@
      *
      * @param string $type type
      * @return midcom_helper_filesync_exporter A reference to the newly created exporter instance.
+     * @static
      */
     function & create($type)
     {

Modified: trunk/midcom/midcom.helper.filesync/importer.php
==============================================================================
--- trunk/midcom/midcom.helper.filesync/importer.php	(original)
+++ trunk/midcom/midcom.helper.filesync/importer.php	Tue Jan  8 23:44:22 2008
@@ -35,6 +35,7 @@
      *
      * @param string $type type
      * @return midcom_helper_filesync_importer A reference to the newly created importer instance.
+     * @static
      */
     function & create($type)
     {

Modified: trunk/midcom/midcom.helper.replicator/exporter.php
==============================================================================
--- trunk/midcom/midcom.helper.replicator/exporter.php	(original)
+++ trunk/midcom/midcom.helper.replicator/exporter.php	Tue Jan  8 23:44:22 2008
@@ -51,6 +51,7 @@
      *
      * @param midcom_helper_replication_subscription_dba $subscription Subscription
      * @return midcom_helper_replicator_exporter A reference to the newly created exporter instance.
+     * @static
      */
     function &create($subscription)
     {

Modified: trunk/midcom/midcom.helper.replicator/importer.php
==============================================================================
--- trunk/midcom/midcom.helper.replicator/importer.php	(original)
+++ trunk/midcom/midcom.helper.replicator/importer.php	Tue Jan  8 23:44:22 2008
@@ -46,6 +46,7 @@
      *
      * @param string $type Type of the importer
      * @return midcom_helper_replicator_importer A reference to the newly created importer instance.
+     * @static
      */
     function & create($type)
     {
@@ -153,7 +154,7 @@
      * @param string $object Importable Midgard object
      * @param boolean $use_force Whether to force importing
      * @return boolean Whether importing was successful
-     **/
+     */
     function import_object(&$object, $use_force)
     {
         $GLOBALS['midcom_helper_replicator_logger']->push_prefix(__CLASS__ . '::' . __FUNCTION__);

Modified: trunk/midcom/midcom.helper.replicator/queuemanager.php
==============================================================================
--- trunk/midcom/midcom.helper.replicator/queuemanager.php	(original)
+++ trunk/midcom/midcom.helper.replicator/queuemanager.php	Tue Jan  8 23:44:22 2008
@@ -34,7 +34,9 @@
 
     /**
      * The correct way to get a queue manager, call this statically, returns reference
-     **/
+     * 
+     * @static
+     */
     function &get()
     {
         if (!array_key_exists('midcom_helper_replicator_queuemanager_instance', $GLOBALS))
@@ -231,7 +233,7 @@
     /**
      * Gets/creates the path for subscriptions spool dir
      * @todo make a smarter recursive directory creator
-     **/
+     */
     function _get_subscription_basedir(&$subscription)
     {
         $global_base = $this->_config->get('queue_root_dir');

Modified: trunk/midcom/midcom.helper.replicator/transporter.php
==============================================================================
--- trunk/midcom/midcom.helper.replicator/transporter.php	(original)
+++ trunk/midcom/midcom.helper.replicator/transporter.php	Tue Jan  8 23:44:22 2008
@@ -53,6 +53,7 @@
      *
      * @param midcom_helper_replication_subscription_dba $subscription Subscription
      * @return midcom_helper_replicator_transporter A reference to the newly created transporter instance.
+     * @static
      */
     function & create($subscription)
     {
@@ -105,7 +106,7 @@
      *
      * @todo How to let transport specify retry interval
      *
-     **/
+     */
     function process(&$items)
     {
         // Subclasses must override this method

Modified: trunk/midcom/midcom.helper.replicator/transporter/archive.php
==============================================================================
--- trunk/midcom/midcom.helper.replicator/transporter/archive.php	(original)
+++ trunk/midcom/midcom.helper.replicator/transporter/archive.php	Tue Jan  8 23:44:22 2008
@@ -38,7 +38,7 @@
      * Reads transport configuration from subscriptions parameters
      *
      * Also does some sanity checking
-     **/
+     */
     function _read_configuration_data()
     {
         if (!method_exists($this->subscription, 'list_parameters'))
@@ -255,7 +255,7 @@
 
     /**
      * Creates a .tar.bz2 archive of dumped files
-     **/
+     */
     function _create_archive_tar_bz2()
     {
         // Doublecheck
@@ -295,7 +295,7 @@
     /**
      * Sanity checks for _create_archive_tar_bz2()
      *
-     **/
+     */
     function _can_create_archive_tar_bz2()
     {
         return true;
@@ -303,7 +303,7 @@
 
     /**
      * Sanity checks for _create_archive_tar()
-     **/
+     */
     function _can_create_archive_tar()
     {
         return true;

Modified: trunk/midcom/midcom.helper.replicator/transporter/email.php
==============================================================================
--- trunk/midcom/midcom.helper.replicator/transporter/email.php	(original)
+++ trunk/midcom/midcom.helper.replicator/transporter/email.php	Tue Jan  8 23:44:22 2008
@@ -31,7 +31,7 @@
      * Reads transport configuration from subscriptions parameters
      *
      * Also does some sanity checking
-     **/
+     */
     function _read_configuration_data()
     {
         if (!method_exists($this->subscription, 'list_parameters'))

Modified: trunk/midcom/midcom.helper.replicator/transporter/http.php
==============================================================================
--- trunk/midcom/midcom.helper.replicator/transporter/http.php	(original)
+++ trunk/midcom/midcom.helper.replicator/transporter/http.php	Tue Jan  8 23:44:22 2008
@@ -35,7 +35,7 @@
      * Reads transport configuration fomr subscriptions parameters
      *
      * Also does some sanity checking
-     **/
+     */
     function _read_configuration_data()
     {
         if (!method_exists($this->subscription, 'list_parameters'))
@@ -162,7 +162,7 @@
                  */
                  continue;
             }
-            $GLOBALS['midcom_helper_replicator_logger']->log("Succesfully sent key {$key}", MIDCOM_LOG_INFO);
+            $GLOBALS['midcom_helper_replicator_logger']->log("Successfully sent key {$key}", MIDCOM_LOG_INFO);
             unset($items[$key]);
         }
         unset($key, $data);

Modified: trunk/midcom/midgard.admin.asgard/handler/object/rcs.php
==============================================================================
--- trunk/midcom/midgard.admin.asgard/handler/object/rcs.php	(original)
+++ trunk/midcom/midgard.admin.asgard/handler/object/rcs.php	Tue Jan  8 23:44:22 2008
@@ -74,7 +74,7 @@
     }
 
     /**
-     * Deprecated interface, see get_plugin_handlers()
+     * @deprecated Deprecated interface, see get_plugin_handlers()
      */
     function get_request_switch()
     {
@@ -83,8 +83,9 @@
 
     /**
      * Static function, returns the request array for the rcs functions.
-     * @param none
-     * @returns array of request params
+     * 
+     * @return array of request params
+     * @static
      */
     function get_plugin_handlers()
     {
@@ -186,7 +187,7 @@
     }
 
     /**
-     * This function setts the correct Aegir navigationclass and
+     * This function sets the correct Aegir navigationclass and
      * /or calls the defined callbacks from the request component.
      * @todo add a way to get a schema out of this.
      */
@@ -197,7 +198,7 @@
 
     /**
      * Load the object and the rcs backend
-     * @param none
+     * 
      */
     function _load_object()
     {

Modified: trunk/midcom/midgard.admin.sitegroup/creation/config/config.php
==============================================================================
--- trunk/midcom/midgard.admin.sitegroup/creation/config/config.php	(original)
+++ trunk/midcom/midgard.admin.sitegroup/creation/config/config.php	Tue Jan  8 23:44:22 2008
@@ -84,7 +84,7 @@
 
     /**
      * Do not use the normal get/set_value api for these as they are related to auth.
-     **/
+     */
     function get_password()
     {
         return $this->_password;

Modified: trunk/midcom/midgard.admin.sitegroup/creation/host.php
==============================================================================
--- trunk/midcom/midgard.admin.sitegroup/creation/host.php	(original)
+++ trunk/midcom/midgard.admin.sitegroup/creation/host.php	Tue Jan  8 23:44:22 2008
@@ -327,7 +327,7 @@
     /**
      * Creates a basic style
      * @access private
-     **/
+     */
     function _create_style()
     {
         if ($this->config->get_value('extend_style') != 'none')

Modified: trunk/midcom/net.nehmer.branchenbuch/branche.php
==============================================================================
--- trunk/midcom/net.nehmer.branchenbuch/branche.php	(original)
+++ trunk/midcom/net.nehmer.branchenbuch/branche.php	Tue Jan  8 23:44:22 2008
@@ -271,7 +271,7 @@
     }
 
     /**
-     * DBA magic defaults which assign listing porivileges to all authenticated users.
+     * DBA magic defaults which assign listing privileges to all authenticated users.
      */
     function get_class_magic_default_privileges()
     {
@@ -308,6 +308,7 @@
      * @param string $type The name of the type for which we should list the categories.
      * @return Array List suitable for usage with select-style operations. In case of errors
      *     which are non-fatal, the error is logged and an empty array is returned.
+     * @static
      */
     function get_select_list_for_type($type)
     {

Modified: trunk/midcom/net.nehmer.branchenbuch/entry.php
==============================================================================
--- trunk/midcom/net.nehmer.branchenbuch/entry.php	(original)
+++ trunk/midcom/net.nehmer.branchenbuch/entry.php	Tue Jan  8 23:44:22 2008
@@ -275,7 +275,7 @@
      * account creation schema, perhaps with a field declaration like this (assuming an account
      * type 'freelancer'):
      *
-     * <pre>
+     * <code>
      * 'category' => Array
      * (
      *     'title' => 'Beruf',
@@ -291,11 +291,12 @@
      *     ),
      *     'widget' => 'select',
      * ),
-     * </pre>
+     * </code>
      *
      * @param string $guid The GUID of the category the new record should be created in.
      * @param midcom_db_person $person The record for which the default entry should be created.
      * @param midcom_db_topic $topic The YP topic in which we operate (used for configuration).
+     * @static
      */
     function create_default_entry($category_guid, $person, $topic)
     {

Modified: trunk/midcom/net.nehmer.buddylist/entry.php
==============================================================================
--- trunk/midcom/net.nehmer.buddylist/entry.php	(original)
+++ trunk/midcom/net.nehmer.buddylist/entry.php	Tue Jan  8 23:44:22 2008
@@ -89,6 +89,7 @@
      * @param midcom_core_user $user The user of whom the entries should be listed,
      *    this defaults to the currently active user.
      * @return Array A list of username => midcom_core_user pairs.
+     * @static
      */
     function list_buddies($user = null)
     {
@@ -140,6 +141,7 @@
      * @param midcom_core_user $user The user of whom the pending approvals should be listed,
      *    this defaults to the currently active user.
      * @return Array A QB resultset or false on failure.
+     * @static
      */
     function list_unapproved($user = null)
     {
@@ -161,6 +163,7 @@
      * This function must be called statically and requires an authenticated user.
      *
      * @return int The pending approval count.
+     * @static
      */
     function get_unapproved_count()
     {
@@ -195,6 +198,7 @@
      *
      * @return Array A list of midcom_core_user instances indexed by their current
      *     user name (use the GUID for all referrals!).
+     * @static
      */
     function list_online_buddies()
     {

Modified: trunk/midcom/net.nehmer.buddylist/viewer.php
==============================================================================
--- trunk/midcom/net.nehmer.buddylist/viewer.php	(original)
+++ trunk/midcom/net.nehmer.buddylist/viewer.php	Tue Jan  8 23:44:22 2008
@@ -12,7 +12,6 @@
  *
  * See the various handler classes for details.
  *
- *
  * @package net.nehmer.buddylist
  */
 class net_nehmer_buddylist_viewer extends midcom_baseclasses_components_request
@@ -24,7 +23,7 @@
 
     function _on_initialize()
     {
-        // Generic and personal welcom pages
+        // Generic and personal welcome pages
         $this->_request_switch['welcome'] = Array
         (
             'handler' => Array('net_nehmer_buddylist_handler_welcome', 'welcome'),

Modified: trunk/midcom/net.nehmer.comments/viewer.php
==============================================================================
--- trunk/midcom/net.nehmer.comments/viewer.php	(original)
+++ trunk/midcom/net.nehmer.comments/viewer.php	Tue Jan  8 23:44:22 2008
@@ -23,7 +23,7 @@
 
     function _on_initialize()
     {
-        // Generic and personal welcom pages
+        // Generic and personal welcome pages
         $this->_request_switch['admin-welcome'] = Array
         (
             'handler' => Array('net_nehmer_comments_handler_admin', 'welcome'),

Modified: trunk/midcom/net.nehmer.jobmarket/viewer.php
==============================================================================
--- trunk/midcom/net.nehmer.jobmarket/viewer.php	(original)
+++ trunk/midcom/net.nehmer.jobmarket/viewer.php	Tue Jan  8 23:44:22 2008
@@ -12,7 +12,6 @@
  *
  * See the various handler classes for details.
  *
- *
  * @package net.nehmer.jobmarket
  */
 class net_nehmer_jobmarket_viewer extends midcom_baseclasses_components_request
@@ -24,7 +23,7 @@
 
     function _on_initialize()
     {
-        // Generic and personal welcom pages
+        // Generic and personal welcome pages
         $this->_request_switch['welcome'] = Array
         (
             'handler' => Array('net_nehmer_jobmarket_handler_welcome', 'welcome'),

Modified: trunk/midcom/net.nemein.attention/exporter.php
==============================================================================
--- trunk/midcom/net.nemein.attention/exporter.php	(original)
+++ trunk/midcom/net.nemein.attention/exporter.php	Tue Jan  8 23:44:22 2008
@@ -45,6 +45,7 @@
      *
      * @param string $type The type of the exporter (the file name from the exporter directory).
      * @return net_nemein_attention_exporter A reference to the newly created exporter instance.
+     * @static
      */
     function & create($type)
     {

Modified: trunk/midcom/net.nemein.attention/importer.php
==============================================================================
--- trunk/midcom/net.nemein.attention/importer.php	(original)
+++ trunk/midcom/net.nemein.attention/importer.php	Tue Jan  8 23:44:22 2008
@@ -45,6 +45,7 @@
      *
      * @param string $type The type of the importer (the file name from the importer directory).
      * @return net_nemein_attention_importer A reference to the newly created importer instance.
+     * @static
      */
     function & create($type)
     {

Modified: trunk/midcom/net.nemein.beaexporter/main.php
==============================================================================
--- trunk/midcom/net.nemein.beaexporter/main.php	(original)
+++ trunk/midcom/net.nemein.beaexporter/main.php	Tue Jan  8 23:44:22 2008
@@ -628,7 +628,7 @@
         if (!$fp_file)
         {
             debug_add("Could not open file {$path} for writing, aborting", MIDCOM_LOG_ERROR);
-            /* This triggers unnessary watcher operation (we did not write to the attachment...)
+            /* This triggers unnecessary watcher operation (we did not write to the attachment...)
             $att->close();
             */
             fclose($fp_att);
@@ -643,7 +643,7 @@
                 debug_add("Error while writing to '{$path}', aborting");
                 debug_pop();
                 fclose($fp_file);
-                /* This triggers unnessary watcher operation (we did not write to the attachment...)
+                /* This triggers unnecessary watcher operation (we did not write to the attachment...)
                 $att->close();
                 */
                 fclose($fp_att);
@@ -651,7 +651,7 @@
             }
         }
         fclose($fp_file);
-        /* This triggers unnessary watcher operation (we did not write to the attachment...)
+        /* This triggers unnecessary watcher operation (we did not write to the attachment...)
         $att->close();
         */
         fclose($fp_att);

Modified: trunk/midcom/net.nemein.bookmarks/style/admin_welcome.php
==============================================================================
--- trunk/midcom/net.nemein.bookmarks/style/admin_welcome.php	(original)
+++ trunk/midcom/net.nemein.bookmarks/style/admin_welcome.php	Tue Jan  8 23:44:22 2008
@@ -27,7 +27,7 @@
     {
         if (count($unification_errors_bookmarks) == 0 && count($unification_errors_delicious) == 0)
         {
-            echo $GLOBALS["view_l10n"]->get("unification succesful");
+            echo $GLOBALS["view_l10n"]->get("unification successful");
         }
         else
         {

Modified: trunk/midcom/net.nemein.featured/handler/featured.php
==============================================================================
--- trunk/midcom/net.nemein.featured/handler/featured.php	(original)
+++ trunk/midcom/net.nemein.featured/handler/featured.php	Tue Jan  8 23:44:22 2008
@@ -4,7 +4,7 @@
  * Featured object handler
  *
  * @package net.nemein.featured
-**/
+ */
 class net_nemein_featured_handler_featured extends midcom_baseclasses_components_handler
 {
     var $_content_topic = null;
@@ -21,7 +21,7 @@
 
     /**
      * Simple default constructor.
-    **/
+     */
     function net_nemein_featured_handler_featured()
     {
         parent::midcom_baseclasses_components_handler();

Modified: trunk/midcom/net.nemein.featured/handler/view.php
==============================================================================
--- trunk/midcom/net.nemein.featured/handler/view.php	(original)
+++ trunk/midcom/net.nemein.featured/handler/view.php	Tue Jan  8 23:44:22 2008
@@ -4,7 +4,7 @@
  * Featured index page handler
  *
  * @package net.nemein.featured
-**/
+ */
 class net_nemein_featured_handler_view extends midcom_baseclasses_components_handler
 {
     var $_content_topic = null;
@@ -14,7 +14,7 @@
 
     /**
      * Simple default constructor.
-    **/
+     */
     function net_nemein_featured_handler_view()
     {
         parent::midcom_baseclasses_components_handler();

Modified: trunk/midcom/net.nemein.registrations/event.php
==============================================================================
--- trunk/midcom/net.nemein.registrations/event.php	(original)
+++ trunk/midcom/net.nemein.registrations/event.php	Tue Jan  8 23:44:22 2008
@@ -550,6 +550,8 @@
      * We need a better solution here in DBA core actually, but it will be difficult to
      * do this as we cannot determine the current class in a polymorphic environment without
      * having a this (this call is static).
+     * 
+     * @static
      */
     function new_query_builder()
     {
@@ -559,7 +561,7 @@
     /**
      * Returns a list of all events open for registration.
      *
-     * Implementation note: nfortunately, open registration processing must still be done using
+     * Implementation note: Unfortunately, open registration processing must still be done using
      * the PHP level, as the open/close timestamps are contained in parameters.
      *
      * This is built on the list_all function for now, see there for further comments about
@@ -884,7 +886,7 @@
      * We don't use the official get_csv_line interface btw., as this would
      * require us to un-csv-quote that string. (END TODO)
      *
-     * @todo Rewrite to a more suitable implementaiton with DM2 side support.
+     * @todo Rewrite to a more suitable implementation with DM2 side support.
      */
     function _dm_array_to_string(&$dm)
     {

Modified: trunk/midcom/net.nemein.registrations/registrar.php
==============================================================================
--- trunk/midcom/net.nemein.registrations/registrar.php	(original)
+++ trunk/midcom/net.nemein.registrations/registrar.php	Tue Jan  8 23:44:22 2008
@@ -79,6 +79,8 @@
      * We need a better solution here in DBA core actually, but it will be difficult to
      * do this as we cannot determine the current class in a polymorphic environment without
      * having a this (this call is static).
+     * 
+     * @static
      */
     function new_query_builder()
     {

Modified: trunk/midcom/net.nemein.registrations/registration.php
==============================================================================
--- trunk/midcom/net.nemein.registrations/registration.php	(original)
+++ trunk/midcom/net.nemein.registrations/registration.php	Tue Jan  8 23:44:22 2008
@@ -82,6 +82,8 @@
      * We need a better solution here in DBA core actually, but it will be difficult to
      * do this as we cannot determine the current class in a polymorphic environment without
      * having a this (this call is static).
+     * 
+     * @static
      */
     function new_query_builder()
     {

Modified: trunk/midcom/net.nemein.wiki/wikipage.php
==============================================================================
--- trunk/midcom/net.nemein.wiki/wikipage.php	(original)
+++ trunk/midcom/net.nemein.wiki/wikipage.php	Tue Jan  8 23:44:22 2008
@@ -36,6 +36,8 @@
      * We need a better solution here in DBA core actually, but it will be difficult to
      * do this as we cannot determine the current class in a polymorphic environment without
      * having a this (this call is static).
+     * 
+     * @static
      */
     function new_query_builder()
     {

Modified: trunk/midcom/no.bergfald.rcs/aegir_handler.php
==============================================================================
--- trunk/midcom/no.bergfald.rcs/aegir_handler.php	(original)
+++ trunk/midcom/no.bergfald.rcs/aegir_handler.php	Tue Jan  8 23:44:22 2008
@@ -16,14 +16,13 @@
     /**
      * Static function, returns the request array for the rcs functions.
      * Add this to your _on_initialize function in the calling request:
-     * <pre>
+     * <code>
      * $rcs_array =  no_bergfald_rcs::get_request_array();
      * $this->request_switch = array_merge($this->request_switch, $rcs_array)
-     * </pre>
-     * 
-     * @param none
-     * @returns array of request params 
+     * </code>
      * 
+     * @return array of request params 
+     * @static
      */
     function get_request_switch() 
     {

Modified: trunk/midcom/no.bergfald.rcs/backends/aegirrcs.php
==============================================================================
--- trunk/midcom/no.bergfald.rcs/backends/aegirrcs.php	(original)
+++ trunk/midcom/no.bergfald.rcs/backends/aegirrcs.php	Tue Jan  8 23:44:22 2008
@@ -210,9 +210,10 @@
     }
     /**
      * This function returns a list of the revisions as a
-     * key => value par where the key is the index of thhe revision
+     * key => value par where the key is the index of the revision
      * and the value is the revision id.
      * Order: revision 0 is the newest.
+     * 
      * @return array
      * @access public
      */
@@ -230,7 +231,7 @@
     }
     /**
      * Lists the number of changes that has been done to the object
-     * @param none
+     * 
      * @return array list of changeids
      */
     function list_history()

Modified: trunk/midcom/no.bergfald.rcs/backends/nemein_rcs_functions.php
==============================================================================
--- trunk/midcom/no.bergfald.rcs/backends/nemein_rcs_functions.php	(original)
+++ trunk/midcom/no.bergfald.rcs/backends/nemein_rcs_functions.php	Tue Jan  8 23:44:22 2008
@@ -417,13 +417,13 @@
     $object = mgd_get_object_by_guid($guid);
 
     /**
-     * Much of this is copied from NAdmin RCS parser, comments and some prosessing
+     * Much of this is copied from NAdmin RCS parser, comments and some processing
      * added (plus debug...)
      *
      */
 
     /*
-     * todo: use a propper parser!
+     * todo: use a proper parser!
      * */
      $curname = "";
      unset($dataarray);

Modified: trunk/midcom/no.bergfald.rcs/handler.php
==============================================================================
--- trunk/midcom/no.bergfald.rcs/handler.php	(original)
+++ trunk/midcom/no.bergfald.rcs/handler.php	Tue Jan  8 23:44:22 2008
@@ -70,7 +70,7 @@
     }
 
     /**
-     * Deprecated interface, see get_plugin_handlers()
+     * @deprecated Deprecated interface, see get_plugin_handlers()
      */
     function get_request_switch()
     {
@@ -79,8 +79,9 @@
 
     /**
      * Static function, returns the request array for the rcs functions.
-     * @param none
-     * @returns array of request params
+     * 
+     * @return array of request params
+     * @static
      */
     function get_plugin_handlers()
     {
@@ -170,7 +171,7 @@
     }
 
     /**
-     * This function setts the correct Aegir navigationclass and
+     * This function sets the correct Aegir navigationclass and
      * /or calls the defined callbacks from the request component.
      * @todo add a way to get a schema out of this.
      */
@@ -181,7 +182,7 @@
 
     /**
      * Load the object and the rcs backend
-     * @param none
+     * 
      */
     function _load_object()
     {

Modified: trunk/midcom/no.bergfald.rcs/rcs.php
==============================================================================
--- trunk/midcom/no.bergfald.rcs/rcs.php	(original)
+++ trunk/midcom/no.bergfald.rcs/rcs.php	Tue Jan  8 23:44:22 2008
@@ -16,32 +16,37 @@
 
     /**
      * The guid of the object in question
-     * @var string buid
+     * 
+     * @var string guid
      * @access private
      */
      var $_guid = null;
 
     /**
      * Backend object
+     * 
      * @var object no_nu_versoning_backend
      * @access private
      */
      var $backend = null;
 
     /**
-     * Pointer to thhe diff object
+     * Pointer to the diff object
+     * 
      * @access private
      * @var object text_diff
      */
      var $_diff = null;
+     
     /**
      *
      *
      * @param string guid
      * @param string backend to use
      */
+     
     /**
-     * History arrayy of object
+     * History array of object
      */
     var $_history = null;
 
@@ -75,6 +80,7 @@
 
         return $object;
     }
+    
     /**
      * Get a html diff between two versions.
      *
@@ -83,7 +89,6 @@
      * @access public
      * @return array array with the original value, the new value and a diff -u
      */
-
     function get_diff($oldest_revision, $latest_revision)
     {
         debug_push_class(__CLASS__, __FUNCTION__);
@@ -122,14 +127,14 @@
                         // Run the diff
                         $return[$attribute]['diff'] = $renderer->render($diff);
 
-                        // Mofify the output for nicer rendering
+                        // Modify the output for nicer rendering
                         $return[$attribute]['diff'] = str_replace('<del>', "<span class=\"deleted\" title=\"removed in {$latest_revision}\">", $return[$attribute]['diff']);
                         $return[$attribute]['diff'] = str_replace('</del>', '</span>', $return[$attribute]['diff']);
                         $return[$attribute]['diff'] = str_replace('<ins>', "<span class=\"inserted\" title=\"added in {$latest_revision}\">", $return[$attribute]['diff']);
                         $return[$attribute]['diff'] = str_replace('</ins>', '</span>', $return[$attribute]['diff']);
                     }
                 } elseif (!is_null($GLOBALS['midcom_config']['utility_diff'])){
-                    /* this doesnt work */
+                    /* this doesn't work */
                     $command = $GLOBALS['midcom_config']['utility_diff'] . " -u <(echo \"$oldest_value\") <(echo \"{$newest[$attribute]}\") ";
 
                     $output = array();
@@ -201,7 +206,7 @@
 
     /**
      * Lists the number of changes that has been done to the object
-     * @param none
+     * 
      * @return array list of changeids
      */
     function list_diffs()
@@ -247,9 +252,9 @@
         return "";
     }
 
-   /**
+    /**
      * Lists the number of changes that has been done to the object
-     * @param none
+     * 
      * @return array list of changeids or empty array if no changes.
      */
     function list_history()

Modified: trunk/midcom/no.odindata.quickform2/factory.php
==============================================================================
--- trunk/midcom/no.odindata.quickform2/factory.php	(original)
+++ trunk/midcom/no.odindata.quickform2/factory.php	Tue Jan  8 23:44:22 2008
@@ -16,7 +16,7 @@
      * The schema to use. Public until the controller is loaded.
      * @var array;
      * @access public
-     **/
+     */
     var $schema = null;
 
     /**
@@ -69,7 +69,7 @@
     }
     /**
      * Returns the values from a submitted form
-     **/
+     */
     function values()
     {
         return $this->_controller->datamanager->types;

Modified: trunk/midcom/org.maemo.devcodes/application.php
==============================================================================
--- trunk/midcom/org.maemo.devcodes/application.php	(original)
+++ trunk/midcom/org.maemo.devcodes/application.php	Tue Jan  8 23:44:22 2008
@@ -63,7 +63,7 @@
     /**
      * Reject this application for a device 
      *
-     * @return bool indicating succes/failure
+     * @return bool indicating success/failure
      */
     function reject()
     {
@@ -104,7 +104,7 @@
     /**
      * Accept this application for a device 
      *
-     * @return bool indicating succes/failure
+     * @return bool indicating success/failure
      */
     function accept()
     {

Modified: trunk/midcom/org.maemo.gforgeprofileupdater/gforge/user.php
==============================================================================
--- trunk/midcom/org.maemo.gforgeprofileupdater/gforge/user.php	(original)
+++ trunk/midcom/org.maemo.gforgeprofileupdater/gforge/user.php	Tue Jan  8 23:44:22 2008
@@ -130,9 +130,9 @@
 	return groups_to_soap($user->getGroups());
 }
 
-/*
-	Converts an array of User objects to soap data
-*/
+/**
+ * Converts an array of User objects to soap data
+ */
 function &users_to_soap($usrs) {
 	$return = array();
 	for ($i=0; $i<count($usrs); $i++) {

Modified: trunk/midcom/org.openpsa.contacts/mfa.php
==============================================================================
--- trunk/midcom/org.openpsa.contacts/mfa.php	(original)
+++ trunk/midcom/org.openpsa.contacts/mfa.php	Tue Jan  8 23:44:22 2008
@@ -16,11 +16,11 @@
     var $type = "";
    // var $children = array();
 
-    /*
-     * id:String (Objects guid)
-     * name:String
-     * type: String
-     * children:Array or Boolean
+    /**
+     * @param string $id (Object's guid)
+     * @param string $name
+     * @param string $type
+     * @param mixed $children Array or Boolean
      */
     function fi_incognito_protustree_item($id="",$name="",$type="group",$children="load_later",$options=array()) {
         // print("\nfi_incognito_protustree_item:".$name."\n");
@@ -31,7 +31,7 @@
         $this->addChildren($children);
     }
 
-    /*
+    /**
      * Will receive empty array if item has no children,
      * "load_later":String if we are at the maximum depth and item has children
      */

Modified: trunk/midcom/org.openpsa.reports/reports_handler_base.php
==============================================================================
--- trunk/midcom/org.openpsa.reports/reports_handler_base.php	(original)
+++ trunk/midcom/org.openpsa.reports/reports_handler_base.php	Tue Jan  8 23:44:22 2008
@@ -227,7 +227,7 @@
         {
             debug_add('Filename part not specified in URL, generating');
             //We do not have filename in URL, generate one and redirect
-            /* It seesm created is returned as timestamp again
+            /* It seems created is returned as timestamp again
             debug_add("Generating timestamp from {$this->_request_data['query']->created}");
             $timestamp = strtotime($this->_request_data['query']->created);
             */

Modified: trunk/midcom/org.routamc.photostream/importer.php
==============================================================================
--- trunk/midcom/org.routamc.photostream/importer.php	(original)
+++ trunk/midcom/org.routamc.photostream/importer.php	Tue Jan  8 23:44:22 2008
@@ -95,6 +95,7 @@
      * @param string $type The type of the importer (the file name from the importer directory).
      * @param int $photostream ID of a photostream node
      * @return org_routamc_photostream_importer A reference to the newly created importer instance.
+     * @static
      */
     function & create($type, $photostream)
     {

Modified: trunk/midcom/org.routamc.positioning/geocoder.php
==============================================================================
--- trunk/midcom/org.routamc.positioning/geocoder.php	(original)
+++ trunk/midcom/org.routamc.positioning/geocoder.php	Tue Jan  8 23:44:22 2008
@@ -52,6 +52,7 @@
      *
      * @param string $type The type of the geocoder (the file name from the geocoder directory).
      * @return org_routamc_positioning_geocoder A reference to the newly created geocoder instance.
+     * @static
      */
     function & create($type)
     {

Modified: trunk/midcom/org.routamc.positioning/importer.php
==============================================================================
--- trunk/midcom/org.routamc.positioning/importer.php	(original)
+++ trunk/midcom/org.routamc.positioning/importer.php	Tue Jan  8 23:44:22 2008
@@ -103,6 +103,7 @@
      *
      * @param string $type The type of the importer (the file name from the importer directory).
      * @return org_routamc_positioning_importer A reference to the newly created importer instance.
+     * @static
      */
     function & create($type)
     {

Modified: trunk/midcom/org.routamc.statusmessage/importer.php
==============================================================================
--- trunk/midcom/org.routamc.statusmessage/importer.php	(original)
+++ trunk/midcom/org.routamc.statusmessage/importer.php	Tue Jan  8 23:44:22 2008
@@ -59,6 +59,7 @@
      *
      * @param string $type The type of the importer (the file name from the importer directory).
      * @return org_routamc_statusmessage_importer A reference to the newly created importer instance.
+     * @static
      */
     function & create($type)
     {

Modified: trunk/midcom/pl.olga.tellafriend/viewer.php
==============================================================================
--- trunk/midcom/pl.olga.tellafriend/viewer.php	(original)
+++ trunk/midcom/pl.olga.tellafriend/viewer.php	Tue Jan  8 23:44:22 2008
@@ -43,7 +43,7 @@
  * </pre>
  *
  * @package pl.olga.tellafriend
- **/
+ */
 
 class pl_olga_tellafriend  extends midcom_baseclasses_components_purecode
 {

Modified: trunk/midcom/pl.olga.windguru/windguru.php
==============================================================================
--- trunk/midcom/pl.olga.windguru/windguru.php	(original)
+++ trunk/midcom/pl.olga.windguru/windguru.php	Tue Jan  8 23:44:22 2008
@@ -6,9 +6,9 @@
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
  */
 
-/*
-this is the function clients will use
-*/
+/**
+ * this is the function clients will use
+ */
 function windguru_forecast($id_spot,$code,$lang="") {
 	$wgf = new WindguruFcst($id_spot,$code,$lang);
 	echo $wgf->show();
@@ -39,10 +39,10 @@
  		$this->version = "1.5 beta";
 	}
 
-	/*
-	prints the forecast if available
-	takes care of updating from windguru.cz, caching the forecast, reading data status from windguru.cz etc...
-	*/
+	/**
+	 * prints the forecast if available
+	 * takes care of updating from windguru.cz, caching the forecast, reading data status from windguru.cz etc...
+	 */
 	function show()
 	{
 		if (!$this->id_spot || !$this->code)
@@ -200,7 +200,7 @@
 		return true;
 	}
 
-// updates data status from windguru.cz, if reload==1 then it updates immediatelly otherwise it will not
+// updates data status from windguru.cz, if reload==1 then it updates immediately otherwise it will not
 // update if last update was less then 10 minutes ago
 
 	function updateStatus($reload = 0)
@@ -331,7 +331,7 @@
 		}
 
 		$this->html = implode("",$fcst);
-		if($this->html) return true; // reading was succesful
+		if($this->html) return true; // reading was successful
 	}
 
 	function setLang($lang="") {

Modified: trunk/midcom/se.anykey.mmslib/mmslib.php
==============================================================================
--- trunk/midcom/se.anykey.mmslib/mmslib.php	(original)
+++ trunk/midcom/se.anykey.mmslib/mmslib.php	Tue Jan  8 23:44:22 2008
@@ -243,7 +243,7 @@
 
 
 
-/*
+/**
  * Part class
  *
  * The Part class is just a container for various attachments of different content types.
@@ -311,7 +311,7 @@
 
 
 
-/*
+/**
  * MMSDecoder class
  *
  * The MMSDecoder class decodes binary MMS chunks so that you can extract its parts
@@ -913,7 +913,7 @@
 
 
 
-/*
+/**
  * MMSEncoder class
  *
  * The class that does the encoding of the mms message and writes it to a file.
@@ -1161,7 +1161,7 @@
 }
 
 
-/*
+/**
  * MMSNotifyer class
  *
  * This class is used to send out the notification that will point the phone to the


More information about the midcom-commits mailing list