Commit: 9efa49f118d8d8f97e2ef9bf6b9abeaf8bbcae6a - UserStreamEx (git)

LINQ To TwitterのUserStreamをもっと使いやすくしようとか妄想してるプロジェクト

Commit MetaInfo

• Revision: 9efa49f118d8d8f97e2ef9bf6b9abeaf8bbcae6a (tree)
• Zeit: 2011-02-09 20:29:48
• Autor: azyobuzin <azyobuzin@user...>
• Commiter: azyobuzin

Log Message

XMLコメントをつけた

Ändern Zusammenfassung

• modified: UserStreamEx/EventArgs.cs
• modified: UserStreamEx/Extensions.cs
• modified: UserStreamEx/Interfaces.cs
• modified: UserStreamEx/Readme.txt
• modified: UserStreamEx/UserStreamEx.cs
• modified: UserStreamEx/UserStreamEx.csproj

Diff

--- a/UserStreamEx/EventArgs.cs
+++ b/UserStreamEx/EventArgs.cs
@@ -6,22 +6,40 @@ using LinqToTwitter;
 
 namespace Azyobuzi.UserStreamEx
 {
+    /// <summary>
+    /// <see cref="UserStream.Stopped"/>イベントのデータを提供します。
+    /// </summary>
     public class StoppedEventArgs : EventArgs
     {
+        /// <summary>
+        /// 新しい<see cref="StoppedEventArgs"/>クラスのインスタンスを初期化します。
+        /// </summary>
+        /// <param name="reason">切断された理由</param>
+        /// <param name="ex">発生したエラー。null可。</param>
         public StoppedEventArgs(StopReason reason, Exception ex)
         {
             this.Reason = reason;
             this.Exception = ex;
         }
 
+        /// <summary>
+        /// 切断された理由
+        /// </summary>
         public StopReason Reason { private set; get; }
+
+        /// <summary>
+        /// 発生したエラー。<see cref="Reason"/>が<see cref="StopReason.CloseResponse"/>の場合はnull参照です。
+        /// </summary>
         public Exception Exception { private set; get; }
     }
 
+    /// <summary>
+    /// 切断された理由
+    /// </summary>
     public enum StopReason
     {
         /// <summary>
-        /// Twitterが切断
+        /// Twitterが切断した
         /// </summary>
         CloseResponse,
         /// <summary>
@@ -29,45 +47,82 @@ namespace Azyobuzi.UserStreamEx
         /// </summary>
         UserStop,
         /// <summary>
-        /// その他の例外
+        /// 例外が発生した
         /// </summary>
         Error
     }
 
+    /// <summary>
+    /// Twitterから受信したJSONデータを提供します。
+    /// </summary>
     public class ReceiveJsonEventArgs : EventArgs
     {
+        /// <summary>
+        /// <see cref="ReceiveJsonEventArgs"/>クラスのインスタンスを初期化します。
+        /// </summary>
+        /// <param name="line">1行のJSON形式のデータ</param>
         public ReceiveJsonEventArgs(string line)
         {
             this.Line = line;
         }
 
+        /// <summary>
+        /// 1行のJSON形式のデータ
+        /// </summary>
         public string Line { private set; get; }
     }
 
+    /// <summary>
+    /// <see cref="UserStream.ReceiveFriends"/>イベントのデータを提供します。
+    /// </summary>
     public class ReceiveFriendsEventArgs : ReceiveJsonEventArgs
     {
+        /// <summary>
+        /// JSONを指定して<see cref="ReceiveFriendsEventArgs"/>クラスのインスタンスを初期化します。
+        /// </summary>
+        /// <param name="line">friendsリストが含まれたJSON形式のデータ</param>
         public ReceiveFriendsEventArgs(string line)
             : base(line)
         {
             FriendIds = (string[])DynamicJson.Parse(line).friends;
         }
 
+        /// <summary>
+        /// friends(following)のIDリスト
+        /// </summary>
         public string[] FriendIds { private set; get; }
     }
 
+    /// <summary>
+    /// <see cref="UserStream.NewTweet"/>イベントのデータを提供します。
+    /// </summary>
     public class NewTweetEventArgs : ReceiveJsonEventArgs
     {
+        /// <summary>
+        /// JSONを指定して<see cref="NewTweetEventArgs"/>クラスのインスタンスを初期化します。
+        /// </summary>
+        /// <param name="line">ステータスが含まれたJSON形式のデータ</param>
         public NewTweetEventArgs(string line)
             : base(line)
         {
             Status = Status.CreateStatus(line.JsonToXml());
         }
 
+        /// <summary>
+        /// 新しいツイート
+        /// </summary>
         public Status Status { private set; get; }
     }
 
+    /// <summary>
+    /// <see cref="UserStream.NewDirectMessage"/>イベントのデータを提供します。
+    /// </summary>
     public class NewDirectMessageEventArgs : ReceiveJsonEventArgs
     {
+        /// <summary>
+        /// JSONを指定して<see cref="NewDirectMessageEventArgs"/>クラスのインスタンスを初期化します。
+        /// </summary>
+        /// <param name="line">ダイレクトメッセージが含まれたJSON形式のデータ</param>
         public NewDirectMessageEventArgs(string line)
             : base(line)
         {
@@ -86,11 +141,21 @@ namespace Azyobuzi.UserStreamEx
             };
         }
 
+        /// <summary>
+        /// 新しいダイレクトメッセージ
+        /// </summary>
         public DirectMessage DirectMessage { private set; get; }
     }
 
