@author

Table of Contents

Syntax

@author <name> [<emailAddress>]

Overview

The @author tag identifies the author of an item. In JSDoc 3.2 and later, if the author's name is followed by an email address enclosed in angle brackets, the default template will convert the email address to a mailto: link.

Examples

Documenting the author of an item
/**
 * @author Jane Smith <[email protected]>
 */
function MyClass() {}

© 2011–2017 the contributors to the JSDoc 3 documentation project
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://jsdoc.app/tags-author.html