diff --git a/TShockAPI/Configuration/ConfigFile.cs b/TShockAPI/Configuration/ConfigFile.cs index ef08a696..6d856433 100644 --- a/TShockAPI/Configuration/ConfigFile.cs +++ b/TShockAPI/Configuration/ConfigFile.cs @@ -21,11 +21,13 @@ namespace TShockAPI.Configuration public static Action> OnConfigRead; /// - /// Reads json-formatted settings from a given path + /// Reads json-formatted settings from a given path. + /// If the given path does not exist is set to + /// and a default object is returned /// /// The path to the file containing the settings /// - /// Whether the config object has any new fields in it, meaning that the config file has to be + /// Whether the config object has any new fields in it, meaning that the config file should be /// overwritten. /// /// Settings object @@ -60,7 +62,7 @@ namespace TShockAPI.Configuration } /// - /// Converts a json-formatted string into the settings object used by this configuration + /// Converts a json-formatted string into the settings object used by this configuration. Invokes the hook /// /// Json string to parse /// Whether or not the json string contained an incomplete set of settings @@ -78,7 +80,7 @@ namespace TShockAPI.Configuration /// /// Writes the configuration to a given path /// - /// string path - Location to put the config file + /// The file path the configuration file will be written to public virtual void Write(string path) { using (var fs = new FileStream(path, FileMode.Create, FileAccess.Write, FileShare.Write))