From b15277348f3eb103611a0da50be693d3ed27497c Mon Sep 17 00:00:00 2001 From: shockrah Date: Sat, 21 Nov 2020 13:20:46 -0800 Subject: [PATCH] Better docs inspired jsdocs in db-lib::Member::add --- server-api/db/src/member.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/server-api/db/src/member.rs b/server-api/db/src/member.rs index 6596c73..d4e6aab 100644 --- a/server-api/db/src/member.rs +++ b/server-api/db/src/member.rs @@ -146,10 +146,10 @@ impl FromDB for Member { impl Member { pub async fn add(p: &Pool, name: &str, secret: &str, perms: u64) -> Result, SqlError> { - //! @param {pool} - //! @param {&str} - //! @param {&str} - //! @param {u64} + //! @param {pool} p + //! @param {&str} name of new user + //! @param {&str} encrypted secret : userland auth module should have a function for this + //! @param {u64} permissions mask //! @returns : on_succes => Ok(Response) //! @returns : on_partial_succes => Ok(Response)