From 8483a60da811b9e27e34872d3b8be7807ba09fc1 Mon Sep 17 00:00:00 2001 From: "Tristan B. Velloza Kildaire" Date: Thu, 5 Jan 2023 11:28:12 +0200 Subject: [PATCH] - Added missing documentaion string for `authWithPassword()` --- source/libpb/driver.d | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/source/libpb/driver.d b/source/libpb/driver.d index 991a121..b561b86 100644 --- a/source/libpb/driver.d +++ b/source/libpb/driver.d @@ -247,8 +247,19 @@ public class PocketBase } } - - // TODO: Add comment + /** + * Authenticates on the given auth table with the provided + * credentials, returning a JWT token in the reference parameter. + * Finally returning the record of the authenticated user. + * + * Params: + * table = the auth collection to use + * identity = the user's identity + * password = the user's password + * token = the variable to return into + * + * Returns: An instance of `RecordType` + */ public RecordType authWithPassword(RecordType)(string table, string identity, string password, ref string token) { mixin isAuthable!(RecordType);