Browse Source

Minor - Adapting code comments to phpdoc

Yannick Warnier 13 years ago
parent
commit
fba2dba304

+ 1 - 1
main/inc/lib/course.lib.php

@@ -1330,7 +1330,7 @@ class CourseManager {
      * Users of this library should consider this function private,
      * please call attempt_create_virtual_course instead of this one.
      *
-     * @note The virtual course 'owner' id (the first course admin) is set to the CURRENT user id.
+     * note: The virtual course 'owner' id (the first course admin) is set to the CURRENT user id.
      * @param  string  Course code
      * @param  string  Course title
      * @param  string  Wanted course code

+ 0 - 1
main/inc/lib/geometry.lib.php

@@ -13,7 +13,6 @@ DEFINE('DEBUG', false);
  * @param max[x]    X resolution
  * @param max[y]    Y resolution
  * @returns an array such as: for all i in [0..max[x][ : for all j in [0..max[y][ : array[i][j] = FALSE
- * @package chamilo.include.geometry
  */
 function poly_init($max) {
     return array_fill(0, $max["x"]-1, 

+ 5 - 2
main/inc/lib/glossary.lib.php

@@ -3,9 +3,12 @@
 /**
 *	This library provides functions for the glossary tool.
 *	Include/require it in your code to use its functionality.
-
 *	@package chamilo.library
 */
+/**
+ * Class
+ * @package chamilo.library
+ */
 class GlossaryManager {
 
     /**
@@ -534,4 +537,4 @@ class GlossaryManager {
 
 		Display::display_confirmation_message(get_lang('TermMoved'));
 	}
-}
+}

+ 4 - 3
main/inc/lib/pdf.lib.php

@@ -9,8 +9,9 @@
 define('_MPDF_PATH', api_get_path(LIBRARY_PATH).'mpdf/');
 require_once _MPDF_PATH.'mpdf.php';
 /**
-*   @package chamilo.library
-*/
+ * Class
+ * @package chamilo.library
+ */
 class PDF {
     
     var $pdf;    
@@ -181,7 +182,7 @@ class PDF {
      * @param   string  valid html 
      * @param   string  pdf name   
      * @param   string  course code (if you are using html that are located in the document tool you must provide this) 
-     * @return  
+     * @return  string Web path
      */    
     public function content_to_pdf($document_html, $css = '', $pdf_name = '', $course_code = null) {