Browse Source

Minor - Added PHPDoc blocks

Yannick Warnier 12 năm trước cách đây
mục cha
commit
262b4e5f15

+ 9 - 2
main/glossary/access.class.php

@@ -1,5 +1,12 @@
 <?php
-
+/* For licensing terms, see /license.txt */
+/**
+ * Glossary access class
+ * @package chamilo.glossary
+ */
+/**
+ * Init
+ */
 namespace Glossary;
 
 /**
@@ -81,4 +88,4 @@ class Access extends \Access
         return true;
     }
 
-}
+}

+ 9 - 2
main/glossary/ajax_controller.class.php

@@ -1,5 +1,12 @@
 <?php
-
+/* For licensing terms, see /license.txt */
+/**
+ * Glossary's AjaxController class definition
+ * @package chamilo.glossary
+ */
+/**
+ * Init
+ */
 namespace Glossary;
 
 use \Display;
@@ -105,4 +112,4 @@ class AjaxController extends \AjaxController
         $this->response($success, '', $data);
     }
 
-}
+}

+ 9 - 2
main/glossary/controller.class.php

@@ -1,5 +1,12 @@
 <?php
-
+/* For licensing terms, see /license.txt */
+/**
+ * Glossay controller class definition
+ * @package chamilo.glossary
+ */
+/**
+ * Init
+ */
 namespace Glossary;
 
 use \ChamiloSession as Session;
@@ -305,4 +312,4 @@ class Controller extends \Controller
         parent::render("glossary/$template.tpl", $data);
     }
 
-}
+}

+ 9 - 3
main/glossary/course_import.class.php

@@ -1,7 +1,13 @@
 <?php
-
+/* For licensing terms, see /license.txt */
+/**
+ * Glossay course import class definition
+ * @package chamilo.glossary
+ */
+/**
+ * Init
+ */
 namespace Glossary;
-
 /**
  * Import glossary entries into a course/session.
  * 
@@ -82,4 +88,4 @@ class CourseImport
         }
     }
 
-}
+}

+ 9 - 1
main/glossary/csv_reader.class.php

@@ -1,4 +1,12 @@
 <?php
+/* For licensing terms, see /license.txt */
+/**
+ * Glossay csv reader class definition
+ * @package chamilo.glossary
+ */
+/**
+ * Init
+ */
 
 namespace Glossary;
 
@@ -97,4 +105,4 @@ class CsvReader implements \Iterator
         return count($items) > $this->index;
     }
 
-}
+}

+ 9 - 1
main/glossary/csv_writer.class.php

@@ -1,4 +1,12 @@
 <?php
+/* For licensing terms, see /license.txt */
+/**
+ * Glossay csv writer class definition
+ * @package chamilo.glossary
+ */
+/**
+ * Init
+ */
 
 namespace Glossary;
 
@@ -43,4 +51,4 @@ class CsvWriter extends \CsvObjectWriter
     
     
 
-}
+}

+ 9 - 1
main/glossary/glossary.class.php

@@ -1,4 +1,12 @@
 <?php
+/* For licensing terms, see /license.txt */
+/**
+ * Glossay class definition
+ * @package chamilo.glossary
+ */
+/**
+ * Init
+ */
 
 namespace Glossary;
 
@@ -209,4 +217,4 @@ class Glossary extends \Entity
     {
         return $this->session_id;
     }
-}
+}

+ 9 - 4
main/glossary/glossary_ajax_request.php

@@ -1,15 +1,20 @@
 <?php
 /* For licensing terms, see /license.txt */
 /* @todo move this file in the inc/ajax/ folder */
-
-
+/**
+ * Glossay ajax request code
+ * @package chamilo.glossary
+ */
+/**
+ * Init
+ */
 // Including the global initialization file.
 require_once '../inc/global.inc.php';
 
 // Including additional libraries.
 require_once api_get_path(LIBRARY_PATH).'glossary.lib.php';
 
-/*
+/**
  * Search a term and return description from a glossary.
  */
 $charset = api_get_system_encoding();
@@ -48,4 +53,4 @@ $path_image_search='../../courses/'.api_get_course_path();
 
  } else {
      echo api_xml_http_response_encode(get_lang('NoResults'));
- }
+ }

+ 9 - 2
main/glossary/glossary_form.class.php

@@ -1,5 +1,12 @@
 <?php
-
+/* For licensing terms, see /license.txt */
+/**
+ * Glossay form class definition
+ * @package chamilo.glossary
+ */
+/**
+ * Init
+ */
 namespace Glossary;
 
 use Chamilo;
@@ -93,4 +100,4 @@ class GlossaryForm extends \FormValidator
         return $result;
     }
 
-}
+}

+ 9 - 2
main/glossary/glossary_repository.class.php

@@ -1,5 +1,12 @@
 <?php
-
+/* For licensing terms, see /license.txt */
+/**
+ * Glossay repository class definition
+ * @package chamilo.glossary
+ */
+/**
+ * Init
+ */
 namespace Glossary;
 
 use Database;
@@ -324,4 +331,4 @@ class GlossaryRepository
         return $result;
     }
 
-}
+}

+ 9 - 2
main/glossary/request.class.php

@@ -1,5 +1,12 @@
 <?php
-
+/* For licensing terms, see /license.txt */
+/**
+ * Glossay request class definition
+ * @package chamilo.glossary
+ */
+/**
+ * Init
+ */
 namespace Glossary;
 
 use \ChamiloSession as Session;
@@ -169,4 +176,4 @@ class Request extends \Request
         return $result;
     }
 
-}
+}

+ 9 - 2
main/glossary/upload_file_form.class.php

@@ -1,5 +1,12 @@
 <?php
-
+/* For licensing terms, see /license.txt */
+/**
+ * Glossay UploadFileForm class definition
+ * @package chamilo.glossary
+ */
+/**
+ * Init
+ */
 namespace Glossary;
 
 use Chamilo;
@@ -91,4 +98,4 @@ class UploadFileForm extends \FormValidator
         return true;
     }
 
-}
+}