summaryrefslogtreecommitdiff
path: root/docs/src/api/overview/deregistering.md
diff options
context:
space:
mode:
authorjwijenbergh <jeroenwijenbergh@protonmail.com>2022-05-05 17:47:36 +0200
committerjwijenbergh <jeroenwijenbergh@protonmail.com>2022-05-05 17:47:36 +0200
commit7bb7885f6eb19547b906513d2664e3730ef5b593 (patch)
treece387ad24da5e3ba3b4d1604d07a5b11d9e68a2e /docs/src/api/overview/deregistering.md
parent657776055cd07c1f9279e982fbfef88dca1ca71b (diff)
Docs: Add API and building improvements
Diffstat (limited to 'docs/src/api/overview/deregistering.md')
-rw-r--r--docs/src/api/overview/deregistering.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/src/api/overview/deregistering.md b/docs/src/api/overview/deregistering.md
new file mode 100644
index 0000000..0503dbe
--- /dev/null
+++ b/docs/src/api/overview/deregistering.md
@@ -0,0 +1,11 @@
+# Deregistering
+## Summary
+name: `Deregister`
+
+Arguments: None
+
+Returns: Nothing
+
+Used to cleanup the library by deregistering the client and saving the config files
+## Detailed information
+The deregister method is used to cleanup the library. It should be called when the client closes. This also saves the state to the directory that was passed in the [Register](./registering.html) method.