aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/cowboy_req.resp_headers.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2017-01-04 19:21:23 +0100
committerLoïc Hoguin <[email protected]>2017-01-04 19:21:23 +0100
commitf34ef2ceae4bccd49f3a655e311c310b7570e64f (patch)
tree2bc6eac95238852b97d544c680937117ec062c25 /doc/src/manual/cowboy_req.resp_headers.asciidoc
parent3f4e79d42f7a81fa3f8e790630f71570287c2be0 (diff)
downloadcowboy-f34ef2ceae4bccd49f3a655e311c310b7570e64f.tar.gz
cowboy-f34ef2ceae4bccd49f3a655e311c310b7570e64f.tar.bz2
cowboy-f34ef2ceae4bccd49f3a655e311c310b7570e64f.zip
Improve the manual for the new resp_header functions
Diffstat (limited to 'doc/src/manual/cowboy_req.resp_headers.asciidoc')
-rw-r--r--doc/src/manual/cowboy_req.resp_headers.asciidoc13
1 files changed, 6 insertions, 7 deletions
diff --git a/doc/src/manual/cowboy_req.resp_headers.asciidoc b/doc/src/manual/cowboy_req.resp_headers.asciidoc
index 804c0d0..a3b8f0e 100644
--- a/doc/src/manual/cowboy_req.resp_headers.asciidoc
+++ b/doc/src/manual/cowboy_req.resp_headers.asciidoc
@@ -2,18 +2,16 @@
== Name
-cowboy_req:resp_headers - Access HTTP headers set for the response
+cowboy_req:resp_headers - Response headers
== Description
[source,erlang]
----
-resp_headers(Req) -> cowboy:http_headers()
-
-Req :: cowboy_req:req()
+resp_headers(Req :: cowboy_req:req()) -> cowboy:http_headers()
----
-Return all HTTP response headers.
+Return all response headers.
== Arguments
@@ -25,7 +23,6 @@ The Req object.
Headers are returned as a map with keys being lowercase
binary strings, and values as binary strings.
-If no response headers have been added the empty map is returned.
== Changelog
@@ -42,4 +39,6 @@ Headers = cowboy_req:resp_headers(Req).
== See also
link:man:cowboy_req(3)[cowboy_req(3)],
-link:man:cowboy_req:set_resp_headers(3)[cowboy_req:set_resp_headers(3)] \ No newline at end of file
+link:man:cowboy_req:resp_header(3)[cowboy_req:resp_header(3)],
+link:man:cowboy_req:set_resp_header(3)[cowboy_req:set_resp_header(3)],
+link:man:cowboy_req:set_resp_headers(3)[cowboy_req:set_resp_headers(3)]