Skip to content

Commit 5e03316

Browse files
Add WindowOptions to docs
Typedoc doesn't currently support @ignore - it uses @hidden. (See TypeStrong/typedoc#198). Adding @hidden alongside the @ignore correctly supresses the fin.WindowOptions, which was generating invalid json (an array within an array for the child property), and correctly creates the WindowOptions documentation.
1 parent 430120b commit 5e03316

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

packages/api-specification/interface/openfin-extension.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
/**
22
* @ignore
3+
* @hidden
34
*/
45
declare namespace fin {
56
interface OpenFinWindow {

packages/api-specification/interface/window-extension.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,15 @@
77

88
/**
99
* @ignore
10+
* @hidden
1011
*/
1112
declare interface Screen {
1213
orientation: Orientation;
1314
}
1415

1516
/**
1617
* @ignore
18+
* @hidden
1719
*/
1820
interface Orientation {
1921
angle: number;

0 commit comments

Comments
 (0)