From 7d88776af82281a662ea57c096472a289aa556a4 Mon Sep 17 00:00:00 2001
From: abraar <abraar@colosa.com>
Date: Thu, 27 Jan 2011 11:04:13 +0000
Subject: [PATCH] Changes done for PhpDoc

---
 gulliver/bin/gulliver.php           | 21 ++++++++++++---------
 gulliver/bin/tasks/pakeBase.php     | 18 +++++++++++++-----
 gulliver/bin/tasks/pakeGulliver.php | 14 ++++++++++----
 gulliver/bin/tasks/pakePropel.php   | 21 +++++++++++++--------
 gulliver/bin/tasks/pakeTest.php     | 13 +++++++++----
 5 files changed, 57 insertions(+), 30 deletions(-)

diff --git a/gulliver/bin/gulliver.php b/gulliver/bin/gulliver.php
index 58eee1aa2..23c8c54df 100644
--- a/gulliver/bin/gulliver.php
+++ b/gulliver/bin/gulliver.php
@@ -1,9 +1,10 @@
 <?php
 /**
  * gulliver.php
- *  
+ * @package gulliver.bin.tasks
+ * 
  * ProcessMaker Open Source Edition
- * Copyright (C) 2004 - 2008 Colosa Inc.23
+ * Copyright (C) 2004 - 2011 Colosa Inc.
  * 
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -20,21 +21,23 @@
  * 
  * For more information, contact Colosa Inc, 2566 Le Jeune Rd., 
  * Coral Gables, FL, 33134, USA, or email info@colosa.com.
- *
- * /**
- *  @package gulliver.bin.tasks
+ * 
  */
  
 
   if (! PATH_THIRDPARTY ) {
     die("You must launch gulliver command line with the gulliver script\n");
   }
-
+ 
   // set magic_quotes_runtime to off
   ini_set('magic_quotes_runtime', 'Off');
-  require_once( PATH_THIRDPARTY . 'pake' . PATH_SEP . 'pakeFunction.php');
-  require_once( PATH_THIRDPARTY . 'pake' . PATH_SEP . 'pakeGetopt.class.php');
-  require_once( PATH_CORE . 'config' . PATH_SEP . 'environments.php');
+  
+   /**
+   * Copyright (C) 2004 - 2011 Colosa Inc.
+   */
+    require_once( PATH_THIRDPARTY . 'pake' . PATH_SEP . 'pakeFunction.php');
+    require_once( PATH_THIRDPARTY . 'pake' . PATH_SEP . 'pakeGetopt.class.php');
+    require_once( PATH_CORE . 'config' . PATH_SEP . 'environments.php');
 
   // trap -V before pake
   if (in_array('-V', $argv) || in_array('--version', $argv))
diff --git a/gulliver/bin/tasks/pakeBase.php b/gulliver/bin/tasks/pakeBase.php
index 532b0b273..2be73dbf6 100644
--- a/gulliver/bin/tasks/pakeBase.php
+++ b/gulliver/bin/tasks/pakeBase.php
@@ -1,9 +1,10 @@
 <?php
 /**
  * pakeBase.php
- *  
+ * @package gulliver.bin.tasks
+ * 
  * ProcessMaker Open Source Edition
- * Copyright (C) 2004 - 2008 Colosa Inc.23
+ * Copyright (C) 2004 - 2011 Colosa Inc.
  * 
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -20,9 +21,7 @@
  * 
  * For more information, contact Colosa Inc, 2566 Le Jeune Rd., 
  * Coral Gables, FL, 33134, USA, or email info@colosa.com.
- *
- * /**
- *  @package gulliver.bin.tasks
+ *  
  */
 
 
@@ -30,6 +29,11 @@ pake_task('project_exists');
 pake_task('app_exists', 'project_exists');
 pake_task('module_exists', 'app_exists');
 
+  /**
+   * Function run_project_exists
+   * access public
+   */
+
 function run_project_exists($task, $args)
 {
 //  if (!file_exists('pre_processor.php'))
@@ -40,6 +44,10 @@ function run_project_exists($task, $args)
 //  pake_properties('config/properties.ini');
 }
 
