Improve documentation
Rob Mensching committed
Apr 20, 2021 at 02:23 UTC
54d6c752a1dfbe70c0eb59241c74c89b9ca93290
1 file changed
+18
-1
src/WixToolset.Extensibility/IMessageListener.cs
+18
-1
@@ -5,13 +5,30 @@ namespace WixToolset.Extensibility
5
using WixToolset.Data;
6
using WixToolset.Extensibility.Services;
7
8
-#pragma warning disable 1591 // TODO: add documentation
8
+ /// <summary>
9
+ /// Message listener.
10
+ /// </summary>
11
public interface IMessageListener
12
{
13
+ /// <summary>
14
+ /// Calculate a new level for a message.
15
+ /// </summary>
16
+ /// <param name="messaging">Messaging object.</param>
17
+ /// <param name="message">Message to evaluate.</param>
18
+ /// <param name="defaultMessageLevel">Current message level.</param>
19
+ /// <returns></returns>
20
MessageLevel CalculateMessageLevel(IMessaging messaging, Message message, MessageLevel defaultMessageLevel);
21
22
+ /// <summary>
23
+ /// Writes a message.
24
+ /// </summary>
25
+ /// <param name="message">Message to write.</param>
26
void Write(Message message);
27
28
+ /// <summary>
29
+ /// Writes a string message.
30
+ /// </summary>
31
+ /// <param name="message">String message to write.</param>
32
void Write(string message);
33
}
34
}