mirrors/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-06-07 09:55:43 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

wip: chore(esdoc): update and unify ESDoc and parameter names

Browse source 
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
This commit is contained in:
Erik Michelson 2025-05-20 13:16:02 +00:00
parent 3a90c9ca96
commit 3cb09d247c
No known key found for this signature in database
GPG key ID: DB99ADDDC5C0AF82
38 changed files with 474 additions and 365 deletions
Download patch file Download diff file Expand all files Collapse all files

12
backend/src/permissions/permission.service.ts
View file

@ -90,7 +90,7 @@ export class PermissionService {
* Checks if the given {@link User} is allowed to create notes.
*
* @param username - The user whose permission should be checked. Value is null if guest access should be checked
* @return if the user is allowed to create notes
* @returns if the user is allowed to create notes
*/
public mayCreate(username: string | null): boolean {
return (
@ -105,7 +105,7 @@ export class PermissionService {
* @param userId The id of the user
* @param noteId The id of the note
* @param transaction Optional transaction to use
* @return true if the user is the owner of the note
* @returns true if the user is the owner of the note
*/
async isOwner(
userId: number | null,
@ -135,7 +135,7 @@ export class PermissionService {
*
* @param {number | null} userId The user whose permission should be checked
* @param {number} noteId The note that is accessed by the given user
* @return {Promise<NotePermissionLevel>} The determined permission
* @returns {Promise<NotePermissionLevel>} The determined permission
*/
public async determinePermission(
userId: number,
@ -284,7 +284,7 @@ export class PermissionService {
* @param noteId the note
* @param userId the user for which the permission should be set
* @param canEdit specifies if the user can edit the note
* @return the note with the new permission
* @returns the note with the new permission
*/
async setUserPermission(
noteId: number,
@ -361,7 +361,7 @@ export class PermissionService {
* Remove permission for a specific group on a note.
* @param noteId - the note
* @param groupId - the group for which the permission should be set
* @return the note with the new permission
* @returns the note with the new permission
*/
async removeGroupPermission(noteId: number, groupId: number): Promise<void> {
const result = await this.knex(TableNoteGroupPermission)
@ -382,7 +382,7 @@ export class PermissionService {
* Updates the owner of a note.
* @param noteId - the note to use
* @param newOwnerId - the new owner
* @return the updated note
* @returns the updated note
*/
async changeOwner(noteId: number, newOwnerId: number): Promise<void> {
const result = await this.knex(TableNote)