Docs.

fuszenecker · Oct 12, 2023 · 200e69a · 200e69a
1 parent a37c742
commit 200e69a
Show file tree

Hide file tree

Showing 10 changed files with 20 additions and 57 deletions.
diff --git a/docs/Promptuarium/Data/AsElementAsync/README.md b/docs/Promptuarium/Data/AsElementAsync/README.md
@@ -1,4 +1,4 @@
-# Data\.AsElementAsync\(Stream\) Method
+# Data\.AsElementAsync\(Stream, Element\) Method
 
 [Home](../../../README.md)
 
@@ -10,7 +10,7 @@
 Converts a stream to a tree\.
 
 ```csharp
-public static System.Threading.Tasks.Task<Promptuarium.Element> AsElementAsync(this System.IO.Stream stream)
+public static System.Threading.Tasks.Task<Promptuarium.Element> AsElementAsync(this System.IO.Stream stream, Promptuarium.Element loaderElement = null)
 ```
 
 ### Parameters
@@ -19,6 +19,8 @@ public static System.Threading.Tasks.Task<Promptuarium.Element> AsElementAsync(t
 
 The source stream
 
+**loaderElement** &ensp; [Element](../../Element/README.md)
+
 ### Returns
 
 [Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)\<[Element](../../Element/README.md)\>

diff --git a/docs/Promptuarium/Data/README.md b/docs/Promptuarium/Data/README.md
@@ -23,7 +23,7 @@ public static class Data
 | [AsDateTimeOffset(Stream)](AsDateTimeOffset/README.md) | Converts a stream to a DateTimeOffset value\. |
 | [AsDecimal(Stream)](AsDecimal/README.md) | Converts a stream to a decimal value\. |
 | [AsDouble(Stream)](AsDouble/README.md) | Converts a stream to a double value\. |
-| [AsElementAsync(Stream)](AsElementAsync/README.md) | Converts a stream to a tree\. |
+| [AsElementAsync(Stream, Element)](AsElementAsync/README.md) | Converts a stream to a tree\. |
 | [AsFloat(Stream)](AsFloat/README.md) | Converts a stream to a float value\. |
 | [AsGuid(Stream)](AsGuid/README.md) | Converts a stream to a GUID value\. |
 | [AsInt(Stream)](AsInt/README.md) | Converts a stream to an int value\. |

diff --git a/docs/Promptuarium/Element/FromBase64StringAsync/README.md b/docs/Promptuarium/Element/FromBase64StringAsync/README.md
@@ -1,27 +1,16 @@
-# Element\.FromBase64StringAsync Method
+# Element\.FromBase64StringAsync\(String, Element, CancellationToken\) Method
 
 [Home](../../../README.md)
 
 **Containing Type**: [Element](../README.md)
 
 **Assembly**: Promptuarium\.dll
 
-## Overloads
-
-| Method | Summary |
-| ------ | ------- |
-| [FromBase64StringAsync(String, CancellationToken)](#142880008) | Creates a tree from a Base64 string\. |
-| [FromBase64StringAsync(String)](#3836437132) | Creates a tree from a Base64 string\. |
-
-<a id="142880008"></a>
-
-## FromBase64StringAsync\(String, CancellationToken\) 
-
 
 Creates a tree from a Base64 string\.
 
 ```csharp
-public static System.Threading.Tasks.Task<Promptuarium.Element> FromBase64StringAsync(string base64String, System.Threading.CancellationToken cancellationToken)
+public static System.Threading.Tasks.Task<Promptuarium.Element> FromBase64StringAsync(string base64String, Promptuarium.Element loaderElement = null, System.Threading.CancellationToken cancellationToken = default)
 ```
 
 ### Parameters
@@ -30,6 +19,8 @@ public static System.Threading.Tasks.Task<Promptuarium.Element> FromBase64String
 
 The tree in Base64\.
 
+**loaderElement** &ensp; [Element](../README.md)
+
 **cancellationToken** &ensp; [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken)
 
 The cancellation token\.
@@ -40,36 +31,7 @@ The cancellation token\.
 
 The tree\.
 
-### Examples
-
-```
-var tree = await Element.FromBase64StringAsync(base64String);
-```
-
-<a id="3836437132"></a>
-
-## FromBase64StringAsync\(String\) 
-
-
-Creates a tree from a Base64 string\.
-
-```csharp
-public static System.Threading.Tasks.Task<Promptuarium.Element> FromBase64StringAsync(string base64String)
-```
-
-### Parameters
-
-**base64String** &ensp; [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-
-The tree in Base64\.
-
-### Returns
-
-[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)\<[Element](../README.md)\>
-
-The tree\.
-
-### Examples
+## Examples
 
 ```
 var tree = await Element.FromBase64StringAsync(base64String);

diff --git a/docs/Promptuarium/Element/LoadAsync/README.md b/docs/Promptuarium/Element/LoadAsync/README.md
@@ -23,7 +23,7 @@
 Loads a tree from a stream\.
 
 ```csharp
-public static System.Threading.Tasks.Task<Promptuarium.Element> LoadAsync(System.IO.Stream stream, System.Threading.CancellationToken cancellationToken)
+public System.Threading.Tasks.Task<Promptuarium.Element> LoadAsync(System.IO.Stream stream, System.Threading.CancellationToken cancellationToken)
 ```
 
 ### Parameters
@@ -63,7 +63,7 @@ var tree = await Element.LoadAsync(stream, cancellationToken);
 Loads a tree from a stream\.
 
 ```csharp
-public static System.Threading.Tasks.Task<Promptuarium.Element> LoadAsync(System.IO.Stream stream)
+public System.Threading.Tasks.Task<Promptuarium.Element> LoadAsync(System.IO.Stream stream)
 ```
 
 ### Parameters
@@ -99,7 +99,7 @@ var tree = await Element.LoadAsync(stream);
 Loads a tree from a file\.
 
 ```csharp
-public static System.Threading.Tasks.Task<Promptuarium.Element> LoadAsync(string fileName, System.Threading.CancellationToken cancellationToken)
+public System.Threading.Tasks.Task<Promptuarium.Element> LoadAsync(string fileName, System.Threading.CancellationToken cancellationToken)
 ```
 
 ### Parameters
@@ -138,7 +138,7 @@ var tree = await Element.LoadAsync("test.prm", cancellationToken);
 Loads a tree from a file\.
 
 ```csharp
-public static System.Threading.Tasks.Task<Promptuarium.Element> LoadAsync(string fileName)
+public System.Threading.Tasks.Task<Promptuarium.Element> LoadAsync(string fileName)
 ```
 
 ### Parameters

diff --git a/docs/Promptuarium/Element/OnDataLoaded/README.md b/docs/Promptuarium/Element/OnDataLoaded/README.md
@@ -10,6 +10,6 @@
 Event handler for all Promptuarium data loaded events
 
 ```csharp
-public static event EventHandler<Promptuarium.PromptuariumLoadedEventArgs>? OnDataLoaded
+public event EventHandler<Promptuarium.PromptuariumLoadedEventArgs>? OnDataLoaded
 ```
 
diff --git a/docs/Promptuarium/Element/OnDataLoading/README.md b/docs/Promptuarium/Element/OnDataLoading/README.md
@@ -10,6 +10,6 @@
 Event handler for all Promptuarium data loading events
 
 ```csharp
-public static event EventHandler<Promptuarium.PromptuariumLoadingEventArgs>? OnDataLoading
+public event EventHandler<Promptuarium.PromptuariumLoadingEventArgs>? OnDataLoading
 ```
 
diff --git a/docs/Promptuarium/Element/OnMetaDataLoaded/README.md b/docs/Promptuarium/Element/OnMetaDataLoaded/README.md
@@ -10,6 +10,6 @@
 Event handler for all Promptuarium metadata loaded events
 
 ```csharp
-public static event EventHandler<Promptuarium.PromptuariumLoadedEventArgs>? OnMetaDataLoaded
+public event EventHandler<Promptuarium.PromptuariumLoadedEventArgs>? OnMetaDataLoaded
 ```
 
diff --git a/docs/Promptuarium/Element/OnMetaDataLoading/README.md b/docs/Promptuarium/Element/OnMetaDataLoading/README.md
@@ -10,6 +10,6 @@
 Event handler for all Promptuarium metadata loading events
 
 ```csharp
-public static event EventHandler<Promptuarium.PromptuariumLoadingEventArgs>? OnMetaDataLoading
+public event EventHandler<Promptuarium.PromptuariumLoadingEventArgs>? OnMetaDataLoading
 ```
 
diff --git a/docs/Promptuarium/Element/README.md b/docs/Promptuarium/Element/README.md
@@ -51,8 +51,7 @@ public class Element : System.Collections.Generic.IEnumerable<Promptuarium.Eleme
 | [Detach()](Detach/README.md#2614073258) | Detaches a subtree or node\. |
 | [Detach(Element)](Detach/README.md#119873975) | Detaches a subtree or node\. |
 | [Equals(Object)](https://docs.microsoft.com/en-us/dotnet/api/system.object.equals) |  \(Inherited from [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) |
-| [FromBase64StringAsync(String, CancellationToken)](FromBase64StringAsync/README.md#142880008) | Creates a tree from a Base64 string\. |
-| [FromBase64StringAsync(String)](FromBase64StringAsync/README.md#3836437132) | Creates a tree from a Base64 string\. |
+| [FromBase64StringAsync(String, Element, CancellationToken)](FromBase64StringAsync/README.md) | Creates a tree from a Base64 string\. |
 | [GetEnumerator()](GetEnumerator/README.md) | Returns an enumerator that iterates through the Children \(Implements [IEnumerable\<Element\>.GetEnumerator](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1.getenumerator)\) |
 | [GetHashCode()](https://docs.microsoft.com/en-us/dotnet/api/system.object.gethashcode) |  \(Inherited from [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) |
 | [GetStatistics()](GetStatistics/README.md) | Gets the statistics about the tree |

diff --git a/docs/System/IO/Stream/README.md b/docs/System/IO/Stream/README.md
@@ -13,7 +13,7 @@
 | [AsDateTimeOffset(Stream)](../../../Promptuarium/Data/AsDateTimeOffset/README.md) | Converts a stream to a DateTimeOffset value\. |
 | [AsDecimal(Stream)](../../../Promptuarium/Data/AsDecimal/README.md) | Converts a stream to a decimal value\. |
 | [AsDouble(Stream)](../../../Promptuarium/Data/AsDouble/README.md) | Converts a stream to a double value\. |
-| [AsElementAsync(Stream)](../../../Promptuarium/Data/AsElementAsync/README.md) | Converts a stream to a tree\. |
+| [AsElementAsync(Stream, Element)](../../../Promptuarium/Data/AsElementAsync/README.md) | Converts a stream to a tree\. |
 | [AsFloat(Stream)](../../../Promptuarium/Data/AsFloat/README.md) | Converts a stream to a float value\. |
 | [AsGuid(Stream)](../../../Promptuarium/Data/AsGuid/README.md) | Converts a stream to a GUID value\. |
 | [AsInt(Stream)](../../../Promptuarium/Data/AsInt/README.md) | Converts a stream to an int value\. |