docs: Change API docs template to jsdoc-clean-theme (#8519)
This commit is contained in:
@@ -1,9 +1,7 @@
|
||||
/*eslint no-unused-vars: "off"*/
|
||||
/**
|
||||
* @module Adapters
|
||||
*/
|
||||
/**
|
||||
* @interface AnalyticsAdapter
|
||||
* @module Adapters
|
||||
*/
|
||||
export class AnalyticsAdapter {
|
||||
/**
|
||||
|
||||
@@ -1,9 +1,7 @@
|
||||
/*eslint no-unused-vars: "off"*/
|
||||
/**
|
||||
* @module Adapters
|
||||
*/
|
||||
/**
|
||||
* @interface CacheAdapter
|
||||
* @interface
|
||||
* @memberof module:Adapters
|
||||
*/
|
||||
export class CacheAdapter {
|
||||
/**
|
||||
|
||||
@@ -1,9 +1,7 @@
|
||||
/*eslint no-unused-vars: "off"*/
|
||||
/**
|
||||
* @module Adapters
|
||||
*/
|
||||
/**
|
||||
* @interface MailAdapter
|
||||
* @interface
|
||||
* @memberof module:Adapters
|
||||
* Mail Adapter prototype
|
||||
* A MailAdapter should implement at least sendMail()
|
||||
*/
|
||||
|
||||
@@ -19,10 +19,8 @@
|
||||
import type { Config } from '../../Config';
|
||||
import Parse from 'parse/node';
|
||||
/**
|
||||
* @module Adapters
|
||||
*/
|
||||
/**
|
||||
* @interface FilesAdapter
|
||||
* @interface
|
||||
* @memberof module:Adapters
|
||||
*/
|
||||
export class FilesAdapter {
|
||||
/** Responsible for storing the file in order to be retrieved later by its filename
|
||||
|
||||
@@ -1,9 +1,7 @@
|
||||
/*eslint no-unused-vars: "off"*/
|
||||
/**
|
||||
* @module Adapters
|
||||
*/
|
||||
/**
|
||||
* @interface LoggerAdapter
|
||||
* @interface
|
||||
* @memberof module:Adapters
|
||||
* Logger Adapter
|
||||
* Allows you to change the logger mechanism
|
||||
* Default is WinstonLoggerAdapter.js
|
||||
|
||||
@@ -1,9 +1,7 @@
|
||||
/*eslint no-unused-vars: "off"*/
|
||||
/**
|
||||
* @module Adapters
|
||||
*/
|
||||
/**
|
||||
* @interface PubSubAdapter
|
||||
* @interface
|
||||
* @memberof module:Adapters
|
||||
*/
|
||||
export class PubSubAdapter {
|
||||
/**
|
||||
|
||||
@@ -12,10 +12,8 @@
|
||||
// android push and APNS for ios push.
|
||||
|
||||
/**
|
||||
* @module Adapters
|
||||
*/
|
||||
/**
|
||||
* @interface PushAdapter
|
||||
* @interface
|
||||
* @memberof module:Adapters
|
||||
*/
|
||||
export class PushAdapter {
|
||||
/**
|
||||
|
||||
@@ -11,10 +11,8 @@
|
||||
// Default is WSAdapter. The above functions will be binded.
|
||||
|
||||
/**
|
||||
* @module Adapters
|
||||
*/
|
||||
/**
|
||||
* @interface WSSAdapter
|
||||
* @interface
|
||||
* @memberof module:Adapters
|
||||
*/
|
||||
export class WSSAdapter {
|
||||
/**
|
||||
|
||||
@@ -7,7 +7,7 @@ import { isFunction, isString } from 'lodash';
|
||||
|
||||
/**
|
||||
* A security check.
|
||||
* @class Check
|
||||
* @class
|
||||
*/
|
||||
class Check {
|
||||
/**
|
||||
|
||||
@@ -1,10 +1,7 @@
|
||||
/**
|
||||
* @module SecurityCheck
|
||||
*/
|
||||
|
||||
/**
|
||||
* A group of security checks.
|
||||
* @interface CheckGroup
|
||||
* @interface
|
||||
* @memberof module:SecurityCheck
|
||||
*/
|
||||
class CheckGroup {
|
||||
constructor() {
|
||||
|
||||
@@ -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() {
|
||||
|
||||
@@ -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() {
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/**
|
||||
* @module SecurityCheck
|
||||
* @memberof module:SecurityCheck
|
||||
*/
|
||||
|
||||
/**
|
||||
|
||||
@@ -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 {
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user