feature 2999 : documentation of include/functions_calendar.inc.php and Calendar classes

git-svn-id: http://piwigo.org/svn/trunk@25507 68402e56-0260-453c-a942-63ccdbb3a9ee

1 files changed, 13 insertions, 1 deletions

diff --git a/include/functions_calendar.inc.php b/include/functions_calendar.inc.php
index b8ad3d0fa..09e9942de 100644
--- a/include/functions_calendar.inc.php
+++ b/include/functions_calendar.inc.php
@@ -21,9 +21,19 @@
 // | USA.                                                                  |
 // +-----------------------------------------------------------------------+
 
+/**
+ * @package functions\calendar
+ */
+
+/** URL keyword for list view */
 define('CAL_VIEW_LIST',     'list');
+/** URL keyword for calendar view */
 define('CAL_VIEW_CALENDAR', 'calendar');
 
+
+/**
+ * Initialize _$page_ and _$template_ vars for calendar view.
+ */
 function initialize_calendar()
 {
   global $page, $conf, $user, $template, $filter;
@@ -124,7 +134,8 @@ WHERE id IN (' . implode(',',$page['items']) .')';
   }
   $cal_style = $page['chronology_style'];
   include(PHPWG_ROOT_PATH.'include/'. $styles[$cal_style]['include']);
-  $calendar = new Calendar();
+  // TODO : class name overlap, rename them in CalendarMonth and CalendarWeek
+  $calendar = new Calendar(); 
 
   // Retrieve view
 
@@ -289,4 +300,5 @@ WHERE id IN (' . implode(',',$page['items']) .')';
   }
   pwg_debug('end initialize_calendar');
 }
+
 ?>
\ No newline at end of file