Browse Source

Minor - Updated phpdoc tags

Yannick Warnier 12 years ago
parent
commit
0bf06d9c72

+ 5 - 3
tests/main_api.lib.test_standalone.php

@@ -1,11 +1,13 @@
 <?php
-
+/* For licensing terms, see /license.txt */
 /**
  * A simple set of tests for the main API.
  * @author Ivan Tcholakov, 2009.
- * For licensing terms, see /dokeos_license.txt
+ * @package chamilo.tests
+ */
+/**
+ * Init
  */
-
 $_current_dir = dirname(__FILE__).'/';
 
 $_sys_code_path = $_current_dir.'../main/';

+ 6 - 4
tests/rmdirr.lib.test_standalone.php

@@ -1,11 +1,13 @@
 <?php
-
+/* For licensing terms, see /license.txt */
 /**
  * A standalone test for testing the function rmdirr()
  * @author Ivan Tcholakov, September 2009.
- * For licensing terms, see /dokeos_license.txt
+ * @package chamilo.tests
+ */
+/**
+ * Init
  */
-
 //ini_set('memory_limit','128M');
 
 $_current_dir = dirname(__FILE__).'/';
@@ -45,4 +47,4 @@ class RmDirRTests extends TestSuite {
 $test = & new RmDirRTests();
 //$test-> run( new HtmlReporter());
 
-?>
+?>

+ 1 - 1
tests/simpletest/mock_objects.php

@@ -463,7 +463,7 @@ class SimpleCallSchedule {
      *    @param array $args        The parameters making up the
      *                              rest of the call.
      *    @return mixed             The result of the action.
-     *    @access public.
+     *    @access public
      */
     function &respond($step, $method, $args) {
         $method = strtolower($method);

+ 5 - 5
tests/test_suite.php

@@ -9,9 +9,8 @@
 *	- files with functions tests
 *
 *	@todo rewrite code to separate display, logic, database code
-*	@package chamilo.main
+*	@package chamilo.tests
 */
-
 /**
  * @todo shouldn't these settings be moved to the test_suite.php.
  * 		 if these are really configuration then we can make require_once in each tests.
@@ -64,10 +63,11 @@ require_once 'simpletest/autorun.php';
 require_once 'simpletest/reporter.php';
 require_once 'simpletest/xml.php';
 
-/*  TEST SUITE
+/**
+ *  TEST SUITE
  * Start to load the tests files
-*/
-
+ * @package chamilo.tests
+ */
 class TestsSuite extends TestSuite {
 
     function TestsSuite() {

+ 8 - 2
tests/test_webservices.php

@@ -1,16 +1,22 @@
 <?php
+/* For licensing terms, see /license.txt */
 /**
  * Set of unit tests for the web services
  * 
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
+ * @package chamilo.tests
+ */
+/**
+ * Init
  */
-
 ini_set('soap.wsdl_cache_enabled', 0);
 
 require_once(dirname(__FILE__).'/../main/inc/global.inc.php');
 
 require_once(dirname(__FILE__).'/simpletest/autorun.php');
-
+/**
+ * @package chamilo.tests
+ */
 class TestSoapWebService extends UnitTestCase {
 	protected $_secret_key;
 	

+ 6 - 0
tests/xhprof/footer.php

@@ -1,4 +1,10 @@
 <?php
+/**
+ * @package chamilo.profiling
+ */
+/**
+ * Init
+ */
 if (extension_loaded('xhprof')) {
     $profiler_namespace = 'chamilolms';  // namespace for your application
     $xhprof_data = xhprof_disable();

+ 6 - 0
tests/xhprof/header.php

@@ -1,4 +1,10 @@
 <?php
+/**
+ * @package chamilo.profiling
+ */
+/**
+ * Init
+ */
 if (extension_loaded('xhprof')) {
     include_once dirname(__FILE__).'/xhprof_lib/utils/xhprof_lib.php';
     include_once dirname(__FILE__).'/xhprof_lib/utils/xhprof_runs.php';

+ 3 - 3
tests/xhprof/xhprof_lib/utils/callgraph_utils.php

@@ -88,7 +88,7 @@ function xhprof_generate_mime_header($type, $length) {
  * @param dot_script, string, the script for DOT to generate the image.
  * @param type, one of the supported image types, see
  * $xhprof_legal_image_types.
- * @returns, binary content of the generated image on success. empty string on
+ * @return binary content of the generated image on success. empty string on
  *           failure.
  *
  * @author cjiang
@@ -150,7 +150,7 @@ function xhprof_get_children_table($raw_data) {
  * @param func, string, the focus function.
  * @param critical_path, bool, whether or not to display critical path with
  *                             bold lines.
- * @returns, string, the DOT script to generate image.
+ * @return string, the DOT script to generate image.
  *
  * @author cjiang
  */
@@ -418,7 +418,7 @@ function  xhprof_render_diff_image($xhprof_runs_impl, $run1, $run2,
  *                   threshold will be filtered out and won't apprear in the
  *                   generated image.
  * @param func, string, the focus function.
- * @returns, string, the DOT script to generate image.
+ * @return string, the DOT script to generate image.
  *
  * @author cjiang
  */