Skip to content

Commit 1f9865a

Browse files
feat: update helmet documentation for strict_transport_security.
Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
1 parent 10c0cb5 commit 1f9865a

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

include/boost/http_proto/server/helmet.hpp

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -332,12 +332,14 @@ option_pair x_content_type_options();
332332
option_pair content_security_policy(const helmet::csp_policy& sp);
333333

334334
/** Return HSTS configuration for the host.
335-
@param include_subdomains either include_domains or no_subdomains
336-
@param preload either preload or no_preload
337-
@note use the hsts namespace to set those function values.
338-
@return the option_pair to pass to the helmet.
335+
@param age Maximum age in seconds for HSTS enforcement.
336+
@param include_subdomains either hsts::include_subdomains or hsts::no_subdomains
337+
@param preload either hsts::preload or hsts::no_preload
338+
@note Use constants from the hsts namespace.
339+
@return Header name and value pair.
339340
*/
340-
option_pair strict_transport_security(std::size_t age,
341+
option_pair strict_transport_security(
342+
std::size_t age,
341343
bool include_subdomains = hsts::include_subdomains,
342344
bool preload = hsts::no_preload);
343345

0 commit comments

Comments
 (0)