Skip to content

Commit eff9913

Browse files
committed
note that the module: prefix is not allowed prior to 3.3.0 (#65)
1 parent 780ab1c commit eff9913

File tree

4 files changed

+12
-4
lines changed

4 files changed

+12
-4
lines changed

content/en/tags-exports.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ related:
1111

1212
`@exports <moduleName>`
1313

14+
In JSDoc 3.3.0 and later, `<moduleName>` may include the `module:` prefix. In previous versions, you
15+
must omit this prefix.
16+
1417

1518
## Overview
1619

content/en/tags-module.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,12 @@ related:
99

1010
## Syntax
1111

12-
`@module [[{<type>}] <ModuleName>]`
12+
`@module [[{<type>}] <moduleName>]`
1313

14-
Note: If you provide a type, you _must_ also provide a name.`
14+
In JSDoc 3.3.0 and later, `<moduleName>` may include the `module:` prefix. In previous versions, you
15+
must omit this prefix.
16+
17+
Note: If you provide a type, you _must_ also provide a name.
1518

1619

1720
## Overview

tags-exports.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ <h2>Table of Contents</h2>
4040
<h2 id="syntax">Syntax</h2>
4141
<p><code>@exports &lt;moduleName&gt;</code>
4242
</p>
43+
<p>In JSDoc 3.3.0 and later, <code>&lt;moduleName&gt;</code> may include the <code>module:</code> prefix. In previous versions, you must omit this prefix.</p>
4344
<h2 id="overview">Overview</h2>
4445
<p>Use the @exports tag when documenting JavaScript modules that export anything other than the &quot;exports&quot; object or the &quot;module.exports&quot; property.</p>
4546
<h2 id="examples">Examples</h2>

tags-module.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,10 @@ <h2>Table of Contents</h2>
3838
</li>
3939
</ul>
4040
<h2 id="syntax">Syntax</h2>
41-
<p><code>@module [[{&lt;type&gt;}] &lt;ModuleName&gt;]</code>
41+
<p><code>@module [[{&lt;type&gt;}] &lt;moduleName&gt;]</code>
4242
</p>
43-
<p>Note: If you provide a type, you <em>must</em> also provide a name.`</p>
43+
<p>In JSDoc 3.3.0 and later, <code>&lt;moduleName&gt;</code> may include the <code>module:</code> prefix. In previous versions, you must omit this prefix.</p>
44+
<p>Note: If you provide a type, you <em>must</em> also provide a name.</p>
4445
<h2 id="overview">Overview</h2>
4546
<p>The @module tag marks the current file as being its own module. All symbols in the file are assumed to be members of the module unless documented otherwise.</p>
4647
<p>Link to a module (e.g. within a <a href="tags-link.html">@link</a> or <a href="tags-see.html">@see</a> tag) using &quot;module:moduleName&quot;. For example,

0 commit comments

Comments
 (0)