jsdoc: Note that importing is TypeScript-specific

2019-03-24 07:34:48 +08:00 · 2019-03-24 07:34:48 +08:00 · 94db676cfe
parent fa9f16c5ee
commit 94db676cfe
1 changed files with 7 additions and 3 deletions
--- a/jsdoc.md
+++ b/jsdoc.md
@ -79,18 +79,22 @@ function play (song) {

 See: <http://usejsdoc.org/tags-typedef.html>

-### Importing Types
+### Importing types
+
 ```js
 /**
- * @typedef {import('Foo').default} Bar
+ * @typedef {import('./Foo').default} Bar
 */
- 
+
 /**
 * @param {Bar} x
 */
+
 function test(x) { }
 ```

+This syntax is [TypeScript-specific](https://github.com/Microsoft/TypeScript/wiki/JsDoc-support-in-JavaScript#import-types).
+
 ### Other keywords

 ```js