Added missing XML documentation tags and created a Sandcastle project.

csdahlberg · Apr 29, 2015 · c8cc792 · c8cc792
1 parent 32031f4
commit c8cc792
Show file tree

Hide file tree

Showing 7 changed files with 110 additions and 61 deletions.
diff --git a/CodeTiger.Core/CodeTiger.Core.csproj b/CodeTiger.Core/CodeTiger.Core.csproj
@@ -83,7 +83,6 @@
       <Link>CodeTigerLib.snk</Link>
     </None>
   </ItemGroup>
-  <ItemGroup />
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
        Other similar extension points exist, see Microsoft.Common.targets.

diff --git a/CodeTiger.Core/PackedInt16.cs b/CodeTiger.Core/PackedInt16.cs
@@ -71,6 +71,7 @@ public PackedInt16(byte[] values)
         /// <summary>
         /// Gets the individual <see cref="Byte"/> values that make up this 16-bit value.
         /// </summary>
+        /// <returns>The individual <see cref="Byte"/> values that make up this 16-bit value.</returns>
         public byte[] GetByteValues()
         {
             // Make a local copy of _value to avoid threading issues due to multiple reads.

diff --git a/CodeTiger.Core/PackedInt32.cs b/CodeTiger.Core/PackedInt32.cs
@@ -87,6 +87,7 @@ public PackedInt32(byte[] values)
         /// <summary>
         /// Gets the individual <see cref="Int16"/> values that make up this 32-bit value.
         /// </summary>
+        /// <returns>The individual <see cref="Int16"/> values that make up this 32-bit value.</returns>
         public short[] GetInt16Values()
         {
             // Make a local copy of _value to avoid threading issues due to multiple reads.
@@ -98,6 +99,7 @@ public short[] GetInt16Values()
         /// <summary>
         /// Gets the individual <see cref="Byte"/> values that make up this 32-bit value.
         /// </summary>
+        /// <returns>The individual <see cref="Byte"/> values that make up this 32-bit value.</returns>
         public byte[] GetByteValues()
         {
             // Make a local copy of _value to avoid threading issues due to multiple reads.

diff --git a/CodeTiger.Core/PackedInt64.cs b/CodeTiger.Core/PackedInt64.cs
@@ -107,6 +107,7 @@ public PackedInt64(byte[] values)
         /// <summary>
         /// Gets the individual <see cref="Int32"/> values that make up this 64-bit value.
         /// </summary>
+        /// <returns>The individual <see cref="Int32"/> values that make up this 64-bit value.</returns>
         public int[] GetInt32Values()
         {
             // Make a local copy of _value to avoid threading issues due to multiple reads.
@@ -118,6 +119,7 @@ public int[] GetInt32Values()
         /// <summary>
         /// Gets the individual <see cref="Int16"/> values that make up this 64-bit value.
         /// </summary>
+        /// <returns>The individual <see cref="Int16"/> values that make up this 64-bit value.</returns>
         public short[] GetInt16Values()
         {
             // Make a local copy of _value to avoid threading issues due to multiple reads.
@@ -135,6 +137,7 @@ public short[] GetInt16Values()
         /// <summary>
         /// Gets the individual <see cref="Byte"/> values that make up this 64-bit value.
         /// </summary>
+        /// <returns>The individual <see cref="Byte"/> values that make up this 64-bit value.</returns>
         public byte[] GetByteValues()
         {
             // Make a local copy of _value to avoid threading issues due to multiple reads.

diff --git a/CodeTiger.Core/Recurrence.cs b/CodeTiger.Core/Recurrence.cs
diff --git a/CodeTiger.Core/Threading/Tasks/TaskExtensions.cs b/CodeTiger.Core/Threading/Tasks/TaskExtensions.cs
@@ -55,6 +55,7 @@ public static Task WithTimeout(this Task task, TimeSpan timeout)
         /// <see cref="TimeoutException"/> if the original <see cref="Task{TResult}"/> takes longer than a
         /// specified number of milliseconds to complete.
         /// </summary>
+        /// <typeparam name="TResult">The type of the result produced by the task.</typeparam>
         /// <param name="task">The original task.</param>
         /// <param name="timeoutMilliseconds">The maximum number of milliseconds to wait for
         /// <paramref name="task"/> to complete.</param>
@@ -73,6 +74,7 @@ public static Task<TResult> WithTimeout<TResult>(this Task<TResult> task, int ti
         /// <see cref="TimeoutException"/> if the original <see cref="Task{TResult}"/> takes longer than a
         /// specified amount of time to complete.
         /// </summary>
+        /// <typeparam name="TResult">The type of the result produced by the task.</typeparam>
         /// <param name="task">The original task.</param>
         /// <param name="timeout">The maximum amount of time to wait for <paramref name="task"/> to complete.
         /// </param>

diff --git a/Documentation/Documentation.shfbproj b/Documentation/Documentation.shfbproj
@@ -0,0 +1,102 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="4.0">
+  <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>{79b3044e-6255-4f9c-9ad7-0c9d804021b7}</ProjectGuid>
+    <SHFBSchemaVersion>1.9.9.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 -->
+    <FrameworkVersion>.NET Framework 4.5</FrameworkVersion>
+    <OutputPath>..\Build\Documentation\</OutputPath>
+    <HtmlHelpName>CodeTigerLib</HtmlHelpName>
+    <Language>en-US</Language>
+    <BuildAssemblerVerbosity>OnlyWarningsAndErrors</BuildAssemblerVerbosity>
+    <HelpFileFormat>HtmlHelp1, Website</HelpFileFormat>
+    <IndentHtml>False</IndentHtml>
+    <KeepLogFile>True</KeepLogFile>
+    <DisableCodeBlockComponent>False</DisableCodeBlockComponent>
+    <CppCommentsFixup>False</CppCommentsFixup>
+    <CleanIntermediates>True</CleanIntermediates>
+    <MaximumGroupParts>2</MaximumGroupParts>
+    <NamespaceGrouping>False</NamespaceGrouping>
+    <SyntaxFilters>Standard</SyntaxFilters>
+    <SdkLinkTarget>Blank</SdkLinkTarget>
+    <RootNamespaceContainer>True</RootNamespaceContainer>
+    <PresentationStyle>VS2013</PresentationStyle>
+    <Preliminary>False</Preliminary>
+    <NamingMethod>MemberName</NamingMethod>
+    <HelpTitle>CodeTigerLib Documentation</HelpTitle>
+    <ContentPlacement>AboveNamespaces</ContentPlacement>
+    <DocumentationSources>
+      <DocumentationSource sourceFile="..\CodeTiger.Core\CodeTiger.Core.csproj" />
+    </DocumentationSources>
+    <NamespaceSummaries>
+      <NamespaceSummaryItem name="CodeTiger" isDocumented="True" xmlns="">The CodeTiger namespace is the base namespace for all types defined in CodeTiger libraries.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="CodeTiger.Threading" isDocumented="True" xmlns="">The CodeTiger.Threading namespace contains types related to multithreaded programming.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="CodeTiger.Threading.Tasks" isDocumented="True" xmlns="">The CodeTiger.Threading.Tasks namespace contains types related to task-based asynchronous programming.</NamespaceSummaryItem></NamespaceSummaries>
+    <MissingTags>Summary, Parameter, Returns, Namespace, TypeParameter</MissingTags>
+    <ComponentConfigurations>
+      <ComponentConfig id="API Token Resolution" enabled="True">
+        <component id="API Token Resolution">{@TokenFiles}
+<replace elements="/*//token" item="string(.)" /></component>
+      </ComponentConfig>
+<ComponentConfig id="Code Block Component" enabled="True"><component id="Code Block Component">
+  <basePath value="{@HtmlEncProjectFolder}" />
+  <outputPaths>{@HelpFormatOutputPaths}</outputPaths>
+  <allowMissingSource value="false" />
+  <removeRegionMarkers value="false" />
+  <colorizer syntaxFile="{@SHFBFolder}PresentationStyles\Colorizer\highlight.xml" styleFile="{@SHFBFolder}PresentationStyles\Colorizer\highlight.xsl" stylesheet="{@SHFBFolder}PresentationStyles\Colorizer\highlight.css" scriptFile="{@SHFBFolder}PresentationStyles\Colorizer\highlight.js" disabled="{@DisableCodeBlockComponent}" language="cs" tabSize="4" numberLines="false" outlining="false" keepSeeTags="false" defaultTitle="true" />
+</component></ComponentConfig>
+<ComponentConfig id="Syntax Component" enabled="True"><component id="Syntax Component">
+  <syntax input="/document/reference" output="/document/syntax" renderReferenceLinks="false" />
+  <generators>
+    {@SyntaxFilters}
+</generators>
+  <containerElement name="codeSnippetGroup" addNoExampleTabs="true" includeOnSingleSnippets="false" groupingEnabled="{@CodeSnippetGrouping}" />
+  <configurations>
+    <generator id="C#" />
+    <generator id="Visual Basic">
+      <includeLineContinuation value="false" />
+    </generator>
+    <generator id="Visual Basic Usage">
+      <includeLineContinuation value="false" />
+    </generator>
+    <generator id="Managed C++" />
+    <generator id="F#" />
+    <generator id="J#" />
+    <generator id="JScript" />
+    <generator id="JavaScript" />
+    <generator id="XAML Usage" />
+    <generator id="ASP.NET" />
+  </configurations>
+</component></ComponentConfig></ComponentConfigurations>
+    <VisibleItems>Attributes, ExplicitInterfaceImplementations, InheritedMembers, InheritedFrameworkMembers, Protected, ProtectedInternalAsProtected</VisibleItems>
+  </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>