diff options
author | Rob Mensching <rob@firegiant.com> | 2021-04-20 02:23:52 -0700 |
---|---|---|
committer | Rob Mensching <rob@firegiant.com> | 2021-04-20 02:25:48 -0700 |
commit | 54d6c752a1dfbe70c0eb59241c74c89b9ca93290 (patch) | |
tree | e94c48e2e2f2ff8e55066f7c2d1fc7be9aba553b | |
parent | f304c5eb86a1493139ec86eddd808f8ca53adf9d (diff) | |
download | wix-54d6c752a1dfbe70c0eb59241c74c89b9ca93290.tar.gz wix-54d6c752a1dfbe70c0eb59241c74c89b9ca93290.tar.bz2 wix-54d6c752a1dfbe70c0eb59241c74c89b9ca93290.zip |
Improve documentation
-rw-r--r-- | src/WixToolset.Extensibility/IMessageListener.cs | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/src/WixToolset.Extensibility/IMessageListener.cs b/src/WixToolset.Extensibility/IMessageListener.cs index ea103538..a04e9c98 100644 --- a/src/WixToolset.Extensibility/IMessageListener.cs +++ b/src/WixToolset.Extensibility/IMessageListener.cs | |||
@@ -5,13 +5,30 @@ namespace WixToolset.Extensibility | |||
5 | using WixToolset.Data; | 5 | using WixToolset.Data; |
6 | using WixToolset.Extensibility.Services; | 6 | using WixToolset.Extensibility.Services; |
7 | 7 | ||
8 | #pragma warning disable 1591 // TODO: add documentation | 8 | /// <summary> |
9 | /// Message listener. | ||
10 | /// </summary> | ||
9 | public interface IMessageListener | 11 | public interface IMessageListener |
10 | { | 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> | ||
11 | MessageLevel CalculateMessageLevel(IMessaging messaging, Message message, MessageLevel defaultMessageLevel); | 20 | MessageLevel CalculateMessageLevel(IMessaging messaging, Message message, MessageLevel defaultMessageLevel); |
12 | 21 | ||
22 | /// <summary> | ||
23 | /// Writes a message. | ||
24 | /// </summary> | ||
25 | /// <param name="message">Message to write.</param> | ||
13 | void Write(Message message); | 26 | void Write(Message message); |
14 | 27 | ||
28 | /// <summary> | ||
29 | /// Writes a string message. | ||
30 | /// </summary> | ||
31 | /// <param name="message">String message to write.</param> | ||
15 | void Write(string message); | 32 | void Write(string message); |
16 | } | 33 | } |
17 | } | 34 | } |