Skip to content

Documenting since and exceptions for Haruki #1504

@seanoshea

Description

@seanoshea

I'd like to be able to document since and throws tags for Haruki.

Input code

/**
 * This is my class which I want to annotate with a since tag.
 * @since 1.0.0
 */
class MyClass {

OR

  /**
   * @throws {@link error.APIError} is all goes wrong.
   */
  static aFunctionThatThrows() {
  }

JSDoc configuration

N/A - Haruki does not support these tags at the moment.

JSDoc debug output

N/A - Haruki does not support these tags at the moment.

Expected behavior

Haruki should parse these tags and present them in xml format.

Current behavior

Tags are ignored

Your environment

Software Version
JSDoc 3.5.4
Node.js 6.10.2
npm 5.5.1
Operating system Mac

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions