From aba6be9a5386e30600e63eec0043276290be360b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= Date: Sun, 15 Jan 2023 15:20:01 +0100 Subject: Documentaion. --- functions/conf/nginx.pp | 5 ++++- functions/conf/nginx/location.pp | 4 ++++ 2 files changed, 8 insertions(+), 1 deletion(-) (limited to 'functions') diff --git a/functions/conf/nginx.pp b/functions/conf/nginx.pp index f8e6123..9e7b392 100644 --- a/functions/conf/nginx.pp +++ b/functions/conf/nginx.pp @@ -1,5 +1,8 @@ # Returns a hash to be merged into a nginx::resource::server resources -# parameters. The cert_name parameter should be the name of the domain in question, and NOT the local certificate name. +# parameters. +# @param cert_name +# name of the domain in question, NOT the local certificate name. +# @return hash usable with nginx::resource::server function letsencrypt::conf::nginx ( String $cert_name, ) >> Letsencrypt::Ssl_conf::Nginx { diff --git a/functions/conf/nginx/location.pp b/functions/conf/nginx/location.pp index a787013..19572f3 100644 --- a/functions/conf/nginx/location.pp +++ b/functions/conf/nginx/location.pp @@ -1,4 +1,8 @@ # Returns a hash to be merged into a nginx::resource::location resource. +# @param cert_name +# Domain for which we want the configuration. +# NOT the local certificate name. +# @return hash usable with nginx::resource::location function letsencrypt::conf::nginx::location ( String $cert_name, ) >> Letsencrypt::Ssl_conf::Nginx::Location { -- cgit v1.2.3