You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-3Lines changed: 11 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,9 +27,7 @@ In the absence of `typescript.moduleRoot`, the plugin will mirror the method JSD
27
27
28
28
1. Parse the referenced module for an `@module` tag.
29
29
2. If a tag is found and it has an explicit id, use that.
30
-
3. If a tag is found, but it doesn't have an explicit id, use the module's file path relative to the root directory, and remove the file extension.
31
-
32
-
**NOTE:** The root directory will be `process.cwd()` unless any source files are outside it, in which case, the root folder is considered the nearest shared parent directory of all source files.
30
+
3. If a tag is found, but it doesn't have an explicit id, use the module's file path relative to the nearest shared parent directory, and remove the file extension.
33
31
34
32
## What this plugin does
35
33
@@ -44,31 +42,36 @@ TypeScript and JSDoc use a different syntax for imported types. This plugin conv
0 commit comments