lib MDL-19236 Corrected PhpDoc

rsendhil · May 26, 2009 · aaeba37 · aaeba37
1 parent 49a54fc
commit aaeba37
Show file tree

Hide file tree

Showing 4 changed files with 64 additions and 33 deletions.
diff --git a/lib/base32.php b/lib/base32.php
@@ -22,6 +22,12 @@
 // +----------------------------------------------------------------------+
 //
 
+/**
+ * @package moodlecore
+ * @copyright (c) 2001 The PHP Group
+ * @license GNU GPL v2.0 http://www.php.net/license/2_02.txt
+ */
+
 /**
  * Base32 encode a binary string
  *

diff --git a/lib/boxlib.php b/lib/boxlib.php
@@ -1,19 +1,36 @@
 <?php
-/**
- * Modified by Dongsheng Cai <dongsheng@moodle.com>
- */
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
  * Box REST Client Library for PHP5 Developers
  *
  *
+ * @package moodlecore
  * @author James Levy <james@box.net>
  * @link http://enabled.box.net
  * @access public
  * @version 1.0
  * @copyright copyright Box.net 2007
- * @license Available for use and distribution under GPL-license
- * Go to http://www.gnu.org/licenses/gpl-3.0.txt for full text
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * @package moodlecore
+ * @copyright copyright Box.net 2007
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class boxclient {
     /** @var string */

diff --git a/lib/graphlib.php b/lib/graphlib.php
@@ -1,34 +1,38 @@
-<?php  // $Id$
-
-/*
-Graph Class. PHP Class to draw line, point, bar, and area graphs, including numeric x-axis and double y-axis.
-Version: 1.6.3
-Copyright (C) 2000  Herman Veluwenkamp
-
-This library is free software; you can redistribute it and/or
-modify it under the terms of the GNU Lesser General Public
-License as published by the Free Software Foundation; either
-version 2.1 of the License, or (at your option) any later version.
-
-This library is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-Lesser General Public License for more details.
-
-You should have received a copy of the GNU Lesser General Public
-License along with this library; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-Copy of GNU Lesser General Public License at: http://www.gnu.org/copyleft/lesser.txt
-Contact author at: hermanV@mindless.com
-*/
+<?php
+
+/**
+ * Graph Class. PHP Class to draw line, point, bar, and area graphs, including numeric x-axis and double y-axis.
+ * Version: 1.6.3
+ * Copyright (C) 2000  Herman Veluwenkamp
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ * Copy of GNU Lesser General Public License at: http://www.gnu.org/copyleft/lesser.txt
+ * Contact author at: hermanV@mindless.com
+ * 
+ * @package moodlecore
+ */
 
 /* This file contains modifications by Martin Dougiamas
  * as part of Moodle (http://moodle.com).  Modified lines
  * are marked with "Moodle".
  */
 
-
+/**
+ * @package moodlecore
+ */
 class graph {
   var $image;
   var $debug             =   FALSE;        // be careful!!

diff --git a/lib/grouplib.php b/lib/grouplib.php
@@ -256,7 +256,9 @@ function groups_get_all_groupings($courseid) {
 /**
  * Determines if the user is a member of the given group.
  *
- * @global object $USER If $userid is null, use the global object.
+ * If $userid is null, use the global object.
+ *
+ * @global object
  * @global object
  * @param int $groupid The group to check for membership.
  * @param int $userid The user to check against the group.
@@ -780,9 +782,11 @@ function groups_get_activity_allowed_groups($cm,$userid=0) {
 
 /**
  * Determine if a course module is currently visible to a user
- * 
+ *
+ * $USER If $userid is null, use the global object.
+ *
+ * @global object
  * @global object
- * @global object $USER If $userid is null, use the global object.
  * @param int $cm The course module
  * @param int $userid The user to check against the group.
  * @return boolean True if the user can view the course module, false otherwise.