Documentation: Added remarks for ModConfig

Emik03 · Oct 3, 2021 · e0ad062 · e0ad062
1 parent c4d27e6
commit e0ad062
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 6 deletions.
diff --git a/Documentation/ModConfig.TSerialize...ctor.ZKsea+H43MefB36oOBiG5g.md b/Documentation/ModConfig.TSerialize...ctor.ZKsea+H43MefB36oOBiG5g.md
@@ -1,7 +1,7 @@
 #### [KeepCoding](index.md 'index')
 ### [KeepCoding](KeepCoding.md 'KeepCoding').[ModConfig&lt;TSerialize&gt;](ModConfig.TSerialize..md 'KeepCoding.ModConfig&lt;TSerialize&gt;')
 ## ModConfig&lt;TSerialize&gt;.ModConfig(string) Constructor
-Creates a new [ModConfig&lt;TSerialize&gt;](ModConfig.TSerialize..md 'KeepCoding.ModConfig&lt;TSerialize&gt;') with the target file name and an optional event of when the file is read.  
+Creates a new [ModConfig&lt;TSerialize&gt;](ModConfig.TSerialize..md 'KeepCoding.ModConfig&lt;TSerialize&gt;') with the target file name and an optional event of when the file is read. A file will automatically be made if it doesn't exist. A JSON property defined in the type [TSerialize](ModConfig.TSerialize..md#KeepCoding.ModConfig.TSerialize..TSerialize 'KeepCoding.ModConfig&lt;TSerialize&gt;.TSerialize') that isn't in the file will automatically write to the file with said property.  
 ```csharp
 public ModConfig(string fileName);
 ```
@@ -12,3 +12,5 @@ The file name to get.
 
 #### Exceptions
 [ConstructorArgumentException](ConstructorArgumentException.md 'KeepCoding.Internal.ConstructorArgumentException')  
+### Remarks
+In the editor, the constructor will not merge the default values of the type with the file.  
diff --git a/Documentation/ModConfig.TSerialize..HasReadSucceeded.md b/Documentation/ModConfig.TSerialize..HasReadSucceeded.md
@@ -1,7 +1,7 @@
 #### [KeepCoding](index.md 'index')
 ### [KeepCoding](KeepCoding.md 'KeepCoding').[ModConfig&lt;TSerialize&gt;](ModConfig.TSerialize..md 'KeepCoding.ModConfig&lt;TSerialize&gt;')
 ## ModConfig&lt;TSerialize&gt;.HasReadSucceeded Property
-Whether or not there has been a successful read of the settings file.  
+Whether or not there has been a successful read of the settings file. This value will always be false in the editor.  
 ```csharp
 public bool HasReadSucceeded { get; set; }
 ```

