My favorites | Sign in
Project Home Downloads Wiki Issues Source
Search
for
TagThrows  
@throws
Updated Aug 4, 2011 by micm...@gmail.com

The @throws Tag

The @throws tag allows you to document the exception a function might throw.

Syntax

@throws {exceptionType} exceptionDescription
  • exceptionType - Optional: the type of exception this function might throw.
  • exceptionDescription - Optional: any additional description.

Example

/** 
 * @throws {OutOfMemeory} If the file is too big.
 */
function processFile(path) {

}
Powered by Google Project Hosting