MINOR Documentation for image uploads

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

core/model/Image.php

@@ -464,6 +464,15 @@ class Image_Saver extends DBField {
 
 /**
  * Uploader support for the uploading anything which is a File or subclass of File, eg Image.
+ * Is connected to the URL routing "/image" through sapphire/_config.php,
+ * and used by all iframe-based upload-fields in the CMS.
+ *
+ * @usedby FileIframeField
+ * @usedby ImageField
+ * @todo Refactor to using FileIframeField and ImageField as a controller for the upload,
+ *   rather than something totally disconnected from the original Form and FormField
+ *   context. Without the original context its impossible to control permissions etc.
+ *
  * @package sapphire
  * @subpackage filesystem
  */

forms/FileIFrameField.php

@@ -1,6 +1,9 @@
 <?php 
 /**
- * A field that will upload files to a page for use within the CMS.
+ * A field that will upload files to a page for use within the CMS through an iframe.
+ * If you want to upload files without an iframe, use {@link FileField}.
+ *
+ * @used Image_Upload
  * 
  * @package forms
  * @subpackage fields-files

forms/ImageField.php

@@ -1,6 +1,10 @@
 <?php
 /**
- * A field that will upload attached images.
+ * A field that will upload attached images within the CMS through an iframe.
+ * If you want to upload images without iframes, see {@link SimpleImageField}.
+ *
+ * @uses Image_Upload
+ * 
  * @package forms
  * @subpackage fields-files
  */

forms/SimpleImageField.php

@@ -1,7 +1,8 @@
 <?php
 /**
  * SimpleImageField provides an easy way of uploading images to Image has_one relationships.
- * Unlike ImageField, it doesn't use an iframe.
+ * Unlike {@link ImageField}, it doesn't use an iframe.
+ * 
  * @package forms
  * @subpackage fields-files
  */