Skip to content

Commit f1e1189

Browse files
shivxmsharmashivxmsharma
committed
feat(theme): emit stability blockquotes for JSDoc stability tags
- Add stabilityBlockquote() helper in helpers/index.mjs that maps: @deprecated -> Stability 0, @experimental/@beta -> Stability 1, @legacy -> Stability 3 - Call helper at top of signature() so blockquote appears before params - Pass showTags: false to comment() to suppress old heading-style rendering - Regenerate pages/ with updated output (26 deprecated members fixed) Note: accessor-level @deprecated tags use a separate render path and are not yet handled. See PR description for details. Closes #8
1 parent e5b8286 commit f1e1189

File tree

8 files changed

+85
-102
lines changed

8 files changed

+85
-102
lines changed

‎pages/v5.x/globals.md‎

Lines changed: 26 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -362,11 +362,10 @@ After this method has succeeded the cache can only be restored when build depend
362362

363363
#### `getChunkMaps(realHash)`
364364

365+
> Stability: 0 - Deprecated
365366
* `realHash` {boolean}
366367
* Returns: {ChunkMaps}
367368

368-
##### Deprecated
369-
370369
#### `getChunkModuleMaps(filterFn)`
371370

372371
* `filterFn` {object}
@@ -957,52 +956,46 @@ After this method has succeeded the cache can only be restored when build depend
957956

958957
#### Static method: `clearChunkGraphForChunk(chunk)`
959958

959+
> Stability: 0 - Deprecated
960960
* `chunk` {Chunk}
961961
* Returns: {void}
962962

963-
##### Deprecated
964-
965963
#### Static method: `clearChunkGraphForModule(module)`
966964

965+
> Stability: 0 - Deprecated
967966
* `module` {Module}
968967
* Returns: {void}
969968

970-
##### Deprecated
971-
972969
#### Static method: `getChunkGraphForChunk(chunk, deprecateMessage, deprecationCode)`
973970

971+
> Stability: 0 - Deprecated
974972
* `chunk` {Chunk}
975973
* `deprecateMessage` {string}
976974
* `deprecationCode` {string}
977975
* Returns: {ChunkGraph}
978976

979-
##### Deprecated
980-
981977
#### Static method: `getChunkGraphForModule(module, deprecateMessage, deprecationCode)`
982978

979+
> Stability: 0 - Deprecated
983980
* `module` {Module}
984981
* `deprecateMessage` {string}
985982
* `deprecationCode` {string}
986983
* Returns: {ChunkGraph}
987984

988-
##### Deprecated
989-
990985
#### Static method: `setChunkGraphForChunk(chunk, chunkGraph)`
991986

987+
> Stability: 0 - Deprecated
992988
* `chunk` {Chunk}
993989
* `chunkGraph` {ChunkGraph}
994990
* Returns: {void}
995991

996-
##### Deprecated
997-
998992
#### Static method: `setChunkGraphForModule(module, chunkGraph)`
999993

994+
> Stability: 0 - Deprecated
1000995
* `module` {Module}
1001996
* `chunkGraph` {ChunkGraph}
1002997
* Returns: {void}
1003998

1004-
##### Deprecated
1005-
1006999
***
10071000

10081001
## Class: `ChunkGroup`
@@ -1542,11 +1535,10 @@ If `module` is passed, `loc` and `request` must also be passed.
15421535

15431536
#### `assignDepth(module)`
15441537

1538+
> Stability: 0 - Deprecated
15451539
* `module` {Module}
15461540
* Returns: {void}
15471541

1548-
##### Deprecated
1549-
15501542
#### `assignDepths(modules)`
15511543

15521544
* `modules` {Set}
@@ -2272,13 +2264,12 @@ implement this method to allow the occurrence order plugin to count correctly
22722264

22732265
#### `getReference(moduleGraph)`
22742266

2267+
> Stability: 0 - Deprecated
22752268
* `moduleGraph` {ModuleGraph}
22762269
* Returns: {never}
22772270

22782271
Returns the referenced module and export
22792272

2280-
##### Deprecated
2281-
22822273
#### `getReferencedExports(moduleGraph, runtime)`
22832274

22842275
* `moduleGraph` {ModuleGraph}
@@ -3350,14 +3341,13 @@ This data will be passed to restoreFromUnsafeCache later.
33503341

33513342
#### `needRebuild(fileTimestamps, contextTimestamps)`
33523343

3344+
> Stability: 0 - Deprecated
33533345
* `fileTimestamps` {Map}
33543346
* `contextTimestamps` {Map}
33553347
* Returns: {boolean}
33563348

