Skip to content

Commit cb69542

Browse files
committed
docs: ship TSDoc config (#453)
Signed-off-by: Jan Kowalleck <[email protected]>
1 parent b2081a2 commit cb69542

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

.npmignore

+4-4
Original file line numberDiff line numberDiff line change
@@ -157,14 +157,14 @@ dist
157157
!/dist/
158158
!/dist.*/
159159

160-
# TypeScript source files are intended to be shipped,
161-
# as they can provide additional context for downstream users.
162-
# The compiler configs are shipped, so downstream users can inherit from them.
163-
# The TypeDoc configs are shipped, so downstream users can generate API documentation with them.
160+
# TypeScript source files are intended to be shipped, as they can provide additional context for downstream users.
161+
# The TSCompiler configs are shipped, so downstream users can inherit from them.
162+
# The TypeDoc & TSDoc configs are shipped, so downstream users can generate API documentation with them.
164163
!/src/
165164
!/tsconfig.*
166165
!/webpack.*
167166
!/typedoc.*
167+
!/tsdoc.json
168168

169169
/test/
170170
/tests/

HISTORY.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@ All notable changes to this project will be documented in this file.
55
## unreleased
66

77
* Docs
8-
* Use [TSDoc](https://tsdoc.org/) syntax in TypeScript files, instead of [JSDoc](https://jsdoc.app/) (via [#318])
8+
* Use [TSDoc](https://tsdoc.org/) syntax in TypeScript files, instead of [JSDoc](https://jsdoc.app/) (via [#318], [#453])
99

1010
[#318]: https://github.com/CycloneDX/cyclonedx-javascript-library/pull/318
11+
[#453]: https://github.com/CycloneDX/cyclonedx-javascript-library/pull/453
1112

1213
## 1.10.0 - 2023-01-28
1314

0 commit comments

Comments
 (0)