Better docs inspired jsdocs in db-lib::Member::add

This commit is contained in:
shockrah 2020-11-21 13:20:46 -08:00
parent c80a1dab40
commit b15277348f

View File

@ -146,10 +146,10 @@ impl FromDB<Member, Integer> for Member {
impl Member {
pub async fn add(p: &Pool, name: &str, secret: &str, perms: u64) -> Result<Response<Self>, 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<Member>)
//! @returns : on_partial_succes => Ok(Response<Member>)