33573349
Use needBuild instead
33583350

3359-
##### Deprecated
3360-
33613351
#### `originalSource()`
33623352

33633353
* Returns: {Source}
@@ -3397,15 +3387,14 @@ restore unsafe cache data
33973387

33983388
#### `source(dependencyTemplates, runtimeTemplate[, type])`
33993389

3390+
> Stability: 0 - Deprecated
34003391
* `dependencyTemplates` {DependencyTemplates}
34013392
* `runtimeTemplate` {RuntimeTemplate}
34023393
* `type` {string}
34033394
* Returns: {Source}
34043395

34053396
Use codeGeneration() instead
34063397

3407-
##### Deprecated
3408-
34093398
#### `updateCacheModule(module)`
34103399

34113400
* `module` {Module}
@@ -3423,13 +3412,12 @@ and properties.
34233412

34243413
#### Static method: `getSourceBasicTypes(module)`
34253414

3415+
> Stability: 0 - Deprecated
34263416
* `module` {Module}
34273417
* Returns: {ReadonlySet}
34283418

34293419
In webpack 6, call getSourceBasicTypes() directly on the module instance instead of using this static method.
34303420

3431-
##### Deprecated
3432-
34333421
***
34343422

34353423
## Class: `ExternalsPlugin`
@@ -3678,11 +3666,10 @@ Apply the plugin
36783666

36793667
#### `getChunkMaps(realHash)`
36803668

3669+
> Stability: 0 - Deprecated
36813670
* `realHash` {boolean}
36823671
* Returns: {ChunkMaps}
36833672

3684-
##### Deprecated
3685-
36863673
#### `getChunkModuleMaps(filterFn)`
36873674

36883675
* `filterFn` {object}
@@ -4500,14 +4487,13 @@ This data will be passed to restoreFromUnsafeCache later.
45004487

45014488
#### `needRebuild(fileTimestamps, contextTimestamps)`
45024489

4490+
> Stability: 0 - Deprecated
45034491
* `fileTimestamps` {Map}
45044492
* `contextTimestamps` {Map}
45054493
* Returns: {boolean}
45064494

45074495
Use needBuild instead
45084496

4509-
##### Deprecated
4510-
45114497
#### `originalSource()`
45124498

45134499
* Returns: {Source}
@@ -4539,15 +4525,14 @@ Use needBuild instead
45394525

45404526
#### `source(dependencyTemplates, runtimeTemplate[, type])`
45414527

4528+
> Stability: 0 - Deprecated
45424529
* `dependencyTemplates` {DependencyTemplates}
45434530
* `runtimeTemplate` {RuntimeTemplate}
45444531
* `type` {string}
45454532
* Returns: {Source}
45464533

45474534
Use codeGeneration() instead
45484535

4549-
##### Deprecated
4550-
45514536
#### `updateCacheModule(module)`
45524537

45534538
* `module` {Module}
@@ -4565,13 +4550,12 @@ and properties.
45654550

45664551
#### Static method: `getSourceBasicTypes(module)`
45674552

4553+
> Stability: 0 - Deprecated
45684554
* `module` {Module}
45694555
* Returns: {ReadonlySet}
45704556

45714557
In webpack 6, call getSourceBasicTypes() directly on the module instance instead of using this static method.
45724558

4573-
##### Deprecated
4574-
45754559
***
45764560

45774561
## Class: `ModuleFactory`
@@ -4939,28 +4923,25 @@ In webpack 6, call getSourceBasicTypes() directly on the module instance instead
49394923

49404924
#### Static method: `clearModuleGraphForModule(module)`
49414925

4926+
> Stability: 0 - Deprecated
49424927
* `module` {Module}
49434928
* Returns: {void}
49444929

4945-
##### Deprecated
4946-
49474930
#### Static method: `getModuleGraphForModule(module, deprecateMessage, deprecationCode)`
49484931

4932+
> Stability: 0 - Deprecated
49494933
* `module` {Module}
49504934
* `deprecateMessage` {string}
49514935
* `deprecationCode` {string}
49524936
* Returns: {ModuleGraph}
49534937

4954-
##### Deprecated
4955-
49564938
#### Static method: `setModuleGraphForModule(module, moduleGraph)`
49574939

4940+
> Stability: 0 - Deprecated
49584941
* `module` {Module}
49594942
* `moduleGraph` {ModuleGraph}
49604943
* Returns: {void}
49614944

4962-
##### Deprecated
4963-
49644945
***
49654946

