Module: jsdoc/borrow

A collection of functions relating to resolving @borrows tags in JSDoc symbols.
Author:
License:
  • Apache License 2.0 - See file 'LICENSE.md' in this project.
Source:

Methods

(static) resolveBorrows()

Take a copy of the docs for borrowed symbols and attach them to the docs for the borrowing symbol. This process changes the symbols involved, moving docs from the "borrowed" array and into the general docs, then deleting the "borrowed" array.
Source: