From 8a9f7dcb43c0b5e4d11bc63bfd0f23e2740fac7e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Thu, 19 Mar 2020 14:56:49 +0100 Subject: Document the new cow_cookie functions --- doc/src/manual/cow_cookie.cookie.asciidoc | 45 +++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 doc/src/manual/cow_cookie.cookie.asciidoc (limited to 'doc/src/manual/cow_cookie.cookie.asciidoc') diff --git a/doc/src/manual/cow_cookie.cookie.asciidoc b/doc/src/manual/cow_cookie.cookie.asciidoc new file mode 100644 index 0000000..c40d66b --- /dev/null +++ b/doc/src/manual/cow_cookie.cookie.asciidoc @@ -0,0 +1,45 @@ += cow_cookie:cookie(3) + +== Name + +cow_cookie:cookie - Generate a cookie header + +== Description + +[source,erlang] +---- +cookie(Cookies) -> iolist() + +Cookies :: [{Name :: iodata(), Value :: iodata()}] +---- + +Generate a cookie header. + +== Arguments + +Cookies:: + +A list of pairs of cookie name and value. + +== Return value + +An iolist with the generated cookie header value. + +== Changelog + +* *2.9*: Function introduced. + +== Examples + +.Generate a cookie header +[source,erlang] +---- +Cookie = cow_cookie:cookie([{<<"sessionid">>, ID}]). +---- + +== See also + +link:man:cow_cookie(3)[cow_cookie(3)], +link:man:cow_cookie:parse_cookie(3)[cow_cookie:parse_cookie(3)], +link:man:cow_cookie:parse_set_cookie(3)[cow_cookie:parse_set_cookie(3)], +link:man:cow_cookie:setcookie(3)[cow_cookie:setcookie(3)] -- cgit v1.2.3