From 8932a6c08b691740a6e9f135b044c45c36a6acfd Mon Sep 17 00:00:00 2001 From: Maxim Vorontsov Date: Sat, 27 Aug 2022 12:17:07 +0500 Subject: [PATCH] repro for callable variable missing docs --- run.sh | 3 ++- src/index.ts | 10 ++++++++-- 2 files changed, 10 insertions(+), 3 deletions(-) mode change 100644 => 100755 run.sh diff --git a/run.sh b/run.sh old mode 100644 new mode 100755 index c7f88cd..ecf09a8 --- a/run.sh +++ b/run.sh @@ -20,4 +20,5 @@ set -v # if TypeDoc's output doesn't match what you expected. Here's one example # checking that the name from package.json is used in TypeDoc's output. -test $(jq '.name' docs/docs.json) = '"typedoc-repros"' +test $(jq '.children[0].signatures[0].comment.summary[0].text' docs/docs.json) = '"exported-docs"' +test $(jq '.children[0].signatures[0].parameters[0].comment.summary[0].text' docs/docs.json) = '"param-docs"' diff --git a/src/index.ts b/src/index.ts index c0a8215..a5b7bc8 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,4 +1,10 @@ +const obj = { + /** function-docs */ + fn(x: unknown) {} +} + /** - * Some code reproducing a bug. + * exported-docs + * @param x param-docs */ -export const bug = 123; +export const bug = obj.fn;