Misc: XML documentation is now generated on application build. Added …

…missing comments.
Arcidev · Mar 13, 2016 · 381269f · 381269f
1 parent 588c524
commit 381269f
Show file tree

Hide file tree

Showing 10 changed files with 27 additions and 5 deletions.
diff --git a/Arci.Networking/Arci.Networking.csproj b/Arci.Networking/Arci.Networking.csproj
@@ -31,6 +31,7 @@
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
     <Prefer32Bit>false</Prefer32Bit>
+    <DocumentationFile>bin\Release\Arci.Networking.XML</DocumentationFile>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="System" />
@@ -44,10 +45,10 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="Client.cs" />
-    <Compile Include="Data\GenericNumberMethodTemplate.cs">
+    <Compile Include="Data\ByteBufferGenericTemplate.cs">
       <AutoGen>True</AutoGen>
       <DesignTime>True</DesignTime>
-      <DependentUpon>GenericNumberMethodTemplate.tt</DependentUpon>
+      <DependentUpon>ByteBufferGenericTemplate.tt</DependentUpon>
     </Compile>
     <Compile Include="Data\Guid.cs" />
     <Compile Include="Data\ByteBuffer.cs" />
@@ -58,9 +59,9 @@
     <Compile Include="Server.cs" />
   </ItemGroup>
   <ItemGroup>
-    <Content Include="Data\GenericNumberMethodTemplate.tt">
+    <Content Include="Data\ByteBufferGenericTemplate.tt">
       <Generator>TextTemplatingFileGenerator</Generator>
-      <LastGenOutput>GenericNumberMethodTemplate.cs</LastGenOutput>
+      <LastGenOutput>ByteBufferGenericTemplate.cs</LastGenOutput>
     </Content>
   </ItemGroup>
   <ItemGroup>

diff --git a/Arci.Networking/Client.cs b/Arci.Networking/Client.cs
@@ -7,6 +7,9 @@
 
 namespace Arci.Networking
 {
+    /// <summary>
+    /// Client instance
+    /// </summary>
     public class Client : IDisposable
     {
         private TcpClient tcpClnt;

diff --git a/Arci.Networking/Data/ByteBuffer.cs b/Arci.Networking/Data/ByteBuffer.cs
@@ -3,6 +3,9 @@
 
 namespace Arci.Networking.Data
 {
+    /// <summary>
+    /// Byffer to store byte stream
+    /// </summary>
     public partial class ByteBuffer : IDisposable
     {
         private BinaryReader readData;

diff --git a/...rking/Data/GenericNumberMethodTemplate.cs → ...working/Data/ByteBufferGenericTemplate.cs b/...rking/Data/GenericNumberMethodTemplate.cs → ...working/Data/ByteBufferGenericTemplate.cs
diff --git a/...rking/Data/GenericNumberMethodTemplate.tt → ...working/Data/ByteBufferGenericTemplate.tt b/...rking/Data/GenericNumberMethodTemplate.tt → ...working/Data/ByteBufferGenericTemplate.tt
diff --git a/Arci.Networking/Data/Guid.cs b/Arci.Networking/Data/Guid.cs
@@ -2,6 +2,9 @@
 
 namespace Arci.Networking.Data
 {
+    /// <summary>
+    /// Represents 64bit integer as 8 byte values
+    /// </summary>
     public class Guid
     {
         private byte[] byteVal;

diff --git a/Arci.Networking/Data/Packet.cs b/Arci.Networking/Data/Packet.cs
@@ -2,6 +2,9 @@
 
 namespace Arci.Networking.Data
 {
+    /// <summary>
+    /// Represents byte stream as a packet
+    /// </summary>
     public partial class Packet : ByteBuffer
     {
         /// <summary>

diff --git a/Arci.Networking/Security/AesEncryptor.cs b/Arci.Networking/Security/AesEncryptor.cs
@@ -5,6 +5,9 @@
 
 namespace Arci.Networking.Security
 {
+    /// <summary>
+    /// Aes encryptor
+    /// </summary>
     public class AesEncryptor : IDisposable
     {
         private Aes aes;
@@ -99,7 +102,7 @@ public byte[] Decrypt(string toDecrypt)
         /// <summary>
         /// Decrypts data
         /// </summary>
-        /// <param name="toDecrypt">Data to decrypt</param>
+        /// <param name="toDecode">Data to decrypt</param>
         /// <returns>Decrypted data</returns>
         public byte[] Decrypt(byte[] toDecode)
         {

diff --git a/Arci.Networking/Security/RsaEncryptor.cs b/Arci.Networking/Security/RsaEncryptor.cs
@@ -3,6 +3,9 @@
 
 namespace Arci.Networking.Security
 {
+    /// <summary>
+    /// Rsa encryptor
+    /// </summary>
     public class RsaEncryptor : IDisposable
     {
         private RSACryptoServiceProvider rsa;

diff --git a/Arci.Networking/Server.cs b/Arci.Networking/Server.cs
@@ -4,6 +4,9 @@
 
 namespace Arci.Networking
 {
+    /// <summary>
+    /// Server instance
+    /// </summary>
     public class Server : IDisposable
     {
         private TcpListener server;