Sfoglia il codice sorgente

Minor - Adapting code comments to phpdoc

Yannick Warnier 13 anni fa
parent
commit
39daf877a3

+ 6 - 4
main/auth/courses_controller.php

@@ -1,12 +1,14 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  * This file contains class used like controller, it should be included inside a dispatcher file (e.g: index.php)
- * @author Christian Fasanando <christian1827@gmail.com> - Beeznest
+ * @author Christian Fasanando <christian1827@gmail.com> - BeezNest
+ * @package chamilo.auth
+ */
+/**
+ * Code
  * @package chamilo.auth
  */
-
 class CoursesController { // extends Controller {
 
     private $toolname;
@@ -275,4 +277,4 @@ class CoursesController { // extends Controller {
         $action = 'sortmycourses';
         $this->courses_list($action, $message);
     }
-}
+}

+ 0 - 1
main/auth/openid/openid.lib.php

@@ -2,7 +2,6 @@
 /* For licensing terms, see /license.txt */
 /**
  * OpenID utility functions. Taken from Drupal 6 code (from dries)
- * @file openid.lib.php
  * @package chamilo.auth.openid
  */
 /**

+ 1 - 1
main/auth/sso/sso.class.php

@@ -207,7 +207,7 @@ class sso {
      * Decode the cookie (this function may vary depending on the
      * Single Sign On implementation
      * @param	string	Encoded cookie
-     * @result  array   Parsed and unencoded cookie
+     * @return  array   Parsed and unencoded cookie
      */
     private function decode_cookie($cookie) {
         return unserialize(base64_decode($cookie));

+ 4 - 6
main/chat/header_frame.inc.php

@@ -1,17 +1,15 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
- *	Header of each frame of the Chat tool
+ * Header of each frame of the Chat tool
  *
- *	@author Olivier Brouckaert
- *  @modified by Denes Nagy
- *	@package chamilo.chat
+ * @author Olivier Brouckaert
+ * Modified by Denes Nagy
+ * @package chamilo.chat
  */
 /**
  * Code
  */
-
 if (!defined('FRAME')) {
 	exit();
 }

+ 0 - 1
main/document/slideshowoptions.php

@@ -9,7 +9,6 @@
  * It is not perfect at all but it is workable and usefull (I think)
  * Do not consider this as a powerpoint replacement, although it has
  * the same starting point.
- * @description
  *	This is a plugin for the documents tool. It looks for .jpg, .jpeg, .gif, .png
  * 	files (since these are the files that can be viewed in a browser) and creates
  *	a slideshow with it by allowing to go to the next/previous image.

+ 3 - 2
main/inc/tool_navigation_menu.inc.php

@@ -1,12 +1,13 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  *	Navigation menu display code
  *
  *	@package chamilo.include
  */
-
+/**
+ * Code
+ */
 define('SHORTCUTS_HORIZONTAL', 0);
 define('SHORTCUTS_VERTICAL', 1);