Sandcastle documentation added

Documentation/sandcastle-build-project.shfbproj

@@ -0,0 +1,56 @@
+<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="3.5">
+  <PropertyGroup>
+    <!-- The configuration and platform will be used to determine which
+         assemblies to include from solution and project documentation
+         sources -->
+    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
+    <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
+    <SchemaVersion>2.0</SchemaVersion>
+    <ProjectGuid>{8d1f9f4d-b742-4ee7-ac23-4b0774db3f34}</ProjectGuid>
+    <SHFBSchemaVersion>1.9.0.0</SHFBSchemaVersion>
+    <!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual
+         Studio adds them anyway -->
+    <AssemblyName>Documentation</AssemblyName>
+    <RootNamespace>Documentation</RootNamespace>
+    <Name>Documentation</Name>
+    <!-- SHFB properties -->
+    <OutputPath>.\Help\</OutputPath>
+    <HtmlHelpName>Documentation</HtmlHelpName>
+    <Language>en-US</Language>
+    <DocumentationSources>
+      <DocumentationSource sourceFile="..\Lidgren.Network\Lidgren.Network.csproj" />
+    </DocumentationSources>
+    <HelpTitle>Lidgren Network Library documentation</HelpTitle>
+    <BuildLogFile>
+    </BuildLogFile>
+    <HtmlHelp1xCompilerPath>
+    </HtmlHelp1xCompilerPath>
+    <HtmlHelp2xCompilerPath>
+    </HtmlHelp2xCompilerPath>
+    <SandcastlePath>
+    </SandcastlePath>
+    <WorkingPath>
+    </WorkingPath>
+  </PropertyGroup>
+  <!-- There are no properties for these groups.  AnyCPU needs to appear in
+       order for Visual Studio to perform the build.  The others are optional
+       common platform types that may appear. -->
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' ">
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x64' ">
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|Win32' ">
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|Win32' ">
+  </PropertyGroup>
+  <!-- Import the SHFB build targets -->
+  <Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" />
+</Project>

Lidgren.Network/Lidgren.Network.csproj

@@ -29,6 +29,7 @@
     <DefineConstants>DEBUG;TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Debug\Lidgren.Network.XML</DocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>

Lidgren.Network/NetConnectionStatus.cs

@@ -27,12 +27,29 @@ namespace Lidgren.Network
 	{
 		None,
 		
-		InitiatedConnect, // we sent Connect
+		/// <summary>
+		/// Connect has been sent; waiting for ConnectResponse
+		/// </summary>
+		InitiatedConnect,
+
+		/// <summary>
+		/// Connect was received and ConnectResponse has been sent; waiting for ConnectionEstablished
+		/// </summary>
 		RespondedConnect, // we got Connect, sent ConnectResponse
-		
+
+		/// <summary>
+		/// Connected
+		/// </summary>
 		Connected,		  // we received ConnectResponse (if initiator) or ConnectionEstablished (if passive)
 
+		/// <summary>
+		/// In the process of disconnecting
+		/// </summary>
 		Disconnecting,
+
+		/// <summary>
+		/// Disconnected
+		/// </summary>
 		Disconnected
 	}
 }

Lidgren.Network/NetPeer.MessagePools.cs

@@ -75,7 +75,6 @@ namespace Lidgren.Network
 		/// <summary>
 		/// Creates a new message for sending
 		/// </summary>
-		/// <param name="initialCapacity">initial capacity in bytes</param>
 		public NetOutgoingMessage CreateMessage()
 		{
 			return CreateMessage(m_configuration.m_defaultOutgoingMessageCapacity);
@@ -84,7 +83,6 @@ namespace Lidgren.Network
 		/// <summary>
 		/// Creates a new message for sending and writes the provided string to it
 		/// </summary>
-		/// <param name="initialCapacity">initial capacity in bytes</param>
 		public NetOutgoingMessage CreateMessage(string content)
 		{
 			byte[] bytes = Encoding.UTF8.GetBytes(content);