From 39ff402dd478ec75c939a287691d3f45a6f6a751 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= <hugo@lysator.liu.se> Date: Tue, 30 May 2023 19:27:09 +0200 Subject: [PATCH] Add documentation. --- functions/bool_to_yesno.pp | 4 ++++ types/metadata.pp | 1 + types/password.pp | 8 +++++++- types/permission.pp | 1 + 4 files changed, 13 insertions(+), 1 deletion(-) diff --git a/functions/bool_to_yesno.pp b/functions/bool_to_yesno.pp index cbae86f..3a84c8b 100644 --- a/functions/bool_to_yesno.pp +++ b/functions/bool_to_yesno.pp @@ -1,3 +1,7 @@ +# Converts a boolean to a yes/no string +# @param bool +# The boolean to convertt +# @return the string 'yes' or 'no' function mpd::bool_to_yesno ( Boolean $bool, ) >> String { diff --git a/types/metadata.pp b/types/metadata.pp index c85f3e5..c8b365f 100644 --- a/types/metadata.pp +++ b/types/metadata.pp @@ -1,3 +1,4 @@ +# Types of MPD metadata type Mpd::Metadata = Variant[ Enum['none'], Array[Enum[ diff --git a/types/password.pp b/types/password.pp index 35da590..3974c0e 100644 --- a/types/password.pp +++ b/types/password.pp @@ -1 +1,7 @@ -type Mpd::Password = Struct[{ name => String, permissions => Array[Mpd::Permission] }] +# An MPD user +# Name is the password of the user +# Permissions is what the user is allowed to do +type Mpd::Password = Struct[{ + name => String, + permissions => Array[Mpd::Permission] +}] diff --git a/types/permission.pp b/types/permission.pp index 3856b7c..f0f2465 100644 --- a/types/permission.pp +++ b/types/permission.pp @@ -1 +1,2 @@ +# Available MPD permissions type Mpd::Permission = Enum['read', 'add', 'control', 'admin'] -- GitLab