MINOR Documentation

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@74012 467b73ca-7a2a-4603-9d3b-597d59a354a9

core/model/fieldtypes/Currency.php

@@ -2,6 +2,9 @@
 /**
  * Represents a decimal field containing a currency amount.
  * Currency the currency class only supports single currencies.
+ *
+ * @todo Add localization support, see http://open.silverstripe.com/ticket/2931
+ * 
  * @package sapphire
  * @subpackage model
  */

core/model/fieldtypes/Date.php

@@ -1,6 +1,13 @@
 <?php
 /**
  * Represents a date field.
+ * The field currently supports New Zealand date format (DD/MM/YYYY),
+ * or an ISO 8601 formatted date (YYYY-MM-DD).
+ * Alternatively you can set a timestamp that is evaluated through
+ * PHP's built-in date() function according to your system locale.
+ * 
+ * @todo Add localization support, see http://open.silverstripe.com/ticket/2931
+ * 
  * @package sapphire
  * @subpackage model
  */

core/model/fieldtypes/SSDatetime.php

@@ -1,6 +1,13 @@
 <?php
 /**
  * Represents a date-time field.
+ * The field currently supports New Zealand date format (DD/MM/YYYY),
+ * or an ISO 8601 formatted date and time (Y-m-d H:i:s).
+ * Alternatively you can set a timestamp that is evaluated through
+ * PHP's built-in date() and strtotime() function according to your system locale.
+ * 
+ * @todo Add localization support, see http://open.silverstripe.com/ticket/2931
+ * 
  * @package sapphire
  * @subpackage model
  */

core/model/fieldtypes/Time.php

@@ -1,6 +1,9 @@
 <?php
 /**
- * Represents a column in the database with the type 'Time'
+ * Represents a column in the database with the type 'Time'.
+ * 
+ * @todo Add localization support, see http://open.silverstripe.com/ticket/2931
+ * 
  * @package sapphire
  * @subpackage model
  */

forms/CurrencyField.php

@@ -1,6 +1,9 @@
 <?php
 /**
  * Currency field.
+ * 
+ * @todo Add localization support, see http://open.silverstripe.com/ticket/2931 
+ *
  * @package forms
  * @subpackage fields-formattedinput
  */

forms/DMYCalendarDateField.php

@@ -1,7 +1,10 @@
 <?php
 /**
  * Displays a date field with day, month and year boxes, with a calendar to select
- * the date
+ * the date.
+ * 
+ * @todo Add localization support, see http://open.silverstripe.com/ticket/2931
+ *
  * @package forms
  * @subpackage fields-datetime
  */

forms/DMYDateField.php

@@ -1,7 +1,10 @@
 <?php
 /**
  * Displays a date field with day, month and year boxes, with a calendar to select
- * the date
+ * the date.
+ * 
+ * @todo Add localization support, see http://open.silverstripe.com/ticket/2931
+ *
  * @package forms
  * @subpackage fields-datetime
  */

forms/DateField.php

@@ -2,6 +2,9 @@
 /**
  * Date field.
  * Default Value represented in the format
+ * 
+ * @todo Add localization support, see http://open.silverstripe.com/ticket/2931
+ * 
  * @package forms
  * @subpackage fields-datetime
  */

forms/PopupDateTimeField.php

@@ -1,6 +1,9 @@
 <?php
 /**
  * Field for entering a date/time pair.
+ * 
+ * @todo Add localization support, see http://open.silverstripe.com/ticket/2931
+ *
  * @package forms
  * @subpackage fields-datetime
  */

forms/TimeField.php

@@ -3,6 +3,8 @@
  * Time field.
  * Default Value represented in the format passed as constructor.
  * 
+ * @todo Add localization support, see http://open.silverstripe.com/ticket/2931
+ *
  * @package forms
  * @subpackage fields-datetime
  */