shockrah/freechat
shockrah/freechat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
shockrah 2020-11-21 13:20:46 -08:00
parent c80a1dab40
commit b15277348f
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
server-api/db/src/member.rs
View File

@ -146,10 +146,10 @@ impl FromDB<Member, Integer> for Member {
impl Member { impl Member {
pub async fn add(p: &Pool, name: &str, secret: &str, perms: u64) -> Result<Response<Self>, SqlError> { pub async fn add(p: &Pool, name: &str, secret: &str, perms: u64) -> Result<Response<Self>, SqlError> {
//! @param {pool} //! @param {pool} p
//! @param {&str} //! @param {&str} name of new user
//! @param {&str} //! @param {&str} encrypted secret : userland auth module should have a function for this
//! @param {u64} //! @param {u64} permissions mask
//! @returns : on_succes => Ok(Response<Member>) //! @returns : on_succes => Ok(Response<Member>)
//! @returns : on_partial_succes => Ok(Response<Member>) //! @returns : on_partial_succes => Ok(Response<Member>)