Skip to content

Commit e3dbbea

Browse files
committed
[docs] Mark Svelte components as functions
The Svelte components are declared as Component constants. From typedoc 0.28, which tinydocs 0.1.76 uses, a variable of a callable type is only documented as a function when it has an @function tag. Without one, each component became a variable, at a different URL and with no signature.
1 parent f1be7c6 commit e3dbbea

3 files changed

Lines changed: 33 additions & 0 deletions

File tree

‎src/@types/ui-svelte-dom/docs.js‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -818,6 +818,7 @@
818818
* </table>
819819
* `;
820820
* ```
821+
* @function
821822
* @category Store components
822823
* @since v4.1.0
823824
*/
@@ -1005,6 +1006,7 @@
10051006
* </table>
10061007
* `;
10071008
* ```
1009+
* @function
10081010
* @category Store components
10091011
* @since v4.1.0
10101012
*/
@@ -1145,6 +1147,7 @@
11451147
* </table>
11461148
* `;
11471149
* ```
1150+
* @function
11481151
* @category Store components
11491152
* @since v4.1.0
11501153
*/
@@ -1313,6 +1316,7 @@
13131316
* </table>
13141317
* `;
13151318
* ```
1319+
* @function
13161320
* @category Other components
13171321
* @since v4.1.0
13181322
*/
@@ -1498,6 +1502,7 @@
14981502
* </table>
14991503
* `;
15001504
* ```
1505+
* @function
15011506
* @category Other components
15021507
* @since v4.1.0
15031508
*/
@@ -1664,6 +1669,7 @@
16641669
* </table>
16651670
* `;
16661671
* ```
1672+
* @function
16671673
* @category Queries components
16681674
* @since v4.1.0
16691675
*/
@@ -1853,6 +1859,7 @@
18531859
* </table>
18541860
* `;
18551861
* ```
1862+
* @function
18561863
* @category Queries components
18571864
* @since v4.1.0
18581865
*/
@@ -1923,6 +1930,7 @@
19231930
* </div>
19241931
* `;
19251932
* ```
1933+
* @function
19261934
* @category Store components
19271935
* @since v4.1.0
19281936
*/
@@ -1993,6 +2001,7 @@
19932001
* </div>
19942002
* `;
19952003
* ```
2004+
* @function
19962005
* @category Store components
19972006
* @since v4.1.0
19982007
*/
@@ -2082,6 +2091,7 @@
20822091
* </table>
20832092
* `;
20842093
* ```
2094+
* @function
20852095
* @category Store components
20862096
* @since v4.1.0
20872097
*/

