Skip to content

Commit 885d31b

Browse files
author
dragonfly91
committed
[RS Backup] Fixing 7349803 (documentation fixes) for some files in Logger Layer
1 parent 7b238d3 commit 885d31b

File tree

1 file changed

+27
-0
lines changed
  • src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Logger

1 file changed

+27
-0
lines changed

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Logger/Logger.cs

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@
2121

2222
namespace Microsoft.Azure.Commands.RecoveryServices.Backup
2323
{
24+
/// <summary>
25+
/// Utility for logging. Uses PS logging underneath.
26+
/// Plan to add more functionality in the upcoming releases.
27+
/// </summary>
2428
public class Logger
2529
{
2630
private Action<string> writeWarningAction;
@@ -33,6 +37,13 @@ public class Logger
3337

3438
public static Logger Instance { get; set; }
3539

40+
/// <summary>
41+
/// Constructor. Takes the delegates for the various logging operations as input.
42+
/// </summary>
43+
/// <param name="writeWarning">Delegate to write warnings</param>
44+
/// <param name="writeDebug">Delegate to write debug messages</param>
45+
/// <param name="writeVerbose">Delegate to write verbose messages</param>
46+
/// <param name="throwTerminatingError">Delegate to throw terminating errors</param>
3647
public Logger(Action<string> writeWarning,
3748
Action<string> writeDebug,
3849
Action<string> writeVerbose,
@@ -44,21 +55,37 @@ public Logger(Action<string> writeWarning,
4455
throwTerminatingErrorAction = throwTerminatingError;
4556
}
4657

58+
/// <summary>
59+
/// Writes verbose message.
60+
/// </summary>
61+
/// <param name="text"></param>
4762
public void WriteVerbose(string text)
4863
{
4964
writeVerboseAction(text);
5065
}
5166

67+
/// <summary>
68+
/// Writes debug message.
69+
/// </summary>
70+
/// <param name="text"></param>
5271
public void WriteDebug(string text)
5372
{
5473
writeDebugAction(text);
5574
}
5675

76+
/// <summary>
77+
/// Writes warning message.
78+
/// </summary>
79+
/// <param name="text"></param>
5780
public void WriteWarning(string text)
5881
{
5982
writeWarningAction(text);
6083
}
6184

85+
/// <summary>
86+
/// Throws a terminating error.
87+
/// </summary>
88+
/// <param name="errorRecord"></param>
6289
public void ThrowTerminatingError(ErrorRecord errorRecord)
6390
{
6491
throwTerminatingErrorAction(errorRecord);

0 commit comments

Comments
 (0)