mirror of
https://github.com/claunia/SabreTools.git
synced 2025-12-16 19:14:27 +00:00
[doc] Add actual documentation to all classes
This commit is contained in:
@@ -11,6 +11,9 @@ using SabreTools.Helper;
|
||||
|
||||
namespace SabreTools
|
||||
{
|
||||
/// <summary>
|
||||
/// Generate a DAT from the data in the database
|
||||
/// </summary>
|
||||
class Generate
|
||||
{
|
||||
// Private instance variables
|
||||
@@ -24,6 +27,15 @@ namespace SabreTools
|
||||
private Dictionary<int, string> _headers;
|
||||
private Logger _logger;
|
||||
|
||||
/// <summary>
|
||||
/// Initialize a Generate object with the given information
|
||||
/// </summary>
|
||||
/// <param name="systems">Comma-separated list of systems to be included in the DAT (blank means all)</param>
|
||||
/// <param name="sources">Comma-separated list of sources to be included in the DAT (blank means all)</param>
|
||||
/// <param name="connectionString">Connection string for SQLite</param>
|
||||
/// <param name="logger">Logger object for file or console output</param>
|
||||
/// <param name="norename">True if files should not be renamed with system and/or source in merged mode (default false)</param>
|
||||
/// <param name="old">True if the output file should be in RomVault format (default false)</param>
|
||||
public Generate(string systems, string sources, string connectionString, Logger logger, bool norename = false, bool old = false)
|
||||
{
|
||||
_systems = systems;
|
||||
@@ -43,6 +55,10 @@ namespace SabreTools
|
||||
_headers.Add(241, "snes.xml"); // Self-created to deal with various headers
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Generate a DAT file that is represented by the data in the Generate object.
|
||||
/// </summary>
|
||||
/// <returns>True if the file could be created, false otherwise</returns>
|
||||
public bool Export()
|
||||
{
|
||||
// Check to see if the source is an import-only. If so, tell the user and exit
|
||||
@@ -251,6 +267,10 @@ namespace SabreTools
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Preprocess the rom data that is to be included in the outputted DAT
|
||||
/// </summary>
|
||||
/// <returns>A List of RomData objects containing all information about the files</returns>
|
||||
public List<RomData> ProcessRoms()
|
||||
{
|
||||
List<RomData> roms = new List<RomData>();
|
||||
@@ -429,7 +449,9 @@ JOIN checksums
|
||||
}
|
||||
}
|
||||
|
||||
// Intermediate struct for holding and processing rom data
|
||||
/// <summary>
|
||||
/// Intermediate struct for holding and processing rom data
|
||||
/// </summary>
|
||||
public struct RomData
|
||||
{
|
||||
public string Manufacturer;
|
||||
|
||||
Reference in New Issue
Block a user