diff --git a/Documentation/ModConfig.TSerialize..Merge.ztIxpEjvzLjYtgSKoVEuHQ.md b/Documentation/ModConfig.TSerialize..Merge.ztIxpEjvzLjYtgSKoVEuHQ.md
@@ -16,3 +16,5 @@ Determines whether it should remove values from the original file that isn't con
 
 #### Exceptions
 [System.NullReferenceException](https://docs.microsoft.com/en-us/dotnet/api/System.NullReferenceException 'System.NullReferenceException')  
+### Remarks
+In the editor, this method does nothing.  
diff --git a/Documentation/ModConfig.TSerialize..ModConfig().md b/Documentation/ModConfig.TSerialize..ModConfig().md
@@ -1,9 +1,11 @@
 #### [KeepCoding](index.md 'index')
 ### [KeepCoding](KeepCoding.md 'KeepCoding').[ModConfig&lt;TSerialize&gt;](ModConfig.TSerialize..md 'KeepCoding.ModConfig&lt;TSerialize&gt;')
 ## ModConfig&lt;TSerialize&gt;.ModConfig() Constructor
-Creates a new [ModConfig&lt;TSerialize&gt;](ModConfig.TSerialize..md 'KeepCoding.ModConfig&lt;TSerialize&gt;') with the target file name and an optional event of when the file is read.  
+Creates a new [ModConfig&lt;TSerialize&gt;](ModConfig.TSerialize..md 'KeepCoding.ModConfig&lt;TSerialize&gt;') with the target file name and an optional event of when the file is read. A file will automatically be made if it doesn't exist. A JSON property defined in the type [TSerialize](ModConfig.TSerialize..md#KeepCoding.ModConfig.TSerialize..TSerialize 'KeepCoding.ModConfig&lt;TSerialize&gt;.TSerialize') that isn't in the file will automatically write to the file with said property.  
 ```csharp
 public ModConfig();
 ```
 #### Exceptions
 [ConstructorArgumentException](ConstructorArgumentException.md 'KeepCoding.Internal.ConstructorArgumentException')  
+### Remarks
+In the editor, the constructor will not merge the default values of the type with the file.  
diff --git a/Documentation/ModConfig.TSerialize..Read().md b/Documentation/ModConfig.TSerialize..Read().md
@@ -7,3 +7,5 @@ public TSerialize Read();
 ```
 #### Returns
 [TSerialize](ModConfig.TSerialize..md#KeepCoding.ModConfig.TSerialize..TSerialize 'KeepCoding.ModConfig&lt;TSerialize&gt;.TSerialize')  
+### Remarks
+In the editor, this method returns the default value of the constructor in [TSerialize](ModConfig.TSerialize..md#KeepCoding.ModConfig.TSerialize..TSerialize 'KeepCoding.ModConfig&lt;TSerialize&gt;.TSerialize').  
diff --git a/Documentation/ModConfig.TSerialize..ToString().md b/Documentation/ModConfig.TSerialize..ToString().md
@@ -8,3 +8,5 @@ public override string ToString();
 #### Returns
 [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')  
 A string representation of the value from [Read()](ModConfig.TSerialize..Read().md 'KeepCoding.ModConfig&lt;TSerialize&gt;.Read()').
+### Remarks
+In the editor, this method serializes the default value of the constructor in [TSerialize](ModConfig.TSerialize..md#KeepCoding.ModConfig.TSerialize..TSerialize 'KeepCoding.ModConfig&lt;TSerialize&gt;.TSerialize').  
diff --git a/Documentation/ModConfig.TSerialize..Write.BW1ArfhzLuv73fcInRzVFA.md b/Documentation/ModConfig.TSerialize..Write.BW1ArfhzLuv73fcInRzVFA.md
@@ -12,3 +12,5 @@ The value to overwrite the settings file with.
 
 #### Exceptions
 [System.NullReferenceException](https://docs.microsoft.com/en-us/dotnet/api/System.NullReferenceException 'System.NullReferenceException')  
+### Remarks
+In the editor, this method does nothing.  
diff --git a/Documentation/ModConfig.TSerialize..Write.JCanpm.fnSPX3sNGJXtQxg.md b/Documentation/ModConfig.TSerialize..Write.JCanpm.fnSPX3sNGJXtQxg.md
@@ -12,3 +12,5 @@ The contents to write.
 
 #### Exceptions
 [NullIteratorException](NullIteratorException.md 'KeepCoding.Internal.NullIteratorException')  
+### Remarks
+In the editor, this method does nothing.  
diff --git a/Documentation/ModConfig.TSerialize..md b/Documentation/ModConfig.TSerialize..md
@@ -24,12 +24,12 @@ Implements [ILog](ILog.md 'KeepCoding.ILog')
 
 | Constructors | |
 | :--- | :--- |
-| [ModConfig()](ModConfig.TSerialize..ModConfig().md 'KeepCoding.ModConfig&lt;TSerialize&gt;.ModConfig()') | Creates a new [ModConfig&lt;TSerialize&gt;](ModConfig.TSerialize..md 'KeepCoding.ModConfig&lt;TSerialize&gt;') with the target file name and an optional event of when the file is read.<br/> |
-| [ModConfig(string)](ModConfig.TSerialize...ctor.ZKsea+H43MefB36oOBiG5g.md 'KeepCoding.ModConfig&lt;TSerialize&gt;.ModConfig(string)') | Creates a new [ModConfig&lt;TSerialize&gt;](ModConfig.TSerialize..md 'KeepCoding.ModConfig&lt;TSerialize&gt;') with the target file name and an optional event of when the file is read.<br/> |
+| [ModConfig()](ModConfig.TSerialize..ModConfig().md 'KeepCoding.ModConfig&lt;TSerialize&gt;.ModConfig()') | Creates a new [ModConfig&lt;TSerialize&gt;](ModConfig.TSerialize..md 'KeepCoding.ModConfig&lt;TSerialize&gt;') with the target file name and an optional event of when the file is read. A file will automatically be made if it doesn't exist. A JSON property defined in the type [TSerialize](ModConfig.TSerialize..md#KeepCoding.ModConfig.TSerialize..TSerialize 'KeepCoding.ModConfig&lt;TSerialize&gt;.TSerialize') that isn't in the file will automatically write to the file with said property.<br/> |
+| [ModConfig(string)](ModConfig.TSerialize...ctor.ZKsea+H43MefB36oOBiG5g.md 'KeepCoding.ModConfig&lt;TSerialize&gt;.ModConfig(string)') | Creates a new [ModConfig&lt;TSerialize&gt;](ModConfig.TSerialize..md 'KeepCoding.ModConfig&lt;TSerialize&gt;') with the target file name and an optional event of when the file is read. A file will automatically be made if it doesn't exist. A JSON property defined in the type [TSerialize](ModConfig.TSerialize..md#KeepCoding.ModConfig.TSerialize..TSerialize 'KeepCoding.ModConfig&lt;TSerialize&gt;.TSerialize') that isn't in the file will automatically write to the file with said property.<br/> |
 
 | Properties | |
 | :--- | :--- |
-| [HasReadSucceeded](ModConfig.TSerialize..HasReadSucceeded.md 'KeepCoding.ModConfig&lt;TSerialize&gt;.HasReadSucceeded') | Whether or not there has been a successful read of the settings file.<br/> |
+| [HasReadSucceeded](ModConfig.TSerialize..HasReadSucceeded.md 'KeepCoding.ModConfig&lt;TSerialize&gt;.HasReadSucceeded') | Whether or not there has been a successful read of the settings file. This value will always be false in the editor.<br/> |
 
 | Methods | |
 | :--- | :--- |