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
I would expect TypeDoc v0.25.5/6 to behave like v0.25.4.
In the following code, both the function-namespace (test) and the inner type (test.Options) should be documented.
/** * Test function * * @param options Options for the function. */declarefunctiontest(options?: test.Options): void;declarenamespacetest{/** Test options */interfaceOptions{a: string;b: number;}}export{test};
Actual Behavior
Only the function-namespace (test) is documented.
On the command line I see this warning:
[warning] test.Options, defined in ./index.ts, is referenced by test.test.options but not included in the documentation.
I can work around this problem by adding a second export keyword directly on the namespace declaration (see below), but that should not be necessary.
/** * Test function * * @param options Options for the function. */declarefunctiontest(options?: test.Options): void;exportdeclarenamespacetest// redundant export{/** Test options */interfaceOptions{a: string;b: number;}}export{test};
Well, that's annoying, apparently the symbol flags for namespaces don't mean what I thought they did.. this case shouldn't be caught by the change for #2461.
Thanks! The documentation for function-namespaces is working for me in v0.25.7. Now I'm experiencing another seemingly related problem. I'm going to open a separate issue.
Search terms
function, namespace
Expected Behavior
I would expect TypeDoc v0.25.5/6 to behave like v0.25.4.
In the following code, both the function-namespace (
test
) and the inner type (test.Options
) should be documented.Actual Behavior
Only the function-namespace (
test
) is documented.On the command line I see this warning:
[warning] test.Options, defined in ./index.ts, is referenced by test.test.options but not included in the documentation.
I can work around this problem by adding a second
export
keyword directly on the namespace declaration (see below), but that should not be necessary.Steps to reproduce the bug
Repro: https://stackblitz.com/edit/stackblitz-starters-qqddz8
Environment
The text was updated successfully, but these errors were encountered: