From e0ad0623f413accc90daab7a9d63a2e50d7e1775 Mon Sep 17 00:00:00 2001 From: Emik03 Date: Sun, 3 Oct 2021 21:26:40 +0200 Subject: [PATCH] Documentation: Added remarks for ModConfig --- .../ModConfig.TSerialize...ctor.ZKsea+H43MefB36oOBiG5g.md | 4 +++- Documentation/ModConfig.TSerialize..HasReadSucceeded.md | 2 +- .../ModConfig.TSerialize..Merge.ztIxpEjvzLjYtgSKoVEuHQ.md | 2 ++ Documentation/ModConfig.TSerialize..ModConfig().md | 4 +++- Documentation/ModConfig.TSerialize..Read().md | 2 ++ Documentation/ModConfig.TSerialize..ToString().md | 2 ++ .../ModConfig.TSerialize..Write.BW1ArfhzLuv73fcInRzVFA.md | 2 ++ .../ModConfig.TSerialize..Write.JCanpm.fnSPX3sNGJXtQxg.md | 2 ++ Documentation/ModConfig.TSerialize..md | 6 +++--- 9 files changed, 20 insertions(+), 6 deletions(-) diff --git a/Documentation/ModConfig.TSerialize...ctor.ZKsea+H43MefB36oOBiG5g.md b/Documentation/ModConfig.TSerialize...ctor.ZKsea+H43MefB36oOBiG5g.md index 5765774..0dabea5 100644 --- 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<TSerialize>](ModConfig.TSerialize..md 'KeepCoding.ModConfig<TSerialize>') ## ModConfig<TSerialize>.ModConfig(string) Constructor -Creates a new [ModConfig<TSerialize>](ModConfig.TSerialize..md 'KeepCoding.ModConfig<TSerialize>') with the target file name and an optional event of when the file is read. +Creates a new [ModConfig<TSerialize>](ModConfig.TSerialize..md 'KeepCoding.ModConfig<TSerialize>') 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<TSerialize>.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 index 5044f25..259aeb3 100644 --- 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<TSerialize>](ModConfig.TSerialize..md 'KeepCoding.ModConfig<TSerialize>') ## ModConfig<TSerialize>.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 index d7bb1c1..17601b5 100644 --- 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 index 47089f0..d50edbc 100644 --- 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<TSerialize>](ModConfig.TSerialize..md 'KeepCoding.ModConfig<TSerialize>') ## ModConfig<TSerialize>.ModConfig() Constructor -Creates a new [ModConfig<TSerialize>](ModConfig.TSerialize..md 'KeepCoding.ModConfig<TSerialize>') with the target file name and an optional event of when the file is read. +Creates a new [ModConfig<TSerialize>](ModConfig.TSerialize..md 'KeepCoding.ModConfig<TSerialize>') 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<TSerialize>.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 index 88aa144..f5dbfea 100644 --- 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<TSerialize>.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<TSerialize>.TSerialize'). diff --git a/Documentation/ModConfig.TSerialize..ToString().md b/Documentation/ModConfig.TSerialize..ToString().md index d811640..444b6cd 100644 --- 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<TSerialize>.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<TSerialize>.TSerialize'). diff --git a/Documentation/ModConfig.TSerialize..Write.BW1ArfhzLuv73fcInRzVFA.md b/Documentation/ModConfig.TSerialize..Write.BW1ArfhzLuv73fcInRzVFA.md index bff60ba..35e6cb5 100644 --- 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 index 8fb27ea..3115598 100644 --- 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 index f0fb716..b551018 100644 --- 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<TSerialize>.ModConfig()') | Creates a new [ModConfig<TSerialize>](ModConfig.TSerialize..md 'KeepCoding.ModConfig<TSerialize>') with the target file name and an optional event of when the file is read.
| -| [ModConfig(string)](ModConfig.TSerialize...ctor.ZKsea+H43MefB36oOBiG5g.md 'KeepCoding.ModConfig<TSerialize>.ModConfig(string)') | Creates a new [ModConfig<TSerialize>](ModConfig.TSerialize..md 'KeepCoding.ModConfig<TSerialize>') with the target file name and an optional event of when the file is read.
| +| [ModConfig()](ModConfig.TSerialize..ModConfig().md 'KeepCoding.ModConfig<TSerialize>.ModConfig()') | Creates a new [ModConfig<TSerialize>](ModConfig.TSerialize..md 'KeepCoding.ModConfig<TSerialize>') 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<TSerialize>.TSerialize') that isn't in the file will automatically write to the file with said property.
| +| [ModConfig(string)](ModConfig.TSerialize...ctor.ZKsea+H43MefB36oOBiG5g.md 'KeepCoding.ModConfig<TSerialize>.ModConfig(string)') | Creates a new [ModConfig<TSerialize>](ModConfig.TSerialize..md 'KeepCoding.ModConfig<TSerialize>') 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<TSerialize>.TSerialize') that isn't in the file will automatically write to the file with said property.
| | Properties | | | :--- | :--- | -| [HasReadSucceeded](ModConfig.TSerialize..HasReadSucceeded.md 'KeepCoding.ModConfig<TSerialize>.HasReadSucceeded') | Whether or not there has been a successful read of the settings file.
| +| [HasReadSucceeded](ModConfig.TSerialize..HasReadSucceeded.md 'KeepCoding.ModConfig<TSerialize>.HasReadSucceeded') | Whether or not there has been a successful read of the settings file. This value will always be false in the editor.
| | Methods | | | :--- | :--- |