From 262b4e5f1570ecdde329fa474684d9efc1813a58 Mon Sep 17 00:00:00 2001
From: Yannick Warnier <yannick.warnier@beeznest.com>
Date: Sun, 6 Jan 2013 23:54:32 -0500
Subject: [PATCH] Minor - Added PHPDoc blocks

---
 main/glossary/access.class.php              | 11 +++++++++--
 main/glossary/ajax_controller.class.php     | 11 +++++++++--
 main/glossary/controller.class.php          | 11 +++++++++--
 main/glossary/course_import.class.php       | 12 +++++++++---
 main/glossary/csv_reader.class.php          | 10 +++++++++-
 main/glossary/csv_writer.class.php          | 10 +++++++++-
 main/glossary/glossary.class.php            | 10 +++++++++-
 main/glossary/glossary_ajax_request.php     | 13 +++++++++----
 main/glossary/glossary_form.class.php       | 11 +++++++++--
 main/glossary/glossary_repository.class.php | 11 +++++++++--
 main/glossary/request.class.php             | 11 +++++++++--
 main/glossary/upload_file_form.class.php    | 11 +++++++++--
 12 files changed, 108 insertions(+), 24 deletions(-)
 mode change 100755 => 100644 main/glossary/glossary_ajax_request.php

diff --git a/main/glossary/access.class.php b/main/glossary/access.class.php
index dfff157a9f..421c9a80c6 100644
--- a/main/glossary/access.class.php
+++ b/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;
     }
 
-}
\ No newline at end of file
+}
diff --git a/main/glossary/ajax_controller.class.php b/main/glossary/ajax_controller.class.php
index 0ec69083e9..0b3c054936 100644
--- a/main/glossary/ajax_controller.class.php
+++ b/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);
     }
 
-}
\ No newline at end of file
+}
diff --git a/main/glossary/controller.class.php b/main/glossary/controller.class.php
index a25a7d1560..94afd27c6d 100644
--- a/main/glossary/controller.class.php
+++ b/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);
     }
 
-}
\ No newline at end of file
+}
diff --git a/main/glossary/course_import.class.php b/main/glossary/course_import.class.php
index cf241f5d4d..9c5ce76ff0 100644
--- a/main/glossary/course_import.class.php
+++ b/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
         }
     }
 
-}
\ No newline at end of file
+}
diff --git a/main/glossary/csv_reader.class.php b/main/glossary/csv_reader.class.php
index a62080f08c..abc0e7ed72 100644
--- a/main/glossary/csv_reader.class.php
+++ b/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;
     }
 
-}
\ No newline at end of file
+}
diff --git a/main/glossary/csv_writer.class.php b/main/glossary/csv_writer.class.php
index dcd2cbdd29..1cc0e637e6 100644
--- a/main/glossary/csv_writer.class.php
+++ b/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
     
     
 
-}
\ No newline at end of file
+}
diff --git a/main/glossary/glossary.class.php b/main/glossary/glossary.class.php
index c29e61c2a9..343ce2e218 100644
--- a/main/glossary/glossary.class.php
+++ b/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;
     }
-}
\ No newline at end of file
+}
diff --git a/main/glossary/glossary_ajax_request.php b/main/glossary/glossary_ajax_request.php
old mode 100755
new mode 100644
index b6d3f9b976..35459eea2d
--- a/main/glossary/glossary_ajax_request.php
+++ b/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'));
- }
\ No newline at end of file
+ }
diff --git a/main/glossary/glossary_form.class.php b/main/glossary/glossary_form.class.php
index d14ea03775..b3fbc4b1e2 100644
--- a/main/glossary/glossary_form.class.php
+++ b/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;
     }
 
-}
\ No newline at end of file
+}
diff --git a/main/glossary/glossary_repository.class.php b/main/glossary/glossary_repository.class.php
index a89ade4dd7..b03995d91d 100644
--- a/main/glossary/glossary_repository.class.php
+++ b/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;
     }
 
-}
\ No newline at end of file
+}
diff --git a/main/glossary/request.class.php b/main/glossary/request.class.php
index 181cc75ce7..97d45e6525 100644
--- a/main/glossary/request.class.php
+++ b/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;
     }
 
-}
\ No newline at end of file
+}
diff --git a/main/glossary/upload_file_form.class.php b/main/glossary/upload_file_form.class.php
index a3d83531bc..d787c2016d 100644
--- a/main/glossary/upload_file_form.class.php
+++ b/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;
     }
 
-}
\ No newline at end of file
+}