Skip to content

Add a warning when a common mistake is detected: @module tag required #96

Closed
@75lb

Description

@75lb

Print a warning and a link to the wiki when the most common user mistake is detected: @module tag required, documented here.

Warning output to look something like this:

Module tag required in this file: /Users/lloyd/Documents/example-src.js
See the wiki for an explanation: https://github.com/jsdoc2md/jsdoc-to-markdown/wiki/How-to-document-an-ES2015-module-(single-default-export)

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