refactor: Enable jsdoc/tag-lines and jsdoc/sort-tags rules

This commit is contained in:
Joachim Van Herwegen
2024-03-14 09:29:56 +01:00
parent 3e59aa4b55
commit 65bf2bd34e
89 changed files with 276 additions and 18 deletions

View File

@@ -65,6 +65,7 @@ export class AcpReader extends PermissionReader {
/**
* Generates the allowed permissions.
*
* @param target - Target to generate permissions for.
* @param credentials - Credentials that are trying to access the resource.
* @param resourceCache - Cache used to store ACR data.

View File

@@ -27,6 +27,7 @@ function getObjectValues(data: Store, subject: Term, predicate: NamedNode): stri
/**
* Finds the {@link IMatcher} with the given identifier in the given dataset.
*
* @param data - Dataset to look in.
* @param matcher - Identifier of the matcher.
*/
@@ -42,6 +43,7 @@ export function getMatcher(data: Store, matcher: Term): IMatcher {
/**
* Finds the {@link IPolicy} with the given identifier in the given dataset.
*
* @param data - Dataset to look in.
* @param policy - Identifier of the policy.
*/
@@ -58,6 +60,7 @@ export function getPolicy(data: Store, policy: Term): IPolicy {
/**
* Finds the {@link IAccessControl} with the given identifier in the given dataset.
*
* @param data - Dataset to look in.
* @param accessControl - Identifier of the access control.
*/
@@ -71,6 +74,7 @@ export function getAccessControl(data: Store, accessControl: Term): IAccessContr
/**
* Finds the {@link IAccessControlResource} with the given identifier in the given dataset.
*
* @param data - Dataset to look in.
* @param acr - Identifier of the access control resource.
*/
@@ -88,6 +92,7 @@ export function getAccessControlResource(data: Store, acr: Term): IAccessControl
/**
* Finds all {@link IAccessControlledResource} in the given dataset.
*
* @param data - Dataset to look in.
*/
export function* getAccessControlledResources(data: Store): Iterable<IAccessControlledResource> {

View File

@@ -24,6 +24,7 @@ export class PermissionBasedAuthorizer extends Authorizer {
/**
* The existence of the target resource determines the output status code for certain situations.
* The provided {@link ResourceSet} will be used for that.
*
* @param resourceSet - {@link ResourceSet} that can verify the target resource existence.
*/
public constructor(resourceSet: ResourceSet) {
@@ -77,6 +78,7 @@ export class PermissionBasedAuthorizer extends Authorizer {
* Ensures that at least one of the credentials provides permissions for the given mode.
* Throws a {@link ForbiddenHttpError} or {@link UnauthorizedHttpError} depending on the credentials
* if access is not allowed.
*
* @param credentials - Credentials that require access.
* @param permissionSet - PermissionSet describing the available permissions of the credentials.
* @param mode - Which mode is requested.
@@ -98,6 +100,7 @@ export class PermissionBasedAuthorizer extends Authorizer {
/**
* Checks whether the agent is authenticated (logged in) or not (public/anonymous).
*
* @param credentials - Credentials to check.
*/
private isAuthenticated(credentials: Credentials): boolean {

View File

@@ -96,6 +96,7 @@ export class WebAclReader extends PermissionReader {
/**
* Determines the available permissions for the given credentials.
*
* @param acl - Store containing all relevant authorization triples.
* @param credentials - Credentials to find the permissions for.
*/
@@ -223,6 +224,7 @@ export class WebAclReader extends PermissionReader {
/**
* Extracts all rules from the store that are relevant for the given target,
* based on either the `acl:accessTo` or `acl:default` predicates.
*
* @param store - Store to filter.
* @param target - The identifier of which the acl rules need to be known.
* @param directAcl - If the store contains triples from the direct acl resource of the target or not.

View File

@@ -29,6 +29,7 @@ export class AgentGroupAccessChecker extends AccessChecker {
/**
* Checks if the given agent is member of a given vCard group.
*
* @param webId - WebID of the agent that needs access.
* @param group - URL of the vCard group that needs to be checked.
*

View File

@@ -19,6 +19,7 @@ export class IntermediateCreateExtractor extends ModesExtractor {
/**
* Certain permissions depend on the existence of the target resource.
* The provided {@link ResourceSet} will be used for that.
*
* @param resourceSet - {@link ResourceSet} that can verify the target resource existence.
* @param strategy - {@link IdentifierStrategy} that will be used to determine parent containers.
* @param source - The source {@link ModesExtractor}.

View File

@@ -20,6 +20,7 @@ export class MethodModesExtractor extends ModesExtractor {
/**
* Certain permissions depend on the existence of the target resource.
* The provided {@link ResourceSet} will be used for that.
*
* @param resourceSet - {@link ResourceSet} that can verify the target resource existence.
*/
public constructor(resourceSet: ResourceSet) {

View File

@@ -22,6 +22,7 @@ export class N3PatchModesExtractor extends ModesExtractor {
/**
* Certain permissions depend on the existence of the target resource.
* The provided {@link ResourceSet} will be used for that.
*
* @param resourceSet - {@link ResourceSet} that can verify the target resource existence.
*/
public constructor(resourceSet: ResourceSet) {

View File

@@ -20,6 +20,7 @@ export class SparqlUpdateModesExtractor extends ModesExtractor {
/**
* Certain permissions depend on the existence of the target resource.
* The provided {@link ResourceSet} will be used for that.
*
* @param resourceSet - {@link ResourceSet} that can verify the target resource existence.
*/
public constructor(resourceSet: ResourceSet) {