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

View File

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

View File

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