+/**
+   * Function run_app_exists
+   * access public
+   */
 function run_app_exists($task, $args)
 {
   if (!count($args))
diff --git a/gulliver/bin/tasks/pakeGulliver.php b/gulliver/bin/tasks/pakeGulliver.php
index 67acea0a0..38fd92b22 100644
--- a/gulliver/bin/tasks/pakeGulliver.php
+++ b/gulliver/bin/tasks/pakeGulliver.php
@@ -2,9 +2,10 @@
 
 /**
  * pakeGulliver.php
- *
+ * @package gulliver.bin.tasks
+ * 
  * ProcessMaker Open Source Edition
- * Copyright (C) 2004 - 2008 Colosa Inc.23
+ * Copyright (C) 2004 - 2011 Colosa Inc.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -21,8 +22,8 @@
  *
  * For more information, contact Colosa Inc, 2566 Le Jeune Rd.,
  * Coral Gables, FL, 33134, USA, or email info@colosa.com.
- *  /**
- * @package gulliver.bin.tasks
+ *  
+ * 
  */
 //dont work mb_internal_encoding('UTF-8');
 
@@ -63,6 +64,11 @@ pake_task('workspace-restore', 'project_exists');
 pake_desc("check standard code\n   args: <directory>");
 pake_task('check-standard-code', 'project_exists' );
 
+/**
+   * Function run_version
+   * access public
+   */
+
 function run_version($task, $args) {
   printf("Gulliver version %s\n", pakeColor::colorize(trim(file_get_contents(PATH_GULLIVER . 'VERSION')), 'INFO'));
   exit(0);
diff --git a/gulliver/bin/tasks/pakePropel.php b/gulliver/bin/tasks/pakePropel.php
index c0a76f175..353e30dc3 100644
--- a/gulliver/bin/tasks/pakePropel.php
+++ b/gulliver/bin/tasks/pakePropel.php
@@ -1,9 +1,10 @@
 <?php
 /**
  * pakePropel.php
- *
+ * @package gulliver.bin.tasks
+ * 
  * ProcessMaker Open Source Edition
- * Copyright (C) 2004 - 2008 Colosa Inc.23
+ * Copyright (C) 2004 - 2011 Colosa Inc.23
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -20,8 +21,7 @@
  *
  * For more information, contact Colosa Inc, 2566 Le Jeune Rd.,
  * Coral Gables, FL, 33134, USA, or email info@colosa.com.
- *  /**
- * @package gulliver.bin.tasks
+ * 
  */
 
 /*
@@ -68,6 +68,11 @@ pake_task('propel-insert-sql', 'project_exists');
 //pake_desc('generate propel model and sql and initialize database, and load data');
 //pake_task('propel-build-all-load', 'propel-build-all');
 
+/**
+   * Function run_propel_convert_yml_schema
+   * access public
+   */
+
 function run_propel_convert_yml_schema($task, $args)
 {
   _propel_convert_yml_schema(true);
@@ -351,8 +356,8 @@ function run_propel_build_schema($task, $args)
 /**
  * Dumps yml database data to fixtures directory.
  *
- * @example symfony dump-data frontend data.yml
- * @example symfony dump-data frontend data.yml dev
+ * example symfony dump-data frontend data.yml
+ * example symfony dump-data frontend data.yml dev
  *
  * @param object $task
  * @param array $args
@@ -385,8 +390,8 @@ function run_propel_dump_data($task, $args)
 /**
  * Loads yml data from fixtures directory and inserts into database.
  *
- * @example symfony load-data frontend
- * @example symfony load-data frontend dev fixtures append
+ * example symfony load-data frontend
+ * example symfony load-data frontend dev fixtures append
  *
  * @todo replace delete argument with flag -d
  *
diff --git a/gulliver/bin/tasks/pakeTest.php b/gulliver/bin/tasks/pakeTest.php
index 1630bbaa2..d901ec833 100644
--- a/gulliver/bin/tasks/pakeTest.php
+++ b/gulliver/bin/tasks/pakeTest.php
@@ -1,9 +1,10 @@
 <?php
 /**
  * pakeTest.php
+ * @package gulliver.bin.tasks
  *  
  * ProcessMaker Open Source Edition
- * Copyright (C) 2004 - 2008 Colosa Inc.23
+ * Copyright (C) 2004 - 2011 Colosa Inc.23
  * 
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -20,8 +21,7 @@
  * 
  * For more information, contact Colosa Inc, 2566 Le Jeune Rd., 
  * Coral Gables, FL, 33134, USA, or email info@colosa.com.
- * /**
- * @package gulliver.bin.tasks
+ * 
  */
 
  
@@ -35,6 +35,11 @@ pake_task('test-functional', 'project_exists');
 pake_desc('launch all tests');
 pake_task('test-all', 'project_exists');
 
+   /**
+   * Function run_test_all
+   * access public
+   */
+
 function run_test_all($task, $args)
 {
   require_once(sfConfig::get('sf_symfony_lib_dir').'/lime/lime.php');
@@ -48,7 +53,7 @@ function run_test_all($task, $args)
 
   $h->run();
 }
-
+   
 function run_test_functional($task, $args)
 {
   if (!count($args))