From e1f9e0ed377388b660655b0d242ff8e38d3e8963 Mon Sep 17 00:00:00 2001
From: Vangos Pterneas <vangos@lightbuzz.com>
Date: Wed, 9 Jan 2019 17:09:37 +0200
Subject: [PATCH] Added documentation. Renamed ClearAll to DeleteAll.

---
 .../Plugins/LightBuzz.Settings.dll            | Bin 7168 -> 7168 bytes
 .../Plugins/LightBuzz.Settings.xml            |  62 ++++++++++++++++++
 .../Plugins/LightBuzz.Settings.xml.meta       |   7 ++
 .../LightBuzz.Settings.Unity.csproj           |   1 +
 .../LightBuzz.Settings.Unity/PlayerPrefsEx.cs |   2 +-
 .../LightBuzz.Settings.Unity/Settings.cs      |   4 +-
 6 files changed, 73 insertions(+), 3 deletions(-)
 create mode 100644 LightBuzz.Settings.Unity.Demo/Assets/LightBuzz_Settings/Plugins/LightBuzz.Settings.xml
 create mode 100644 LightBuzz.Settings.Unity.Demo/Assets/LightBuzz_Settings/Plugins/LightBuzz.Settings.xml.meta

diff --git a/LightBuzz.Settings.Unity.Demo/Assets/LightBuzz_Settings/Plugins/LightBuzz.Settings.dll b/LightBuzz.Settings.Unity.Demo/Assets/LightBuzz_Settings/Plugins/LightBuzz.Settings.dll
index 6c4d2a14d1565b0c01d48e2f1344d08117d52c89..7a30d8e11f5a41193dfc78ccc7c4612dc8d6be27 100644
GIT binary patch
delta 949
zcmaKrT}V_x6vzMP-r4K!U0v69%}Ps6L`?heBQ>xGX~PVYEfEuvw6G8?Dh>0&Rzak1
zT81)u3G1N`3X~-?tcU6$m9*4{Ad09cOu`}}=!59Yn6KT3-~7*iX3pF*hv_KlC^~!0
z2zbILmeGyy^=jHKi8351xj>RkHL_(5Wl*2&q!68wWcVC?F#yR4e_<qO1jWj72as0T
za;S0t-e&Ok$p)VBm{wJZdv3t1bZJ#tfX63t%-R>KHHkG~VTDm8Ec9r$QksaxVWIp>
zG+<hYF%)ODKC1O*&E1*<+CNDJoS{*3LOYK{H}9H;${dAK&Q?K6XOQv}#Osh@;g_L;
zO=d1nzk}iz<EyaoK}@ngY<8O-oHOIe!i-Kg2(|t+`xZ#+w`MQvZ`xU+9lz#F&3;Xx
zk8EbG%FR^Z-5IKSFA^MGVm*h1PV(Z6P>~ZJ#NjGtn9t=-XM(RseCHKMkdI)B+TOXy
zmdBkNW5-1lnYf&)yl#xjSI$IAmOq?@<dr$D%%$TZg<QC~T+N@ys3?OQ!}F1Bb!CO#
z@J$nPxO)a38uNP2ndkr37`Xj!mkYKa{$rbOc`?)GQf=Wyj^;Ye63sHrt%@Pk=%Ah%
zk4CKzYKEB>+BAD1#4_|^l6f6#9ck!C3}xajdc|sXHaPO}04XSB$95Dm|A+uaFvtZ*
z>kQFIchs?NH}^1iL9xZ$kHlz<8FiS@M@D0on>m7OqD>`|L-rQ3rOSPVy5uc)I!#8V
z+-FTY(9qP-(ooXW1R3`GBB9t9M3B{S6W&!%lPgBv$CdZ^>Vp?XOR6G83#KVM;3?Rl
z8o>92B<^}Kzo}wBu&pvsS({~ze7t|4<jzp;lzjYqEK=@wQcOplT0i$)l=bn6{N~!@
VPe(ipf11Y4yhz-V&lFx0^%t~IwMzg1

delta 945
zcmaKrTS$~a6vzMP`{rBsb5~ujm6@$th-IW^X;2TAVFt;XN(e^U6`>2MU_rEs-Ai(r
z*j|FPA`^^~#j?vwzN8OZErs;Zl?W`liBNQd&W!om_wbwl`OnOm@0?-Uirb32jvHg{
zz{zyF66o7V)siUNN-F@;WQLI|Ybl%hWjp!lxFjRd>W=|PMv{s`KEo##t+jxxs+Ok4
zJv*Dh-*`0en8&P|Dh#;*kJ4o|<)u81$gpF#zs@AqfCCGRYT>{+%~r}3acB|Bzd(bg
z12Kl;XRQxuy-sth=1uLNqNSXnQ8S{QVR3|ajYDOQLK$bPAf>ZO`6=R+-*DiUp@Ow$
z0Z+e$;#XrrMB|-^u>Zh3V#eaEnM@A6*Xf3!)}LnI0n+-7+0A-VJE_`9(tNHtpegi`
z&8$_qISRZxTUGBtiq#=ja!6<=4?2a4oQOp{dhvldCO120BnHJdUa=pA@Ojnt_L;Uk
z;an3J7Exs4VutdLVpP6x&Zczv!&yXeGT+Xb6Bb^w(Vwa2gBTU%aA9ORlCAba|7-3v
zA&+m*z_2l`r<`g2Z;gS$f4gkhg7}YZ?(!^VG?!`%5ArpaYnEu1YgQ`yQLBRnW-=PJ
z-lrL0I&eU<2c}3z4<gJy6k1srKn&&JHoC=Pc2-%1xDPLi*s-k@%s-+OqqxNdyLARP
z=2`Wu51KoeTcFr%?!jy~!bUwJ`balE@nw#pR~%4@<lX4?WJ}w1i8|yp*L;eEp18V9
zYxS<}4NalOxCxS*;vadwKQrcDPMs{dQTg=a@9OK9Ln{)-DR<1htWI^En}amI>SBIK
z#Yw=1s?w@$hwoXrFM}0#_U1o46F7e?<V$i=!oekK{nQs!+8fA7;m6jV+!@Fdq1cq4
Qrg3#iC_eQI1@fZ)0-`ds`2YX_

diff --git a/LightBuzz.Settings.Unity.Demo/Assets/LightBuzz_Settings/Plugins/LightBuzz.Settings.xml b/LightBuzz.Settings.Unity.Demo/Assets/LightBuzz_Settings/Plugins/LightBuzz.Settings.xml
new file mode 100644
index 0000000..4f6efec
--- /dev/null
+++ b/LightBuzz.Settings.Unity.Demo/Assets/LightBuzz_Settings/Plugins/LightBuzz.Settings.xml
@@ -0,0 +1,62 @@
+<?xml version="1.0"?>
+<doc>
+    <assembly>
+        <name>LightBuzz.Settings</name>
+    </assembly>
+    <members>
+        <member name="P:LightBuzz.Settings.PlayerPrefsEx.SettingsFilePath">
+            <summary>
+            The directory where the settings key/values will be stored.
+            </summary>
+        </member>
+        <member name="T:LightBuzz.Settings.Settings">
+            <summary>
+            Provides some utility methods for setting, getting and deleting application data.
+            </summary>
+        </member>
+        <member name="M:LightBuzz.Settings.Settings.Initialize">
+            <summary>
+            Initializes the settings module.
+            </summary>
+        </member>
+        <member name="M:LightBuzz.Settings.Settings.Initialize(System.String)">
+            <summary>
+            Initializes the settings module.
+            </summary>
+            <param name="root">The root of the application, where the settings folder will be stored.</param>
+        </member>
+        <member name="M:LightBuzz.Settings.Settings.Set``1(System.String,``0)">
+            <summary>
+            Inserts the specified value to the specified settings key, or creates a new pair.
+            </summary>
+            <param name="key">The name of the setting.</param>
+            <param name="value">The content of the setting.</param>
+        </member>
+        <member name="M:LightBuzz.Settings.Settings.Get``1(System.String)">
+            <summary>
+            Retrieves the contents of the specified setting key.
+            </summary>
+            <param name="key">The name of the setting.</param>
+            <returns>The content of the specified setting.</returns>
+        </member>
+        <member name="M:LightBuzz.Settings.Settings.Get``1(System.String,``0)">
+            <summary>
+            Retrieves the contents of the specified setting key.
+            </summary>
+            <param name="key">The name of the setting.</param>
+            <param name="defaultValue">The default value returned, if the key isn't found.</param>
+            <returns>The content of the specified setting.</returns>
+        </member>
+        <member name="M:LightBuzz.Settings.Settings.Remove(System.String)">
+            <summary>
+            Deletes the specified setting.
+            </summary>
+            <param name="key">The name of the setting.</param>
+        </member>
+        <member name="M:LightBuzz.Settings.Settings.DeleteAll">
+            <summary>
+            USE CAUTIOUSLY! This method will delete all of the Settings!
+            </summary>
+        </member>
+    </members>
+</doc>
diff --git a/LightBuzz.Settings.Unity.Demo/Assets/LightBuzz_Settings/Plugins/LightBuzz.Settings.xml.meta b/LightBuzz.Settings.Unity.Demo/Assets/LightBuzz_Settings/Plugins/LightBuzz.Settings.xml.meta
new file mode 100644
index 0000000..c57a551
--- /dev/null
+++ b/LightBuzz.Settings.Unity.Demo/Assets/LightBuzz_Settings/Plugins/LightBuzz.Settings.xml.meta
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: b98f4e73b9ddc0c41a1a3dbdd209ad3a
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/LightBuzz.Settings.Unity/LightBuzz.Settings.Unity/LightBuzz.Settings.Unity.csproj b/LightBuzz.Settings.Unity/LightBuzz.Settings.Unity/LightBuzz.Settings.Unity.csproj
index 618b4dc..0001507 100644
--- a/LightBuzz.Settings.Unity/LightBuzz.Settings.Unity/LightBuzz.Settings.Unity.csproj
+++ b/LightBuzz.Settings.Unity/LightBuzz.Settings.Unity/LightBuzz.Settings.Unity.csproj
@@ -29,6 +29,7 @@
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Release\LightBuzz.Settings.xml</DocumentationFile>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="Newtonsoft.Json">
diff --git a/LightBuzz.Settings.Unity/LightBuzz.Settings.Unity/PlayerPrefsEx.cs b/LightBuzz.Settings.Unity/LightBuzz.Settings.Unity/PlayerPrefsEx.cs
index b91d9bb..9e3ef31 100644
--- a/LightBuzz.Settings.Unity/LightBuzz.Settings.Unity/PlayerPrefsEx.cs
+++ b/LightBuzz.Settings.Unity/LightBuzz.Settings.Unity/PlayerPrefsEx.cs
@@ -130,7 +130,7 @@ private void Check()
             if (!_initialized) throw new Exception("Settings are not initialized. Call the Settings.Initialize() method from Unity's main thread.");
         }
 
-        public void ClearAll()
+        public void DeleteAll()
         {
             if (_settings != null)
             {
diff --git a/LightBuzz.Settings.Unity/LightBuzz.Settings.Unity/Settings.cs b/LightBuzz.Settings.Unity/LightBuzz.Settings.Unity/Settings.cs
index 863f864..79c0dba 100644
--- a/LightBuzz.Settings.Unity/LightBuzz.Settings.Unity/Settings.cs
+++ b/LightBuzz.Settings.Unity/LightBuzz.Settings.Unity/Settings.cs
@@ -120,9 +120,9 @@ public static void Remove(string key)
         /// <summary>
         /// USE CAUTIOUSLY! This method will delete all of the Settings!
         /// </summary>
-        public static void ClearAll()
+        public static void DeleteAll()
         {
-            PlayerPrefsEx.Instance.ClearAll();
+            PlayerPrefsEx.Instance.DeleteAll();
         }
     }
 }