Move example out of summary. Makes the generated documentation cleaner.

This commit is contained in:
Tim Young 2017-10-03 19:36:55 -05:00
parent 880e741900
commit 244ab8373f

View File

@ -451,6 +451,7 @@ namespace SpriteLibrary
/// <summary> /// <summary>
/// Replace the image on which the sprites are drawn. Use this when you move to a new playing field, /// Replace the image on which the sprites are drawn. Use this when you move to a new playing field,
/// or want to have a different background /// or want to have a different background
/// </summary>
/// <example> /// <example>
/// Replacing the background image is actually a lot more complex than you might imagine. Once you use the /// Replacing the background image is actually a lot more complex than you might imagine. Once you use the
/// below code, it can be done without any problem. But you need to do it this way, or it just goofs up in /// below code, it can be done without any problem. But you need to do it this way, or it just goofs up in
@ -476,7 +477,6 @@ namespace SpriteLibrary
///} ///}
/// </code> /// </code>
/// </example> /// </example>
/// </summary>
/// <param name="tImage">The new image that all sprites will be drawn on</param> /// <param name="tImage">The new image that all sprites will be drawn on</param>
public void ReplaceOriginalImage(Image tImage) public void ReplaceOriginalImage(Image tImage)
{ {