Merge pull request #7 from StuffOfInterest/feature-intellisense

Patch Intellisense
StuffOfInterest · May 2, 2021 · 851e747 · 851e747
2 parents 243058a + 1f22733
commit 851e747
Show file tree

Hide file tree

Showing 14 changed files with 68 additions and 1 deletion.
diff --git a/LogicTagHelpers/CaseTagHelper.cs b/LogicTagHelpers/CaseTagHelper.cs
@@ -9,8 +9,15 @@ namespace LogicTagHelpers
 	[HtmlTargetElement("case", ParentTag = "switch")]
 	public class CaseTagHelper : TagHelper
 	{
+		/// <summary>
+		/// Value to compare to the 'switch' statement expression.
+		/// Block only included when matched.
+		/// </summary>
 		public object Value { get; set; }
 
+		/// <summary>
+		/// Internal tag helper processing.
+		/// </summary>
 		public override async Task ProcessAsync(TagHelperContext context, TagHelperOutput output)
 		{
 			var switchContext = (SwitchContext) context.Items[SwitchContext.ContextKey];

diff --git a/LogicTagHelpers/DefaultTagHelper.cs b/LogicTagHelpers/DefaultTagHelper.cs
@@ -9,6 +9,9 @@ namespace LogicTagHelpers
 	[HtmlTargetElement("default", ParentTag = "switch")]
 	public class DefaultTagHelper : TagHelper
 	{
+		/// <summary>
+		/// Internal tag helper processing.
+		/// </summary>
 		public override async Task ProcessAsync(TagHelperContext context, TagHelperOutput output)
 		{
 			var switchContext = (SwitchContext) context.Items[SwitchContext.ContextKey];

diff --git a/LogicTagHelpers/DoTagHelper.cs b/LogicTagHelpers/DoTagHelper.cs
@@ -15,6 +15,9 @@ public class DoTagHelper : TagHelper
 		/// </summary>
 		public Func<bool> Condition { get; set; }
 
+		/// <summary>
+		/// Internal tag helper processing.
+		/// </summary>
 		public override async Task ProcessAsync(TagHelperContext context, TagHelperOutput output)
 		{
 			if (Condition == null)

diff --git a/LogicTagHelpers/ElseTagHelper.cs b/LogicTagHelpers/ElseTagHelper.cs
@@ -9,6 +9,9 @@ namespace LogicTagHelpers
 	[HtmlTargetElement("else", ParentTag = "if")]
 	public class ElseTagHelper : TagHelper
 	{
+		/// <summary>
+		/// Internal tag helper processing.
+		/// </summary>
 		public override async Task ProcessAsync(TagHelperContext context, TagHelperOutput output)
 		{
 			var ifContext = (IfContext) context.Items[IfContext.ContextKey];

diff --git a/LogicTagHelpers/ForTagHelper.cs b/LogicTagHelpers/ForTagHelper.cs
@@ -25,6 +25,9 @@ public class ForTagHelper : TagHelper
 		/// </summary>
 		public Action Update { get; set; }
 
+		/// <summary>
+		/// Internal tag helper processing.
+		/// </summary>
 		public override async Task ProcessAsync(TagHelperContext context, TagHelperOutput output)
 		{
 			if (Condition == null)

diff --git a/LogicTagHelpers/ForeachContext.cs b/LogicTagHelpers/ForeachContext.cs
@@ -8,20 +8,40 @@ namespace LogicTagHelpers
 	/// <typeparam name="T">Type of object to iterate over.</typeparam>
 	public class ForeachContext<T> : IForeachContext
 	{
+		/// <summary>
+		/// Create empty iterator context.
+		/// Exception will be thrown if context is used without having the collection property set.
+		/// </summary>
 		public ForeachContext()
 		{
 		}
 
+		/// <summary>
+		/// Create iterator context with collection to iterate across.
+		/// </summary>
+		/// <param name="items">Type of object used in collection.  Also used for type of item property.</param>
 		public ForeachContext(IEnumerable<T> items)
 		{
 			Collection = items;
 		}
 
 		private IEnumerator<T> _enumerator;
 
+		/// <summary>
+		/// Collection of objects to iterate over using 'foreach' loop.
+		/// </summary>
 		public IEnumerable<T> Collection { get; set; }
+
+		/// <summary>
+		/// Single item to present to inner content of 'foreach' loop.
+		/// </summary>
 		public T Item { get; set; }
 
+		/// <summary>
+		/// Loads next item into item property.
+		/// Not intended for direct use.
+		/// </summary>
+		/// <returns>Boolean indicating if another item is available.</returns>
 		public bool LoadNext()
 		{
 			var enumerator = _enumerator ??= Collection.GetEnumerator();

diff --git a/LogicTagHelpers/ForeachTagHelper.cs b/LogicTagHelpers/ForeachTagHelper.cs
@@ -15,6 +15,9 @@ public class ForeachTagHelper : TagHelper
 		/// </summary>
 		public IForeachContext Iterator { get; set; }
 
+		/// <summary>
+		/// Internal tag helper processing.
+		/// </summary>
 		public override async Task ProcessAsync(TagHelperContext context, TagHelperOutput output)
 		{
 			if (Iterator == null)

diff --git a/LogicTagHelpers/IForeachContext.cs b/LogicTagHelpers/IForeachContext.cs
@@ -6,6 +6,11 @@
 	/// </summary>
 	public interface IForeachContext
 	{
+		/// <summary>
+		/// Loads next item into item property.
+		/// Not intended for direct use.
+		/// </summary>
+		/// <returns>Boolean indicating if another item is available.</returns>
 		bool LoadNext();
 	}
 }
diff --git a/LogicTagHelpers/IfTagHelper.cs b/LogicTagHelpers/IfTagHelper.cs
@@ -20,6 +20,9 @@ public class IfTagHelper : TagHelper
 		/// </summary>
 		public bool Direct { get; set; }
 
+		/// <summary>
+		/// Internal tag helper processing.
+		/// </summary>
 		public override async Task ProcessAsync(TagHelperContext context, TagHelperOutput output)
 		{
 			output.TagName = null;

diff --git a/LogicTagHelpers/LogicTagHelperException.cs b/LogicTagHelpers/LogicTagHelperException.cs
@@ -7,10 +7,17 @@ namespace LogicTagHelpers
 	/// </summary>
 	public class LogicTagHelperException : Exception
 	{
+		/// <summary>
+		/// Create empty exception instance.
+		/// </summary>
 		public LogicTagHelperException()
 		{
 		}
 
+		/// <summary>
+		/// Create instance of exception with message.
+		/// </summary>
+		/// <param name="message">Message indicating reason for exception.</param>
 		public LogicTagHelperException(string message) : base(message)
 		{
 		}

diff --git a/LogicTagHelpers/LogicTagHelpers.csproj b/LogicTagHelpers/LogicTagHelpers.csproj
@@ -3,7 +3,7 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-    <Version>1.0.0</Version>
+    <Version>1.0.1</Version>
     <Authors>Delbert Matlock</Authors>
     <Company>Stuff Of Interest</Company>
     <Product />
@@ -19,6 +19,7 @@
     <RepositoryUrl>https://github.com/StuffOfInterest/LogicTagHelpers</RepositoryUrl>
     <LangVersion>8</LangVersion>
     <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/LogicTagHelpers/SwitchTagHelper.cs b/LogicTagHelpers/SwitchTagHelper.cs
@@ -15,6 +15,9 @@ public class SwitchTagHelper : TagHelper
 		/// </summary>
 		public object Expression { get; set; }
 
+		/// <summary>
+		/// Internal tag helper processing.
+		/// </summary>
 		public override async Task ProcessAsync(TagHelperContext context, TagHelperOutput output)
 		{
 			output.TagName = null;

diff --git a/LogicTagHelpers/ThenTagHelper.cs b/LogicTagHelpers/ThenTagHelper.cs
@@ -9,6 +9,9 @@ namespace LogicTagHelpers
 	[HtmlTargetElement("then", ParentTag = "if")]
 	public class ThenTagHelper : TagHelper
 	{
+		/// <summary>
+		/// Internal tag helper processing.
+		/// </summary>
 		public override async Task ProcessAsync(TagHelperContext context, TagHelperOutput output)
 		{
 			var ifContext = (IfContext) context.Items[IfContext.ContextKey];

diff --git a/LogicTagHelpers/WhileTagHelper.cs b/LogicTagHelpers/WhileTagHelper.cs
@@ -15,6 +15,9 @@ public class WhileTagHelper : TagHelper
 		/// </summary>
 		public Func<bool> Condition { get; set; }
 
+		/// <summary>
+		/// Internal tag helper processing.
+		/// </summary>
 		public override async Task ProcessAsync(TagHelperContext context, TagHelperOutput output)
 		{
 			if (Condition == null)