From e37af7ac0caffc661def1593c55b212cc2f05d3e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Sun, 15 Mar 2020 18:41:48 +0100
Subject: Document the cookie store option and related modules

Also contains a few small changes and Dialyzer fixes.
---
 doc/src/manual/gun_cookies_list.asciidoc | 55 ++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 doc/src/manual/gun_cookies_list.asciidoc

(limited to 'doc/src/manual/gun_cookies_list.asciidoc')

diff --git a/doc/src/manual/gun_cookies_list.asciidoc b/doc/src/manual/gun_cookies_list.asciidoc
new file mode 100644
index 0000000..2daef8e
--- /dev/null
+++ b/doc/src/manual/gun_cookies_list.asciidoc
@@ -0,0 +1,55 @@
+= gun_cookies_list(3)
+
+== Name
+
+gun_cookies_list - Cookie store backend: in-memory, per connection
+
+== Description
+
+The `gun_cookies_list` module implements a cookie store
+backend that keeps all the cookie data in-memory and tied
+to a specific connection.
+
+It is possible to implement a custom backend on top of
+`gun_cookies_list` in order to add persistence or sharing
+properties.
+
+== Exports
+
+This module implements the callbacks defined in
+link:man:gun_cookies(3)[gun_cookies(3)].
+
+== Types
+
+=== opts()
+
+[source,erlang]
+----
+opts() :: #{
+}
+----
+
+Cookie store backend options.
+
+There are currently no options available for this backend.
+
+// The default value is given next to the option name:
+
+== Changelog
+
+* *2.0*: Module introduced.
+
+== Examples
+
+.Open a connection with a cookie store configured
+[source,erlang]
+----
+{ok, ConnPid} = gun:open(Host, Port, #{
+    cookie_store => gun_cookies_list:init(#{})
+})
+----
+
+== See also
+
+link:man:gun(7)[gun(7)],
+link:man:gun_cookies(3)[gun_cookies(3)]
-- 
cgit v1.2.3

