From 784e35166dd237d210fd3cb36b494f18d9f732b0 Mon Sep 17 00:00:00 2001 From: Brett Zamir Date: Thu, 2 Feb 2023 10:47:49 -0700 Subject: [PATCH] docs(`valid-types`): update namepath-accepting listing; fixes #401 --- .README/rules/valid-types.md | 7 ++++--- README.md | 7 ++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/.README/rules/valid-types.md b/.README/rules/valid-types.md index fc544154a..a29a2a279 100644 --- a/.README/rules/valid-types.md +++ b/.README/rules/valid-types.md @@ -32,7 +32,8 @@ The following tags have their name/namepath portion (the non-whitespace text after the tag name) checked: 1. Name(path)-defining tags requiring namepath: `@event`, `@callback`, - `@external`, `@host`, `@name`, `@typedef`, and `@template` + `@exports` (JSDoc only), + `@external`, `@host`, `@name`, `@typedef` (JSDoc only), and `@template` (TypeScript/Closure only); `@param` (`@arg`, `@argument`) and `@property` (`@prop`) also fall into this category, but while this rule will check their namepath validity, we leave the requiring of the name portion @@ -41,11 +42,11 @@ text after the tag name) checked: 1. Name(path)-defining tags (which may have value without namepath or their namepath can be expressed elsewhere on the block): `@class`, `@constructor`, `@constant`, `@const`, `@function`, `@func`, - `@method`, `@interface` (TypeScript tag only), `@member`, `@var`, + `@method`, `@interface` (non-Closure only), `@member`, `@var`, `@mixin`, `@namespace`, `@module` (module paths are not planned for TypeScript) 1. Name(path)-pointing tags requiring namepath: `@alias`, `@augments`, - `@extends`, `@lends`, `@memberof`, `@memberof!`, `@mixes`, `@this` + `@extends` (JSDoc only), `@lends`, `@memberof`, `@memberof!`, `@mixes`, `@requires`, `@this` (jsdoc only) 1. Name(path)-pointing tags (which may have value without namepath or their namepath can be expressed elsewhere on the block): `@listens`, `@fires`, diff --git a/README.md b/README.md index 2c7f8422b..77d727863 100644 --- a/README.md +++ b/README.md @@ -22635,7 +22635,8 @@ The following tags have their name/namepath portion (the non-whitespace text after the tag name) checked: 1. Name(path)-defining tags requiring namepath: `@event`, `@callback`, - `@external`, `@host`, `@name`, `@typedef`, and `@template` + `@exports` (JSDoc only), + `@external`, `@host`, `@name`, `@typedef` (JSDoc only), and `@template` (TypeScript/Closure only); `@param` (`@arg`, `@argument`) and `@property` (`@prop`) also fall into this category, but while this rule will check their namepath validity, we leave the requiring of the name portion @@ -22644,11 +22645,11 @@ text after the tag name) checked: 1. Name(path)-defining tags (which may have value without namepath or their namepath can be expressed elsewhere on the block): `@class`, `@constructor`, `@constant`, `@const`, `@function`, `@func`, - `@method`, `@interface` (TypeScript tag only), `@member`, `@var`, + `@method`, `@interface` (non-Closure only), `@member`, `@var`, `@mixin`, `@namespace`, `@module` (module paths are not planned for TypeScript) 1. Name(path)-pointing tags requiring namepath: `@alias`, `@augments`, - `@extends`, `@lends`, `@memberof`, `@memberof!`, `@mixes`, `@this` + `@extends` (JSDoc only), `@lends`, `@memberof`, `@memberof!`, `@mixes`, `@requires`, `@this` (jsdoc only) 1. Name(path)-pointing tags (which may have value without namepath or their namepath can be expressed elsewhere on the block): `@listens`, `@fires`,