From: omidmottaghi <omidmottaghi>
Date: Sat, 26 Nov 2005 18:31:51 +0000 (+0000)
Subject: PHPDoc comments updated
X-Git-Tag: 1.0~269
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=70a44dd723bbfe9e22ed8dc2c050a0ca6e50ecce;p=s9y.git

PHPDoc comments updated
---

diff --git a/include/functions_calendars.inc.php b/include/functions_calendars.inc.php
index e14cdee..5ee6d2a 100644
--- a/include/functions_calendars.inc.php
+++ b/include/functions_calendars.inc.php
@@ -55,7 +55,7 @@ function g2j($g_y, $g_m, $g_d){
 }
 
 /**
- * Gregorian to Jalali Convertor
+ * Jalali to Gregorian Convertor
  *
  * @author farsiweb.info
  * @access public
@@ -107,13 +107,13 @@ function j2g($j_y, $j_m, $j_d){
 }
     
 /**
- * Format a string according to Jalali calendar
+ * Format a string according to Jalali calendar (UTF)
  *
  * @author  Omid Mottaghi
  * @access public
  * @param   string  Formatting string
  * @param   int     Timestamp to format
- * @return  string  Formatted stamp
+ * @return  string  Formatted local time/date according to locale settings
  */
 function jalali_strftime_utf($format, $timestamp) {
     
@@ -258,7 +258,7 @@ function jalali_strftime_utf($format, $timestamp) {
  * @access public
  * @param   string  Formatting string
  * @param   int     Timestamp to format
- * @return
+ * @return  string  Formatted local time/date
  */
 function jalali_date_utf($format, $timestamp) {
     
@@ -396,7 +396,7 @@ function jalali_date_utf($format, $timestamp) {
 }
 
 /**
- * Create a jalali timestamp from a gregorian timestamp
+ * Create a Jalali timestamp from a Gregorian timestamp
  *
  * @author Omid Mottaghi
  * @access public
@@ -406,7 +406,7 @@ function jalali_date_utf($format, $timestamp) {
  * @param   int month
  * @param   int day
  * @param   int year
- * @param   int DST-Format?
+ * @param   int is daylight savings time set?
  * @return  int returned timestamp
  */
 function jalali_mktime($hour=0, $min=0, $sec=0, $mon=1, $day=1, $year=1970, $is_dst=-1){