docs: Change API docs template to jsdoc-clean-theme (#8519)

This commit is contained in:
Lucas Coratger
2023-04-29 16:53:54 +02:00
committed by GitHub
parent 177891ea0e
commit 9e43bc2fa0
17 changed files with 393 additions and 79 deletions

View File

@@ -7,7 +7,7 @@ import { isFunction, isString } from 'lodash';
/**
* A security check.
* @class Check
* @class
*/
class Check {
/**

View File

@@ -1,10 +1,7 @@
/**
* @module SecurityCheck
*/
/**
* A group of security checks.
* @interface CheckGroup
* @interface
* @memberof module:SecurityCheck
*/
class CheckGroup {
constructor() {

View File

@@ -1,7 +1,3 @@
/**
* @module SecurityCheck
*/
import { Check } from '../Check';
import CheckGroup from '../CheckGroup';
import Config from '../../Config';
@@ -9,7 +5,8 @@ import Parse from 'parse/node';
/**
* The security checks group for Parse Server configuration.
* Checks common Parse Server parameters such as access keys.
* Checks common Parse Server parameters such as access keys
* @memberof module:SecurityCheck
*/
class CheckGroupDatabase extends CheckGroup {
setName() {

View File

@@ -1,7 +1,3 @@
/**
* @module SecurityCheck
*/
import { Check } from '../Check';
import CheckGroup from '../CheckGroup';
import Config from '../../Config';
@@ -10,6 +6,7 @@ import Parse from 'parse/node';
/**
* The security checks group for Parse Server configuration.
* Checks common Parse Server parameters such as access keys.
* @memberof module:SecurityCheck
*/
class CheckGroupServerConfig extends CheckGroup {
setName() {

View File

@@ -1,5 +1,5 @@
/**
* @module SecurityCheck
* @memberof module:SecurityCheck
*/
/**

View File

@@ -1,7 +1,3 @@
/**
* @module SecurityCheck
*/
import Utils from '../Utils';
import { CheckState } from './Check';
import * as CheckGroups from './CheckGroups/CheckGroups';
@@ -10,6 +6,7 @@ import { isArray, isBoolean } from 'lodash';
/**
* The security check runner.
* @memberof module:SecurityCheck
*/
class CheckRunner {
/**