‎src/@types/ui-svelte-inspector/docs.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@
6868
* console.log(typeof Inspector);
6969
* // -> 'function'
7070
* ```
71+
* @function
7172
* @category Development components
7273
* @essential Using Svelte
7374
* @since v8.2.0

‎src/@types/ui-svelte/docs.js‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1263,6 +1263,7 @@
12631263
* // <App />
12641264
* // </Provider>
12651265
* ```
1266+
* @function
12661267
* @category Component
12671268
* @since v8.1.0
12681269
*/
@@ -1309,6 +1310,7 @@
13091310
* console.log(app.textContent);
13101311
* // -> ''
13111312
* ```
1313+
* @function
13121314
* @category Component
13131315
* @since v8.1.0
13141316
*/
@@ -1352,6 +1354,7 @@
13521354
* console.log(app.textContent);
13531355
* // -> 'dog'
13541356
* ```
1357+
* @function
13551358
* @category Component
13561359
* @since v8.1.0
13571360
*/
@@ -1396,6 +1399,7 @@
13961399
* console.log(app.textContent);
13971400
* // -> ''
13981401
* ```
1402+
* @function
13991403
* @category Component
14001404
* @since v8.1.0
14011405
*/
@@ -1442,6 +1446,7 @@
14421446
* console.log(app.textContent);
14431447
* // -> '0'
14441448
* ```
1449+
* @function
14451450
* @category Component
14461451
* @since v8.1.0
14471452
*/
@@ -1488,6 +1493,7 @@
14881493
* console.log(app.textContent);
14891494
* // -> ''
14901495
* ```
1496+
* @function
14911497
* @category Component
14921498
* @since v8.1.0
14931499
*/
@@ -1538,6 +1544,7 @@
15381544
* console.log(app.textContent);
15391545
* // -> 'dog cat'
15401546
* ```
1547+
* @function
15411548
* @category Component
15421549
* @since v8.1.0
15431550
*/
@@ -1595,6 +1602,7 @@
15951602
* console.log(app.textContent);
15961603
* // -> 'fido felix'
15971604
* ```
1605+
* @function
15981606
* @category Component
15991607
* @since v8.1.0
16001608
*/
@@ -1646,6 +1654,7 @@
16461654
* console.log(app.textContent);
16471655
* // -> 'fido'
16481656
* ```
1657+
* @function
16491658
* @category Component
16501659
* @since v8.1.0
16511660
*/
@@ -1694,6 +1703,7 @@
16941703
* console.log(app.textContent);
16951704
* // -> '2'
16961705
* ```
1706+
* @function
16971707
* @category Component
16981708
* @since v8.1.0
16991709
*/
@@ -1745,6 +1755,7 @@
17451755
* console.log(app.textContent);
17461756
* // -> 'dog'
17471757
* ```
1758+
* @function
17481759
* @category Component
17491760
* @since v8.1.0
17501761
*/
@@ -1793,6 +1804,7 @@
17931804
* console.log(app.textContent);
17941805
* // -> 'brown'
17951806
* ```
1807+
* @function
17961808
* @category Component
17971809
* @since v8.1.0
17981810
*/
@@ -1843,6 +1855,7 @@
18431855
* console.log(app.textContent);
18441856
* // -> 'color'
18451857
* ```
1858+
* @function
18461859
* @category Component
18471860
* @since v8.1.0
18481861
*/
@@ -1899,6 +1912,7 @@
18991912
* console.log(app.textContent);
19001913
* // -> 'felix fido'
19011914
* ```
1915+
* @function
19021916
* @category Component
19031917
* @since v8.1.0
19041918
*/
@@ -1950,6 +1964,7 @@
19501964
* console.log(app.textContent);
19511965
* // -> 'fido felix'
19521966
* ```
1967+
* @function
19531968
* @category Component
19541969
* @since v8.1.0
19551970
*/
@@ -1993,6 +2008,7 @@
19932008
* console.log(app.textContent);
19942009
* // -> 'dog'
19952010
* ```
2011+
* @function
19962012
* @category Component
19972013
* @since v8.1.0
19982014
*/
@@ -2043,6 +2059,7 @@
20432059
* console.log(app.textContent);
20442060
* // -> 'fido'
20452061
* ```
2062+
* @function
20462063
* @category Component
20472064
* @since v8.1.0
20482065
*/
@@ -2089,6 +2106,7 @@
20892106
* console.log(app.textContent);
20902107
* // -> 'fido felix'
20912108
* ```
2109+
* @function
20922110
* @category Component
20932111
* @since v8.1.0
20942112
*/
@@ -2134,6 +2152,7 @@
21342152
* console.log(app.textContent);
21352153
* // -> 'fido felix'
21362154
* ```
2155+
* @function
21372156
* @category Component
21382157
* @since v8.1.0
21392158
*/
@@ -2180,6 +2199,7 @@
21802199
* console.log(app.textContent);
21812200
* // -> 'pets species'
21822201
* ```
2202+
* @function
21832203
* @category Component
21842204
* @since v8.1.0
21852205
*/
@@ -2223,6 +2243,7 @@
22232243
* console.log(app.textContent);
22242244
* // -> 'true'
22252245
* ```
2246+
* @function
22262247
* @category Component
22272248
* @since v8.1.0
22282249
*/
@@ -2268,6 +2289,7 @@
22682289
* console.log(app.textContent);
22692290
* // -> 'open employees'
22702291
* ```
2292+
* @function
22712293
* @category Component
22722294
* @since v8.1.0
22732295
*/

0 commit comments

Comments
 (0)