Home

module: JSDocTypedefs

Typedefs

JSDocRecord: Object

A JSDoc doclet record.

Properties

Name	Type	Attribute	Description
comment	String	optional	The raw documentation comment of the record if any
meta	JSDocMeta		Metadata about how this record relates to the source code
description	String	optional	The `@description` value of the record if any. If using `plugins/markdown` this string will be compiled in HTML
returns	Array.<JSDocReturns>	optional	What is returned by documented symbol
name	String		Shortname of the record parsed by JSDoc or overridden using `@name`
longname	String		Longname of the record (name including `memberof` info)
kind	String		Kind of record deduced by JSDoc or overridden using `@kind`
memberof	String	optional	Longname of the parent symbol. Can be overridden using `@memberof`
params	Array.<JSDocParam>		A collection of parameters information
properties	Array.<JSDocProperty>		A collection of properties information
filepath	String		Path of thte source file for this record

JSDocReturns: Object

A JSDoc returns data structure

Properties

Name	Type	Attribute	Description
type	JSDocTypeInfo		Return type information
description	String	optional	An optional return description

JSDocTypeInfo: Object

A JSDoc Type information structure

Properties

Name	Type	Attribute	Description
names	Array.<String>		An array containing type names (short version).

JSDocParam: Object

A JSDoc parameter data structure

JSDocProperty: Object

A JSDoc property data structure