timy
/
SpriteLibrary
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

documentation updates

This commit is contained in:
Tim Young 2017-09-21 13:00:21 -05:00
parent 517b9b88e0
commit 2409d30cb6
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
SpriteLibrary/SpriteDatabase.cs
View File

@ -262,7 +262,7 @@ namespace SpriteLibrary
/// to GetImageFromName</param>
/// <param name="UseSmartImages">A parameter stating whether we should cache the image in memory
/// or simply retrieve it from the resource manager.</param>
/// <returns></returns>
/// <returns>The resource image with the specified name</returns>
public Image GetImageFromName(string Name, bool UseSmartImages)
{
Image MyImage = null;
@ -296,7 +296,7 @@ namespace SpriteLibrary
/// <summary>
/// Return a list of the image names in the Properties.Resources
/// </summary>
/// <returns></returns>
/// <returns>A list of image names in the Properties.Resources</returns>
public List<string> GetImageNames()
{
List<string> Names = new List<string>();
@ -342,7 +342,7 @@ namespace SpriteLibrary
/// <summary>
/// Load in an XML serialized item from the specified ResourceManager. You will usually make one of these by
/// creating an object and using <see cref="SpriteDatabase.WriteToXmlFile">SpriteDatabase.WriteToXmlFile</see> to
/// creating an object and using <see cref="WriteToXmlFile{T}(string, T)"/> SpriteDatabase.WriteToXmlFile to
/// save it to a file on your desktop. Then you can drag and drop that file into your project and then use this
/// LoadObjectFromXmlFile function.
/// </summary>
@ -372,14 +372,14 @@ namespace SpriteLibrary
/// <summary>
/// Writes the given object instance to an XML file.
/// <para>Only Public properties and variables will be written to the file. These can be any type though, even other classes.</para>
/// <para>If there are public properties/variables that you do not want written to the file, decorate them with the [XmlIgnore] attribute.</para>
/// <para>Object type must have a parameterless constructor.</para>
/// Only Public properties and variables will be written to the file. These can be any type though, even other classes.
/// If there are public properties/variables that you do not want written to the file, decorate them with the [XmlIgnore] attribute.
/// Object type must have a parameterless constructor.
/// </summary>
/// <typeparam name="T">The type of object being written to the file.</typeparam>
/// <param name="filePath">The file path to write the object instance to.</param>
/// <param name="objectToWrite">The object instance to write to the file.</param>
internal static void WriteToXmlFile<T>(string filePath, T objectToWrite) where T : new()
public static void WriteToXmlFile<T>(string filePath, T objectToWrite) where T : new()
{
TextWriter writer = null;
try

4
SpriteLibrary/SpriteInfo.cs
View File

@ -97,7 +97,7 @@ namespace SpriteLibrary
/// <summary>
/// A generic cloning method that works when everything is public
/// </summary>
/// <returns></returns>
/// <returns>A clone of the specified AnimationInfo</returns>
public AnimationInfo Clone()
{
return SpriteDatabase.CloneByXMLSerializing<AnimationInfo>(this);
@ -136,7 +136,7 @@ namespace SpriteLibrary
/// <summary>
/// A generic cloning method that works when everything is public
/// </summary>
/// <returns></returns>
/// <returns>A duplicate of the sprite info.</returns>
public SpriteInfo Clone()
{
return SpriteDatabase.CloneByXMLSerializing<SpriteInfo>(this);