From 7bb7885f6eb19547b906513d2664e3730ef5b593 Mon Sep 17 00:00:00 2001 From: jwijenbergh Date: Thu, 5 May 2022 17:47:36 +0200 Subject: Docs: Add API and building improvements --- docs/src/api/overview/deregistering.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 docs/src/api/overview/deregistering.md (limited to 'docs/src/api/overview/deregistering.md') 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. -- cgit v1.2.3