jsdoc.js

"use strict";
let elements = {
	abstract: {
		desc: "This member must be implemented (or overridden) by the inheritor.",
	},
	access: {
		desc: "Specify the access level of this member (private, public, or protected).",
		detail: "<private|protected|public>",
		snip: "{{private|protected|public}}"
	},
	alias: {
		desc: "Treat a member as if it had a different name.",
		detail: "<aliasNamepath>",
		snip: "{{aliasNamepath}}"
	},
	augments: {
		desc: "Indicate that a symbol inherits from, ands adds to, a parent symbol.",
		detail: "<namepath>",
		snip: "{{namepath}}"
	},
	author: {
		desc: "Identify the author of an item.",
		detail: "<name> [<emailAddress>]",
		snip: "{{name}} {{emailAddress}}"
	},
	borrows: {
		desc: "This object uses something from another object.",
		detail: "<that namepath> as <this namepath>",
		snip: "{{refNamePath}} as {{thisNamePath}}"
	},
	callback: {
		desc: "Document a callback function.",
		detail: "<namepath>",
		snip: "{{namepath}}"
	},
	class: {
		desc: "This function is intended to be called with the \"new\" keyword.",
		detail: "[<type> <name>]",
		snip: "\\{{{type}}\\} {{name}}"
	},
	classdesc: {
		desc: "Use the following text to describe the entire class.",
		detail: "<some description>",
		snip: "{{description}}"
	},
	constant: {
		desc: "Document an object as a constant.",
		detail: "[<type> <name>]",
		snip: "\\{{{type}}\\} {{name}}"
	},
	constructs: {
		desc: "This function member will be the constructor for the previous class.",
		detail: "[<name>]",
		snip: "{{name}}"
	},
	copyright: {
		desc: "Document some copyright information.",
		detail: "<copyright text>",
		snip: "{{copyright text}}"
	},
	default: {
		desc: "Document the default value.",
		detail: "[<some value>]",
		snip: "{{value}}"
	},
	deprecated: {
		desc: "Document that this is no longer the preferred way.",
		detail: "[<some text>]",
		snip: "{{text}}"
	},
	description: {
		desc: "Describe a symbol.",
		detail: "<some description>",
		snip: "{{description}}"
	},
	enum: {
		desc: "Document a collection of related properties.",
		detail: "[<type>]",
		snip: "\\{{{type}}\\}"
	},
	event: {
		desc: "Document an event.",
		detail: "<classname>#[event:]<eventName>",
		snip: "{{classname}}#{{eventName}}"
	},
	example: {
		desc: "Provide an example of how to use a documented item."
	},
	exports: {
		desc: "Identify the member that is exported by a JavaScript module.",
		detail: "<moduleName>",
		snip: "{{moduleName}}"
	},
	external: {
		desc: "Identifies an external class, namespace, or module.",
		detail: "<nameOfExternal>",
		snip: "{{nameOfExternal}}"
	},
	file: {
		desc: "Describe a file."
	},
	fires: {
		desc: "Describe the events this method may fire.",
		detail: "<classname>#[event:]<eventName>",
		snip: "{{classname}}#{{eventName}}"
	},
	function: {
		desc: "Describe a function or method.",
		detail: "[<FunctionName>]",
		snip: "{{FunctionName}}"
	},
	global: {
		desc: "Document a global object."
	},
	ignore: {
		desc: "Omit a symbol from the documentation."
	},
	implements: {
		desc: "This symbol implements an interface.",
		detail: "{<typeExpression>}",
		snip: "\\{{{typeExpression}}\\}"
	},
	inheritdoc: {
		desc: "Indicate that a symbol should inherit its parent's documentation."
	},
	inner: {
		desc: "Document an inner object."
	},
	instance: {
		desc: "Document an instance member."
	},
	interface: {
		desc: "This symbol is an interface that others can implement.",
		detail: "[<name>]",
		snip: "{{name}}"
	},
	kind: {
		desc: "What kind of symbol is this?",
		detail: "<kindName>",
		snip: "{{class|constant|event|external|file|function|member|mixin|module|namespace|typedef}}"
	},
	lends: {
		desc: "Document properties on an object literal as if they belonged to a symbol with a given name.",
		detail: "<namepath>",
		snip: "{{namepath}}"
	},
	license: {
		desc: "Identify the license that applies to this code.",
		detail: "<identifier>",
		snip: "{{identifier}}"
	},
	listens: {
		desc: "List the events that a symbol listens for.",
		detail: "<eventName>",
		snip: "{{eventName}}"
	},
	member: {
		desc: "Document a member.",
		detail: "[<type>] [<name>]",
		snip: "\\{{{type}}\\} {{name}}"
	},
	memberof: {
		desc: "This symbol belongs to a parent symbol.",
		detail: "<parentNamepath>",
		snip: "{{parentNamepath}}"
	},
	"memberof!": {
		desc: "Force this symbol to belongs to a parent symbol.",
		detail: "<parentNamepath>",
		snip: "{{parentNamepath}}"
	},
	mixes: {
		desc: "This object mixes in all the members from another object.",
		detail: "<otherObjectPath>",
		snip: "{{otherObjectPath}}"
	},
	mixin: {
		desc: "Document a mixin object.",
		detail: "[<mixinName>]",
		snip: "{{mixinName}}"
	},
	module: {
		desc: "Document a JavaScript module.",
		detail: "[[{<type>}] <moduleName>]",
		snip: "\\{{{type}}\\} {{moduleName}}"
	},
	name: {
		desc: "Document the name of an object.",
		detail: "<namepath>",
		snip: "{{namepath}}"
	},
	namespace: {
		desc: "Document a namespace object.",
		detail: "[[{<type>}] <SomeName>]",
		snip: "\\{{{type}}\\} {{SomeName}}"
	},
	override: {
		desc: "Indicate that a symbol overrides its parent."
	},
	param: {
		desc: " Document the parameter to a function.",
		detail: "[[{<type>}] <name> [<Param description>]]",
		snip: "\\{{{type}}\\} {{name}} {{description}}"
	},
	private: {
		desc: "This symbol is meant to be private."
	},
	property: {
		desc: "Document a property of an object.",
		detail: "[[{<type>}] <name> [<Property description>]]",
		snip: "\\{{{type}}\\} {{name}} {{description}}"
	},
	protected: {
		desc: "This symbol is meant to be protected."
	},
	public: {
		desc: "This symbol is meant to be public."
	},
	readonly: {
		desc: "This symbol is meant to be read-only."
	},
	requires: {
		desc: "This file requires a JavaScript module.",
		detail: "<someModuleName>",
		snip: "{{someModuleName}}"
	},
	returns: {
		desc: "Document the return value of a function.",
		detail: "[{<type>} [<Return description>]]",
		snip: "\\{{{type}}\\} {{description}}"
	},
	see: {
		desc: "Refer to some other documentation for more information.",
		detail: "<namepath>|<text>",
		snip: "{{namepath|text}}"
	},
	since: {
		desc: "When was this feature added?",
		detail: "<versionDescription>",
		snip: "{{versionDescription}}"
	},
	static: {
		desc: "Document a static member."
	},
	summary: {
		desc: "A shorter version of the full description."
	},
	this: {
		desc: "What does the 'this' keyword refer to here?",
		detail: "<namepath>",
		snip: "{{namepath}}"
	},
	throws: {
		desc: "Describe what errors could be thrown.",
		detail: "[{<type>}] [<free-form description>]",
		snip: "\\{{{type}}\\} {{description}}"
	},
	todo: {
		desc: "Document tasks to be completed."
	},
	tutorial: {
		desc: "Insert a link to an included tutorial file."
	},
	type: {
		desc: "Document the type of an object.",
		detail: "{typeName}",
		snip: "\\{{{typeName}}\\}"
	},
	typedef: {
		desc: "Document a custom type.",
		detail: "[<type>] <namepath>",
		snip: "\\{{{type}}\\} {{namepath}}"
	},
	variation: {
		desc: "Distinguish different objects with the same name.",
		detail: "<variationNumber>",
		snip: "{{variationNumber}}"
	},
	version: {
		desc: "Documents the version number of an item.",
		detail: "<versionDescription>",
		snip: "{{versionDescription}}"
	}
};

//synonyms
elements.virtual = elements.abstract;
elements.extends = elements.augments;
elements.constructor = elements.class;
elements.const = elements.constant;
elements.defaultvalue = elements.default;
elements.desc = elements.description;
elements.host = elements.external;
elements.fileoverview = elements.overview = elements.file;
elements.emits = elements.fires;
elements.func = elements.method = elements.function;
elements.var = elements.method;
elements.arg = elements.argument = elements.param;
elements.prop = elements.property;
elements.return = elements.returns;
elements.exception = elements.throws;

module.exports = elements;