efficy-enterprise-api/jsdoc.conf.json

The Efficy Enterprise API is developed for server-side usage in a Node.js environment (e.g. for integrations) and also bundled for usage inside an Efficy browser session for client-side JSON RPC requests.

{
	"plugins": [],
	"recurseDepth": 10,
	"source": {
		"include": [
			"./lib/crm-env.mjs",
			"./lib/crm-rpc.mjs",
			"./lib/remote-objects/dataset/dataset-object.mjs",
			"./lib/remote-objects/list/list-object.mjs",
			"./lib/remote-objects/base-type/string-object.mjs",
			"./lib/remote-objects/attachment/type.mjs",
			"./lib/remote-objects/api.mjs",
			"./lib/remote-objects/consult.mjs",
			"./lib/remote-objects/edit.mjs",
			"./lib/remote-objects/edit-relation.mjs",
			"./lib/ws-objects/ws-object.mjs",
			"./readme.md"
		],
		"includePattern": ".+\\.mjs?$",
		"excludePattern": "(^|\\/|\\\\)_"
	},
	"sourceType": "module",
	"tags": {
		"allowUnknownTags": true,
		"dictionaries": [
			"jsdoc",
			"closure"
		]
	},
	"templates": {
		"cleverLinks": true,
		"monospaceLinks": false,
		"logoFile": "",
		"dateFormat": "ddd MMM Do YYYY",
		"outputSourceFiles": true,
		"outputSourcePath": true,
		"systemName": "Efficy Enterprise API",
		"footer": "Efficy Enterprise API for Node.js and browser",
		"copyright": "Created by Kristof Pauwels",
		"includeDate": false,
		"navType": "vertical",
		"theme": "cosmo",
		"linenums": true,
		"collapseSymbols": false,
		"inverseNav": false,
		"protocol": "html://",
		"methodHeadingReturns": false,
		"default": {
			"useLongnameInNav": true,
			"includeDate": false
		}
	},
	"opts": {
		"template": "templates/default",
		"encoding": "utf8",
		"destination": "./docs/",
		"recurse": true,
		"tutorials": "./tutorials",
		"readme": "./jsdoc.index.md"
	}
}