+    /// <summary>
+    /// <see cref="UserStream.DeleteStatus"/>イベントのデータを提供します。
+    /// </summary>
     public class DeleteStatusEventArgs : ReceiveJsonEventArgs
     {
+        /// <summary>
+        /// JSONを指定して<see cref="DeleteStatusEventArgs"/>クラスのインスタンスを初期化します。
+        /// </summary>
+        /// <param name="line">削除されたステータスのIDが含まれたJSON形式のデータ</param>
         public DeleteStatusEventArgs(string line)
             : base(line)
         {
@@ -111,13 +176,31 @@ namespace Azyobuzi.UserStreamEx
             }
         }
 
+        /// <summary>
+        /// 削除されたツイート（ダイレクトメッセージ）のID
+        /// </summary>
         public string StatusId { private set; get; }
+
+        /// <summary>
+        /// 削除したユーザーのID（番号）
+        /// </summary>
         public string UserId { private set; get; }
+
+        /// <summary>
+        /// ダイレクトメッセージか
+        /// </summary>
         public bool IsDirectMessage { private set; get; }
     }
 
+    /// <summary>
+    /// <see cref="UserStream.ReceiveEvent"/>イベントのデータを提供します。
+    /// </summary>
     public class ReceiveEventEventArgs : ReceiveJsonEventArgs
     {
+        /// <summary>
+        /// JSONを指定して<see cref="ReceiveEventEventArgs"/>クラスのインスタンスを初期化します。
+        /// </summary>
+        /// <param name="line">イベント情報が含まれたJSON形式のデータ</param>
         public ReceiveEventEventArgs(string line)
             : base(line)
         {
@@ -143,37 +226,101 @@ namespace Azyobuzi.UserStreamEx
             }
         }
 
+        /// <summary>
+        /// イベントの種類
+        /// </summary>
         public EventTypes EventType { private set; get; }
+        /// <summary>
+        /// イベントが発生した日時
+        /// </summary>
         public DateTime CreatedAt { private set; get; }
+        /// <summary>
+        /// イベントを発生させたユーザー
+        /// </summary>
         public User Source { private set; get; }
+        /// <summary>
+        /// イベントの対象のユーザー
+        /// </summary>
         public User Target { private set; get; }
+        /// <summary>
+        /// イベントの対象のツイート
+        /// </summary>
         public Status TargetStatus { private set; get; }
+        /// <summary>
+        /// イベントの対象のリスト
+        /// </summary>
         public List TargetList { private set; get; }
     }
 
+    /// <summary>
+    /// イベントの種類
+    /// </summary>
     public enum EventTypes
     {
+        /// <summary>
+        /// 不明
+        /// </summary>
         Unknown,
+        /// <summary>
+        /// お気に入りに追加した
+        /// </summary>
         Favorite,
+        /// <summary>
+        /// お気に入りから削除した
+        /// </summary>
         Unfavorite,
+        /// <summary>
+        /// フォローされた
+        /// </summary>
         Follow,
+        /// <summary>
+        /// リストに入れられた
+        /// </summary>
         ListMemberAdded,
+        /// <summary>
+        /// リストから外された
+        /// </summary>
         ListMemberRemoved,
+        /// <summary>
+        /// ブロックに成功した
+        /// </summary>
         Block,
+        /// <summary>
+        /// ブロックの解除に成功した
+        /// </summary>
         Unblock,
+        /// <summary>
+        /// プロフィールを変更した
+        /// </summary>
         UserUpdate,
+        /// <summary>
+        /// リストを作成した
+        /// </summary>
         ListCreated,
+        /// <summary>
+        /// リストを削除した
+        /// </summary>
         ListDestroyed
     }
 
