Update XML documentation for RenderTarget2D (#10)

MonoGame.Framework/Graphics/RenderTarget2D.cs

@@ -6,23 +6,80 @@
 
 namespace Microsoft.Xna.Framework.Graphics
 {
+    /// <summary>
+    /// Represents a 2D texture resource that will be written to at the end of a render pass.
+    /// </summary>
+    /// <remarks>
+    ///     <para>After a render pass the render target contains the color information of a rendered image.</para>
+    ///     <para>
+    ///         Render targets represent a linear area of display memory and usually resides in the display memory of
+    ///         the display card.  Because of this, objects must be recreated when the device is reset.
+    ///     </para>
+    /// </remarks>
 	public partial class RenderTarget2D : Texture2D, IRenderTarget
 	{
+        /// <summary>
+        /// Gets the depth format used by this <b>RenderTarget2D</b>
+        /// </summary>
 		public DepthFormat DepthStencilFormat { get; private set; }
-
+
+        /// <summary>
+        /// Gets the number of samples taken per pixel
+        /// </summary>
 		public int MultiSampleCount { get; private set; }
-
+
+        /// <summary>
+        /// Gets or Sets the usage type used by this <b>RenderTarget2D</b>
+        /// </summary>
 		public RenderTargetUsage RenderTargetUsage { get; private set; }
-
+
+        /// <summary>
+        /// Gets a value that indicates whether the contents of this <b>RenderTarget2D</b> has been lost due to a lost
+        /// device event.
+        /// </summary>
+        /// <remarks>
+        /// This property will always return <b>false</b>.  It is included for XNA compatibility.
+        /// </remarks>
+        [Obsolete("This is provided for XNA compatibility only and will always return false")]
 		public bool IsContentLost { get { return false; } }
-
+
+        /// <summary>
+        /// Occurs when a graphics device lost event is triggered.
+        /// </summary>
+        /// <remarks>
+        /// This event is never called.  It is included for XNA compatibility.
+        /// </remarks>
+        [Obsolete("This is provided for XNA compatibility is never called by MonoGame")]
 		public event EventHandler<EventArgs> ContentLost;
-		
+
         private bool SuppressEventHandlerWarningsUntilEventsAreProperlyImplemented()
         {
             return ContentLost != null;
         }
 
+        /// <summary>
+        /// Creates a new <b>RenderTarget2D</b> instance with the specified parameters.
+        /// </summary>
+        /// <param name="graphicsDevice">The graphics device to associate with this render target resource.</param>
+        /// <param name="width">Width, in pixels, of the render target.</param>
+        /// <param name="height">Height, in pixels, of the render target.</param>
+        /// <param name="mipMap"><b>true</b> if mipmapping is enabled; otherwise, <b>false</b>.</param>
+        /// <param name="preferredFormat">The preferred surface format of the render target.</param>
+        /// <param name="preferredDepthFormat">The preferred depth format of the render target.</param>
+        /// <param name="preferredMultiSampleCount">The preferred number of samples per pixel when multisampling.</param>
+        /// <param name="usage">The behavior to use when binding the render target to the graphics device.</param>
+        /// <param name="shared">
+        /// Whether this render target resource should be a shared resource accessible on another device.
+        /// This property is only valid for DirectX targets.
+        /// </param>
+        /// <param name="arraySize">The size of the texture array.</param>
+        /// <exception cref="ArgumentNullException">The <paramref name="graphicsDevice"/> parameter is null.</exception>
+        /// <exception cref="ArgumentOutOfRangeException">
+        /// The <paramref name="width"/> and/or <paramref name="height"/> parameters less than or equal to zero.
+        /// </exception>
+        /// <exception cref="ArgumentException">
+        /// <paramref name="arraySize"/> is greater than 0 and the graphics device does not support texture arrays.
+        /// </exception>
 	    public RenderTarget2D(GraphicsDevice graphicsDevice, int width, int height, bool mipMap, SurfaceFormat preferredFormat, DepthFormat preferredDepthFormat, int preferredMultiSampleCount, RenderTargetUsage usage, bool shared, int arraySize)
 	        : base(graphicsDevice, width, height, mipMap, QuerySelectedFormat(graphicsDevice, preferredFormat), SurfaceType.RenderTarget, shared, arraySize)
 	    {
@@ -32,7 +89,8 @@ public RenderTarget2D(GraphicsDevice graphicsDevice, int width, int height, bool
 
             PlatformConstruct(graphicsDevice, width, height, mipMap, preferredDepthFormat, preferredMultiSampleCount, usage, shared);
 	    }
-
+
+        /// <summary />
         protected static SurfaceFormat QuerySelectedFormat(GraphicsDevice graphicsDevice, SurfaceFormat preferredFormat)
         {
 			SurfaceFormat selectedFormat = preferredFormat;
@@ -44,26 +102,83 @@ protected static SurfaceFormat QuerySelectedFormat(GraphicsDevice graphicsDevice
                 graphicsDevice.Adapter.QueryRenderTargetFormat(graphicsDevice.GraphicsProfile, preferredFormat, DepthFormat.None, 0,
                     out selectedFormat, out selectedDepthFormat, out selectedMultiSampleCount);
             }
-            
+
             return selectedFormat;
         }
 
+        /// <summary>
+        /// Creates a new <b>RenderTarget2D</b> instance with the specified parameters.
+        /// </summary>
+        /// <param name="graphicsDevice">The graphics device to associate with this render target resource.</param>
+        /// <param name="width">Width, in pixels, of the render target.</param>
+        /// <param name="height">Height, in pixels, of the render target.</param>
+        /// <param name="mipMap"><b>true</b> if mipmapping is enabled; otherwise, <b>false</b>.</param>
+        /// <param name="preferredFormat">The preferred surface format of the render target.</param>
+        /// <param name="preferredDepthFormat">The preferred depth format of the render target.</param>
+        /// <param name="preferredMultiSampleCount">The preferred number of samples per pixel when multisampling.</param>
+        /// <param name="usage">The behavior to use when binding the render target to the graphics device.</param>
+        /// <param name="shared">
+        /// Whether this render target resource should be a shared resource accessible on another device.
+        /// This property is only valid for DirectX targets.
+        /// </param>
+        /// <exception cref="ArgumentNullException">The <paramref name="graphicsDevice"/> parameter is null.</exception>
+        /// <exception cref="ArgumentOutOfRangeException">
+        /// The <paramref name="width"/> and/or <paramref name="height"/> parameters less than or equal to zero.
+        /// </exception>
         public RenderTarget2D (GraphicsDevice graphicsDevice, int width, int height, bool mipMap, SurfaceFormat preferredFormat, DepthFormat preferredDepthFormat, int preferredMultiSampleCount, RenderTargetUsage usage, bool shared)
 			: this(graphicsDevice, width, height, mipMap, preferredFormat, preferredDepthFormat, preferredMultiSampleCount, usage, shared, 1)
         {
-			
+
         }
 
+        /// <summary>
+        /// Creates a new <b>RenderTarget2D</b> instance with the specified parameters.
+        /// </summary>
+        /// <param name="graphicsDevice">The graphics device to associate with this render target resource.</param>
+        /// <param name="width">Width, in pixels, of the render target.</param>
+        /// <param name="height">Height, in pixels, of the render target.</param>
+        /// <param name="mipMap"><b>true</b> if mipmapping is enabled; otherwise, <b>false</b>.</param>
+        /// <param name="preferredFormat">The preferred surface format of the render target.</param>
+        /// <param name="preferredDepthFormat">The preferred depth format of the render target.</param>
+        /// <param name="preferredMultiSampleCount">The preferred number of samples per pixel when multisampling.</param>
+        /// <param name="usage">The behavior to use when binding the render target to the graphics device.</param>
+        /// <exception cref="ArgumentNullException">The <paramref name="graphicsDevice"/> parameter is null.</exception>
+        /// <exception cref="ArgumentOutOfRangeException">
+        /// The <paramref name="width"/> and/or <paramref name="height"/> parameters less than or equal to zero.
+        /// </exception>
 		public RenderTarget2D (GraphicsDevice graphicsDevice, int width, int height, bool mipMap, SurfaceFormat preferredFormat, DepthFormat preferredDepthFormat, int preferredMultiSampleCount, RenderTargetUsage usage)
 			:this (graphicsDevice, width, height, mipMap, preferredFormat, preferredDepthFormat, preferredMultiSampleCount, usage, false)
         {}
 
+        /// <summary>
+        /// Creates a new <b>RenderTarget2D</b> instance with the specified parameters.
+        /// </summary>
+        /// <param name="graphicsDevice">The graphics device to associate with this render target resource.</param>
+        /// <param name="width">Width, in pixels, of the render target.</param>
+        /// <param name="height">Height, in pixels, of the render target.</param>
+        /// <param name="mipMap"><b>true</b> if mipmapping is enabled; otherwise, <b>false</b>.</param>
+        /// <param name="preferredFormat">The preferred surface format of the render target.</param>
+        /// <param name="preferredDepthFormat">The preferred depth format of the render target.</param>
+        /// <exception cref="ArgumentNullException">The <paramref name="graphicsDevice"/> parameter is null.</exception>
+        /// <exception cref="ArgumentOutOfRangeException">
+        /// The <paramref name="width"/> and/or <paramref name="height"/> parameters less than or equal to zero.
+        /// </exception>
 		public RenderTarget2D(GraphicsDevice graphicsDevice, int width, int height, bool mipMap, SurfaceFormat preferredFormat, DepthFormat preferredDepthFormat)
-			:this (graphicsDevice, width, height, mipMap, preferredFormat, preferredDepthFormat, 0, RenderTargetUsage.DiscardContents) 
+			:this (graphicsDevice, width, height, mipMap, preferredFormat, preferredDepthFormat, 0, RenderTargetUsage.DiscardContents)
 		{}
-
+
+        /// <summary>
+        /// Creates a new <b>RenderTarget2D</b> instance with the specified parameters.
+        /// </summary>
+        /// <param name="graphicsDevice">The graphics device to associate with this render target resource.</param>
+        /// <param name="width">Width, in pixels, of the render target.</param>
+        /// <param name="height">Height, in pixels, of the render target.</param>
+        /// <exception cref="ArgumentNullException">The <paramref name="graphicsDevice"/> parameter is null.</exception>
+        /// <exception cref="ArgumentOutOfRangeException">
+        /// The <paramref name="width"/> and/or <paramref name="height"/> parameters less than or equal to zero.
+        /// </exception>
 		public RenderTarget2D(GraphicsDevice graphicsDevice, int width, int height)
-			: this(graphicsDevice, width, height, false, SurfaceFormat.Color, DepthFormat.None, 0, RenderTargetUsage.DiscardContents) 
+			: this(graphicsDevice, width, height, false, SurfaceFormat.Color, DepthFormat.None, 0, RenderTargetUsage.DiscardContents)
 		{}
 
         /// <summary>
@@ -85,10 +200,11 @@ protected RenderTarget2D(GraphicsDevice graphicsDevice,
             RenderTargetUsage = usage;
 		}
 
+        /// <inheritdoc />
         protected internal override void GraphicsDeviceResetting()
         {
             PlatformGraphicsDeviceResetting();
             base.GraphicsDeviceResetting();
-        }        
+        }
 	}
 }