0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-16 05:00:24 +00:00

Fix more documentation todos

I have decided not to include a manual page for
cowboy_stream_h at this point because it clashes
with the cowboy_stream manual page. This decision
will be revisited in the future.
This commit is contained in:
Loïc Hoguin 2017-09-04 14:33:44 +02:00
parent 47aa0097ed
commit 58e9e76814
No known key found for this signature in database
GPG key ID: 71366FF21851DF03
14 changed files with 225 additions and 55 deletions

View file

@ -8,12 +8,12 @@ cowboy_handler:terminate - Terminate the handler
[source,erlang]
----
terminate(Reason, Req | undefined, State, Handler) -> ok
terminate(Reason, PartialReq, State, Handler) -> ok
Reason :: any()
Req :: cowboy_req:req()
State :: any()
Handler :: module()
Reason :: any()
PartialReq :: map()
State :: any()
Handler :: module()
----
Call the optional terminate callback if it is defined.
@ -27,13 +27,13 @@ Reason::
Reason for termination.
Req::
PartialReq::
The Req object.
+
It is possible to pass `undefined` if the handler has no concept
of requests/responses and discarded the Req object before calling
this function.
It is possible to remove fields from the Req object to save memory
when the handler has no concept of requests/responses. The only
requirement is that a map is provided.
State::