49664947
## Class: `ModuleGraphConnection`
@@ -5108,15 +5089,14 @@ In webpack 6, call getSourceBasicTypes() directly on the module instance instead
51085089

51095090
#### `runWithDependencies(compilers, fn, callback)`
51105091

5092+
> Stability: 0 - Deprecated
51115093
* `compilers` {Compiler[]}
51125094
* `fn` {object}
51135095
* `callback` {CallbackWebpackFunction_2}
51145096
* Returns: {void}
51155097

51165098
This method should have been private
51175099

5118-
##### Deprecated
5119-
51205100
#### `setDependencies(compiler, dependencies)`
51215101

51225102
* `compiler` {Compiler}
@@ -5696,14 +5676,13 @@ This data will be passed to restoreFromUnsafeCache later.
56965676

56975677
#### `needRebuild(fileTimestamps, contextTimestamps)`
56985678

5679+
> Stability: 0 - Deprecated
56995680
* `fileTimestamps` {Map}
57005681
* `contextTimestamps` {Map}
57015682
* Returns: {boolean}
57025683

57035684
Use needBuild instead
57045685

5705-
##### Deprecated
5706-
57075686
#### `originalSource()`
57085687

57095688
* Returns: {Source}
@@ -5749,15 +5728,14 @@ restore unsafe cache data
57495728

57505729
#### `source(dependencyTemplates, runtimeTemplate[, type])`
57515730

5731+
> Stability: 0 - Deprecated
57525732
* `dependencyTemplates` {DependencyTemplates}
57535733
* `runtimeTemplate` {RuntimeTemplate}
57545734
* `type` {string}
57555735
* Returns: {Source}
57565736

57575737
Use codeGeneration() instead
57585738

5759-
##### Deprecated
5760-
57615739
#### `updateCacheModule(module)`
57625740

57635741
* `module` {Module}
@@ -5785,13 +5763,12 @@ and properties.
57855763

57865764
#### Static method: `getSourceBasicTypes(module)`
57875765

5766+
> Stability: 0 - Deprecated
57885767
* `module` {Module}
57895768
* Returns: {ReadonlySet}
57905769

57915770
In webpack 6, call getSourceBasicTypes() directly on the module instance instead of using this static method.
57925771

5793-
##### Deprecated
5794-
57955772
***
57965773

57975774
## Class: `NormalModuleReplacementPlugin`
@@ -6517,14 +6494,13 @@ This data will be passed to restoreFromUnsafeCache later.
65176494

65186495
#### `needRebuild(fileTimestamps, contextTimestamps)`
65196496

6497+
> Stability: 0 - Deprecated
65206498
* `fileTimestamps` {Map}
65216499
* `contextTimestamps` {Map}
65226500
* Returns: {boolean}
65236501

65246502
Use needBuild instead
65256503

6526-
##### Deprecated
6527-
65286504
#### `originalSource()`
65296505

65306506
* Returns: {Source}
@@ -6560,15 +6536,14 @@ Use needBuild instead
65606536

65616537
#### `source(dependencyTemplates, runtimeTemplate[, type])`
65626538

6539+
> Stability: 0 - Deprecated
65636540
* `dependencyTemplates` {DependencyTemplates}
65646541
* `runtimeTemplate` {RuntimeTemplate}
65656542
* `type` {string}
65666543
* Returns: {Source}
65676544

65686545
Use codeGeneration() instead
65696546

6570-
##### Deprecated
6571-
65726547
#### `updateCacheModule(module)`
65736548

65746549
* `module` {Module}
@@ -6586,13 +6561,12 @@ and properties.
65866561

65876562
#### Static method: `getSourceBasicTypes(module)`
65886563

6564+
> Stability: 0 - Deprecated
65896565
* `module` {Module}
65906566
* Returns: {ReadonlySet}
65916567

65926568
In webpack 6, call getSourceBasicTypes() directly on the module instance instead of using this static method.
65936569

6594-
##### Deprecated
6595-
65966570
***
65976571

65986572
## Class: `SourceMapDevToolPlugin`
@@ -6959,10 +6933,6 @@ a();
69596933
* `stackTraces` {CallSite[]}
69606934
* Returns: {any}
69616935

6962-
##### See
6963-
6964-
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
6965-
69666936
***
69676937

69686938
## Class: `WebpackOptionsApply`
@@ -7133,10 +7103,6 @@ a();
71337103
* `stackTraces` {CallSite[]}
71347104
* Returns: {any}
71357105

7136-
##### See
7137-
7138-
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
7139-
71407106
***
71417107

71427108
## Interface: `Argument`

0 commit comments

Comments
 (0)