mirror of
https://github.com/aaru-dps/Aaru.git
synced 2025-12-16 19:24:25 +00:00
DOCUMENTATION: Added XML documentation to DiscImageChef.Core.
This commit is contained in:
@@ -39,10 +39,18 @@ using PlatformID = DiscImageChef.Interop.PlatformID;
|
||||
|
||||
namespace DiscImageChef.Core.Logging
|
||||
{
|
||||
/// <summary>
|
||||
/// Creates a dump log
|
||||
/// </summary>
|
||||
public class DumpLog
|
||||
{
|
||||
readonly StreamWriter logSw;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes the dump log
|
||||
/// </summary>
|
||||
/// <param name="outputFile">Output log file</param>
|
||||
/// <param name="dev">Device</param>
|
||||
public DumpLog(string outputFile, Device dev)
|
||||
{
|
||||
if(string.IsNullOrEmpty(outputFile)) return;
|
||||
@@ -113,6 +121,11 @@ namespace DiscImageChef.Core.Logging
|
||||
logSw.Flush();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Adds a new line to the dump log
|
||||
/// </summary>
|
||||
/// <param name="format">Format string</param>
|
||||
/// <param name="args">Arguments</param>
|
||||
public void WriteLine(string format, params object[] args)
|
||||
{
|
||||
if(logSw == null) return;
|
||||
@@ -122,6 +135,9 @@ namespace DiscImageChef.Core.Logging
|
||||
logSw.Flush();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Finishes and closes the dump log
|
||||
/// </summary>
|
||||
public void Close()
|
||||
{
|
||||
logSw?.WriteLine("######################################################");
|
||||
|
||||
Reference in New Issue
Block a user