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
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -55,7 +55,7 @@ The TSDoc specification aims to meet these requirements:
55
55
-**Common core**: Common tags such as `@param` and `@returns` will have consistent behavior across all tools.
56
56
-**Extensible**: Each tool can supplement the core tags with custom tags for specialized scenarios.
57
57
-**Interoperable**: The TSDoc standard guarantees that unsupported custom tags won't interfere with parsing of other content. TSDoc also eliminates Markdown ambiguities. (Are backticks allowed inside a `{@link}` tag? What happens if there is only one backtick? etc.)
58
-
-**Multi-package support**: Many teams ship a collection of NPM packages that work together and are documented as a set. The cross-referencing syntax (e.g. `{@link}` or `{@inheritdoc}`) needs a portable way to reference API items imported from other packages. We also define *package.json* metadata that enables tooling to detect whether a dependency's *.d.ts doc comments should be parsed as TSDoc or not.
58
+
-**Multi-package support**: Many teams ship a collection of NPM packages that work together and are documented as a set. The cross-referencing syntax (e.g. `{@link}` or `{@inheritDoc}`) needs a portable way to reference API items imported from other packages. We also define *package.json* metadata that enables tooling to detect whether a dependency's *.d.ts doc comments should be parsed as TSDoc or not.
59
59
-**Open standard**: TSDoc is an open source, community-driven standard. You are encouraged to contribute your own ideas and pull requests.
60
60
61
61
The **@microsoft/tsdoc** library package brings in some additional goals:
0 commit comments