+    /// <summary>
+    /// <see cref="UserStream.TrackLimit"/>イベントのデータを提供します。
+    /// </summary>
     public class TrackLimitEventArgs : ReceiveJsonEventArgs
     {
+        /// <summary>
+        /// JSONを指定して<see cref="TrackLimitEventArgs"/>クラスのインスタンスを初期化します。
+        /// </summary>
+        /// <param name="line">JSON形式のデータ</param>
         public TrackLimitEventArgs(string line)
             : base(line)
         {
             Track = (ulong)DynamicJson.Parse(line).limit.track;
         }
 
+        /// <summary>
+        /// マッチしたツイートのインデックス
+        /// </summary>
         public ulong Track { private set; get; }
     }
 }

--- a/UserStreamEx/Extensions.cs
+++ b/UserStreamEx/Extensions.cs
@@ -6,8 +6,15 @@ using LinqToTwitter;
 
 namespace Azyobuzi.UserStreamEx
 {
+    /// <summary>
+    /// LINQ to Twitterへの拡張
+    /// </summary>
     public static class AddToLinqToTwitter
     {
+        /// <summary>
+        /// <see cref="LinqToTwitter.TwitterContext"/>から<see cref="Azyobuzi.UserStreamEx.UserStream"/>のインスタンスを作成します。
+        /// </summary>
+        /// <param name="twCtx">認証済みの<see cref="LinqToTwitter.TwitterContext"/></param>
         public static INotStartedUserStream UserStreamEx(this TwitterContext twCtx)
         {
             return new UserStream(twCtx.AuthorizedClient);
@@ -16,7 +23,7 @@ namespace Azyobuzi.UserStreamEx
 
     internal static class MyExtensions
     {
-        public static XElement JsonToXml(this string json)
+        internal static XElement JsonToXml(this string json)
         {
             using (var reader = JsonReaderWriterFactory.CreateJsonReader(Encoding.UTF8.GetBytes(json), XmlDictionaryReaderQuotas.Max))
             {

--- a/UserStreamEx/Interfaces.cs
+++ b/UserStreamEx/Interfaces.cs
@@ -1,39 +1,134 @@
 using System;
+using System.IO;
 
 namespace Azyobuzi.UserStreamEx
 {
+    /// <summary>
+    /// 接続されていない状態の<see cref="UserStream"/>クラスを表します。
+    /// </summary>
     public interface INotStartedUserStream
     {
+        /// <summary>
+        /// 接続を開始します。
+        /// </summary>
+        /// <param name="track">検索キーワードっぽいもの。null可。</param>
+        /// <param name="allReplies">friendsに対する返信も含めるかどうか</param>
         IStartedUserStream Start(string track, bool allReplies);
 
+        /// <summary>
+        /// 取得したデータを書き込む<see cref="System.IO.TextWriter"/>
+        /// </summary>
+        TextWriter StreamingWriter { set; get; }
+
         #region Events
+        /// <summary>
+        /// 接続を開始するときに発生します。
+        /// </summary>
         event EventHandler Started;
+        /// <summary>
+        /// 切断されたときに発生します。
+        /// </summary>
         event EventHandler<StoppedEventArgs> Stopped;
+        /// <summary>
+        /// friends(following)のID一覧を受け取ったときに発生します。通常は開始直後に一回だけ発生します。
+        /// </summary>
         event EventHandler<ReceiveFriendsEventArgs> ReceiveFriends;
+        /// <summary>
+        /// 新しいツイートを受け取ったときに発生します。
+        /// </summary>
         event EventHandler<NewTweetEventArgs> NewTweet;
+        /// <summary>
+        /// 新しいダイレクトメッセージを受信・送信したときに発生します。
+        /// </summary>
         event EventHandler<NewDirectMessageEventArgs> NewDirectMessage;
+        /// <summary>
+        /// ツイートまたはダイレクトメッセージが削除されたときに発生します。ハンドラでは直ちに表示から消すような処理をしてください。
+        /// </summary>
         event EventHandler<DeleteStatusEventArgs> DeleteStatus;
+        /// <summary>
+        /// イベントを受信したときに発生します。
+        /// </summary>
         event EventHandler<ReceiveEventEventArgs> ReceiveEvent;
+        /// <summary>
+        /// Twitter側で処理しきれないツイートがあったときに発生します。
+        /// </summary>
+        /// <remarks>詳細不明</remarks>
         event EventHandler<TrackLimitEventArgs> TrackLimit;
+        /// <summary>
+        /// 対応していないデータを受け取ったときに発生します。
+        /// </summary>
         event EventHandler<ReceiveJsonEventArgs> ReceiveUnsupportedData;
         #endregion
 
         #region AddHandlerMethod
+        /// <summary>
+        /// <see cref="Started"/>イベントにイベントハンドラを追加します。
+        /// </summary>
+        /// <param name="handler">イベントハンドラ</param>
         INotStartedUserStream SetStartedEvent(EventHandler handler);
+        /// <summary>
+        /// <see cref="Stopped"/>イベントにイベントハンドラを追加します。
+        /// </summary>
+        /// <param name="handler">イベントハンドラ</param>
         INotStartedUserStream SetStoppedEvent(EventHandler<StoppedEventArgs> handler);
+        /// <summary>
+        /// <see cref="ReceiveFriends"/>イベントにイベントハンドラを追加します。
+        /// </summary>
+        /// <param name="handler">イベントハンドラ</param>
         INotStartedUserStream SetReceiveFriendsEvent(EventHandler<ReceiveFriendsEventArgs> handler);
+        /// <summary>
+        /// <see cref="NewTweet"/>イベントにイベントハンドラを追加します。
+        /// </summary>
+        /// <param name="handler">イベントハンドラ</param>
         INotStartedUserStream SetNewTweetEvent(EventHandler<NewTweetEventArgs> handler);
+        /// <summary>
+        /// <see cref="NewDirectMessage"/>イベントにイベントハンドラを追加します。
+        /// </summary>
+        /// <param name="handler">イベントハンドラ</param>
         INotStartedUserStream SetNewDirectMessageEvent(EventHandler<NewDirectMessageEventArgs> handler);
+        /// <summary>
+        /// <see cref="DeleteStatus"/>イベントにイベントハンドラを追加します。
+        /// </summary>
+        /// <param name="handler">イベントハンドラ</param>
         INotStartedUserStream SetDeleteStatusEvent(EventHandler<DeleteStatusEventArgs> handler);
+        /// <summary>
+        /// <see cref="ReceiveEvent"/>イベントにイベントハンドラを追加します。
+        /// </summary>
+        /// <param name="handler">イベントハンドラ</param>
         INotStartedUserStream SetReceiveEventEvent(EventHandler<ReceiveEventEventArgs> handler);
+        /// <summary>
+        /// <see cref="TrackLimit"/>イベントにイベントハンドラを追加します。
+        /// </summary>
+        /// <param name="handler">イベントハンドラ</param>
         INotStartedUserStream SetTrackLimitEvent(EventHandler<TrackLimitEventArgs> handler);
+        /// <summary>
+        /// <see cref="ReceiveUnsupportedData"/>イベントにイベントハンドラを追加します。
+        /// </summary>
+        /// <param name="handler">イベントハンドラ</param>
         INotStartedUserStream SetReceiveUnsupportedDataEvent(EventHandler<ReceiveJsonEventArgs> handler);
         #endregion
     }
 
-    public interface IStartedUserStream
+    /// <summary>
+    /// 接続されていて、Timeoutが設定された<see cref="UserStream"/>クラスを表します。
+    /// </summary>
+    public interface ISetedTimeoutUserStream
     {
+        /// <summary>
+        /// 切断してStoppedイベントを発生させます。
+        /// </summary>
         INotStartedUserStream Stop();
-        IStartedUserStream SetTimeout(int waitTime);
+    }
+
+    /// <summary>
+    /// 接続されている状態の<see cref="UserStream"/>クラスを表します。
+    /// </summary>
+    public interface IStartedUserStream : ISetedTimeoutUserStream
+    {
+        /// <summary>
+        /// 指定した時間が経過したら切断するように設定します。
+        /// </summary>
+        /// <param name="waitTime">切断するまでの時間（ミリ秒単位）。0以下を指定するとすぐに切断します。</param>
+        ISetedTimeoutUserStream SetTimeout(int waitTime);
     }
 }

--- a/UserStreamEx/Readme.txt
+++ b/UserStreamEx/Readme.txt
@@ -21,6 +21,7 @@ LINQ to Twitter用UserStream補助ライブラリ
 		・Stopメソッドで停止したときにStoppedEventArgs.ReasonがErrorになる不具合を修正
 		・list_createdイベント発生時に例外を吐くのを修正
 		・メソッドチェーンでつなげるように改良
+		・XMLコメントを付けた
 	1.0.1 (2011/2/7)
 		・DirectMessageを受信したときに例外を吐くのを修正
 		・limitに対応

--- a/UserStreamEx/UserStreamEx.cs
+++ b/UserStreamEx/UserStreamEx.cs
@@ -9,9 +9,16 @@ using LinqToTwitter;
 
 namespace Azyobuzi.UserStreamEx
 {
+    /// <summary>
+    /// TwitterのUserStreamをイベントを使って処理します。
+    /// </summary>
     public class UserStream
         : INotStartedUserStream, IStartedUserStream
     {
+        /// <summary>
+        /// <see cref="UserStream"/>クラスの新しいインスタンスを初期化します。
+        /// </summary>
+        /// <param name="auth">認証済みの<see cref="LinqToTwitter.ITwitterAuthorizer"/></param>
         public UserStream(ITwitterAuthorizer auth)
         {
             this.auth = auth;
@@ -20,6 +27,11 @@ namespace Azyobuzi.UserStreamEx
         private ITwitterAuthorizer auth;
         private HttpWebRequest req;
 
+        /// <summary>
+        /// 接続を開始します。
+        /// </summary>
+        /// <param name="track">検索キーワードっぽいもの。null可。</param>
+        /// <param name="allReplies">friendsに対する返信も含めるかどうか</param>
         public IStartedUserStream Start(string track, bool allReplies)
         {
             if (req != null) req.Abort();
@@ -120,6 +132,9 @@ namespace Azyobuzi.UserStreamEx
             }
         }
 
+        /// <summary>
+        /// 切断してStoppedイベントを発生させます。
+        /// </summary>
         public INotStartedUserStream Stop()
         {
             if (req != null) req.Abort();
@@ -127,7 +142,11 @@ namespace Azyobuzi.UserStreamEx
             return this;
         }
 
-        public IStartedUserStream SetTimeout(int waitTime)
+        /// <summary>
+        /// 指定した時間が経過したら切断するように設定します。
+        /// </summary>
+        /// <param name="waitTime">切断するまでの時間（ミリ秒単位）。0以下を指定するとすぐに切断します。</param>
+        public ISetedTimeoutUserStream SetTimeout(int waitTime)
         {
             if (waitTime < 1)
             {
@@ -146,69 +165,136 @@ namespace Azyobuzi.UserStreamEx
             return this;
         }
 
+        /// <summary>
+        /// 取得したデータを書き込む<see cref="System.IO.TextWriter"/>
+        /// </summary>
         public TextWriter StreamingWriter { set; get; }
 
         #region Events
+        /// <summary>
+        /// 接続を開始するときに発生します。
+        /// </summary>
         public event EventHandler Started;
+        /// <summary>
+        /// 切断されたときに発生します。
+        /// </summary>
         public event EventHandler<StoppedEventArgs> Stopped;
+        /// <summary>
+        /// friends(following)のID一覧を受け取ったときに発生します。通常は開始直後に一回だけ発生します。
+        /// </summary>
         public event EventHandler<ReceiveFriendsEventArgs> ReceiveFriends;
+        /// <summary>
+        /// 新しいツイートを受け取ったときに発生します。
+        /// </summary>
         public event EventHandler<NewTweetEventArgs> NewTweet;
+        /// <summary>
+        /// 新しいダイレクトメッセージを受信・送信したときに発生します。
+        /// </summary>
         public event EventHandler<NewDirectMessageEventArgs> NewDirectMessage;
+        /// <summary>
+        /// ツイートまたはダイレクトメッセージが削除されたときに発生します。ハンドラでは直ちに表示から消すような処理をしてください。
+        /// </summary>
         public event EventHandler<DeleteStatusEventArgs> DeleteStatus;
+        /// <summary>
+        /// イベントを受信したときに発生します。
+        /// </summary>
         public event EventHandler<ReceiveEventEventArgs> ReceiveEvent;
+        /// <summary>
+        /// Twitter側で処理しきれないツイートがあったときに発生します。
+        /// </summary>
+        /// <remarks>詳細不明</remarks>
         public event EventHandler<TrackLimitEventArgs> TrackLimit;
+        /// <summary>
+        /// 対応していないデータを受け取ったときに発生します。
+        /// </summary>
         public event EventHandler<ReceiveJsonEventArgs> ReceiveUnsupportedData;
         #endregion
 
         #region AddHandlerMethod
+        /// <summary>
+        /// <see cref="Started"/>イベントにイベントハンドラを追加します。
+        /// </summary>
+        /// <param name="handler">イベントハンドラ</param>
         public INotStartedUserStream SetStartedEvent(EventHandler handler)
         {
             Started += handler;
             return this;
         }
 
+        /// <summary>
+        /// <see cref="Stopped"/>イベントにイベントハンドラを追加します。
+        /// </summary>
+        /// <param name="handler">イベントハンドラ</param>
         public INotStartedUserStream SetStoppedEvent(EventHandler<StoppedEventArgs> handler)
         {
             Stopped += handler;
             return this;
         }
 
+        /// <summary>
+        /// <see cref="ReceiveFriends"/>イベントにイベントハンドラを追加します。
+        /// </summary>
+        /// <param name="handler">イベントハンドラ</param>
         public INotStartedUserStream SetReceiveFriendsEvent(EventHandler<ReceiveFriendsEventArgs> handler)
         {
             ReceiveFriends += handler;
             return this;
         }
 
+        /// <summary>
+        /// <see cref="NewTweet"/>イベントにイベントハンドラを追加します。
+        /// </summary>
+        /// <param name="handler">イベントハンドラ</param>
         public INotStartedUserStream SetNewTweetEvent(EventHandler<NewTweetEventArgs> handler)
         {
             NewTweet += handler;
             return this;
         }
 
+        /// <summary>
+        /// <see cref="NewDirectMessage"/>イベントにイベントハンドラを追加します。
+        /// </summary>
+        /// <param name="handler">イベントハンドラ</param>
         public INotStartedUserStream SetNewDirectMessageEvent(EventHandler<NewDirectMessageEventArgs> handler)
         {
             NewDirectMessage += handler;
             return this;
         }
 
+        /// <summary>
+        /// <see cref="DeleteStatus"/>イベントにイベントハンドラを追加します。
+        /// </summary>
+        /// <param name="handler">イベントハンドラ</param>
         public INotStartedUserStream SetDeleteStatusEvent(EventHandler<DeleteStatusEventArgs> handler)
         {
             DeleteStatus += handler;
             return this;
         }
 
+        /// <summary>
+        /// <see cref="ReceiveEvent"/>イベントにイベントハンドラを追加します。
+        /// </summary>
+        /// <param name="handler">イベントハンドラ</param>
         public INotStartedUserStream SetReceiveEventEvent(EventHandler<ReceiveEventEventArgs> handler)
         {
             ReceiveEvent += handler;
             return this;
         }
 
+        /// <summary>
+        /// <see cref="TrackLimit"/>イベントにイベントハンドラを追加します。
+        /// </summary>
+        /// <param name="handler">イベントハンドラ</param>
         public INotStartedUserStream SetTrackLimitEvent(EventHandler<TrackLimitEventArgs> handler)
         {
             TrackLimit += handler;
             return this;
         }
 
+        /// <summary>
+        /// <see cref="ReceiveUnsupportedData"/>イベントにイベントハンドラを追加します。
+        /// </summary>
+        /// <param name="handler">イベントハンドラ</param>
         public INotStartedUserStream SetReceiveUnsupportedDataEvent(EventHandler<ReceiveJsonEventArgs> handler)
         {
             ReceiveUnsupportedData += handler;

--- a/UserStreamEx/UserStreamEx.csproj
+++ b/UserStreamEx/UserStreamEx.csproj
@@ -21,6 +21,7 @@
     <DefineConstants>DEBUG;TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Debug\UserStreamEx.XML</DocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>
@@ -29,6 +30,7 @@
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Release\UserStreamEx.XML</DocumentationFile>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="DynamicJson, Version=1.2.0.0, Culture=neutral, processorArchitecture=MSIL">