Update documentation for Generate

Docs/SuperLinq.Docs/apidoc/SuperLinq.SuperEnumerable.Generate.md

@@ -0,0 +1,6 @@
+---
+uid: SuperLinq.SuperEnumerable.Generate``1(``0,System.Func{``0,``0})
+example: [*content]
+---
+The following code example demonstrates how to generate a sequence from a generator function using `Generate`.
+[!code-csharp[](SuperLinq/Generate/Generate.linq#L6-)]

Docs/SuperLinq.Docs/apidoc/SuperLinq/Generate/Generate.linq

@@ -0,0 +1,17 @@
+<Query Kind="Statements">
+  <NuGetReference>SuperLinq</NuGetReference>
+  <Namespace>SuperLinq</Namespace>
+</Query>
+
+// Generate a sequence using a generator function
+var result = SuperEnumerable
+	.Generate(1, n => n * 2)
+	.Take(10);
+
+Console.WriteLine(
+	"[" +
+	string.Join(", ", result) +
+	"]");
+
+// This code produces the following output:
+// [1, 2, 4, 8, 16, 32, 64, 128, 256, 512]

Source/SuperLinq/Generate.cs

@@ -3,25 +3,27 @@
 public static partial class SuperEnumerable
 {
 	/// <summary>
-	/// Returns a sequence of values consecutively generated by a generator function.
+	///	    Returns a sequence of values consecutively generated by a generator function.
 	/// </summary>
-	/// <typeparam name="TResult">Type of elements to generate.</typeparam>
-	/// <param name="initial">Value of first element in sequence</param>
+	/// <typeparam name="TResult">
+	///	    Type of elements to generate.
+	/// </typeparam>
+	/// <param name="initial">
+	///	    Value of first element in sequence
+	/// </param>
 	/// <param name="generator">
-	/// Generator function which takes the previous series element and uses it to generate the next element.
+	///	    Generator function which takes the previous series element and uses it to generate the next element.
 	/// </param>
-	/// <returns>A sequence containing the generated values.</returns>
-	/// <exception cref="ArgumentNullException"><paramref name="generator"/> is <see langword="null"/>.</exception>
+	/// <returns>
+	///	    A sequence containing the generated values.
+	/// </returns>
+	/// <exception cref="ArgumentNullException">
+	///	    <paramref name="generator"/> is <see langword="null"/>.
+	/// </exception>
 	/// <remarks>
-	/// This function defers element generation until needed and streams the results.
+	///	    This function defers element generation until needed and streams the results. It is treated as an
+	///	    infinite sequence, and will not terminate.
 	/// </remarks>
-	/// <example>
-	/// <code><![CDATA[
-	/// var result = SuperEnumerable.Generate(2, n => n * n).Take(5);
-	/// ]]></code>
-	/// The <c>result</c> variable, when iterated over, will yield 2, 4, 16, 256, and 65536, in turn.
-	/// </example>
-
 	public static IEnumerable<TResult> Generate<TResult>(TResult initial, Func<TResult, TResult> generator)
 	{
 		Guard.IsNotNull(generator);