Skip to content

Commit 6850321

Browse files
committed
Doc strings
1 parent 22ad63d commit 6850321

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

src/processTargets/modifiers/ModifyIfUntypedStage.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ import getModifierStage from "../getModifierStage";
55
import { ModifierStage } from "../PipelineStages.types";
66

77
/**
8-
* Runs {@link ModifyIfUntypedModifier.modifier} if the target is lacking an explicit modifier.
8+
* Runs {@link ModifyIfUntypedModifier.modifier} if the target has no explicit
9+
* scope type, ie if {@link Target.hasExplicitScopeType} is `false`.
910
*/
1011
export default class ModifyIfUntypedStage implements ModifierStage {
1112
private nestedStage_?: ModifierStage;
@@ -20,7 +21,7 @@ export default class ModifyIfUntypedStage implements ModifierStage {
2021

2122
/**
2223
* This target is lacking an explicit scope type and should use inference/upgrade when needed.
23-
* See {@link UntypedTarget} for more info
24+
* See {@link Target.hasExplicitScopeType} for more info
2425
*/
2526
return this.nestedStage
2627
.run(context, target)

src/processTargets/modifiers/commonContainingScopeIfUntypedStages.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
import ModifyIfUntypedStage from "./ModifyIfUntypedStage";
22

3+
/**
4+
* Expands the given target to the nearest containing surrounding pair if the
5+
* target has no explicit scope type, ie if {@link Target.hasExplicitScopeType}
6+
* is `false`.
7+
*/
38
export const containingSurroundingPairIfUntypedStage = new ModifyIfUntypedStage(
49
{
510
type: "modifyIfUntyped",
@@ -10,6 +15,10 @@ export const containingSurroundingPairIfUntypedStage = new ModifyIfUntypedStage(
1015
}
1116
);
1217

18+
/**
19+
* Expands the given target to the nearest containing line if the target has no
20+
* explicit scope type, ie if {@link Target.hasExplicitScopeType} is `false`.
21+
*/
1322
export const containingLineIfUntypedStage = new ModifyIfUntypedStage({
1423
type: "modifyIfUntyped",
1524
modifier: {
@@ -18,6 +27,10 @@ export const containingLineIfUntypedStage = new ModifyIfUntypedStage({
1827
},
1928
});
2029

30+
/**
31+
* Expands the given target to the nearest containing token if the target has no
32+
* explicit scope type, ie if {@link Target.hasExplicitScopeType} is `false`.
33+
*/
2134
export const containingTokenIfUntypedStage = new ModifyIfUntypedStage({
2235
type: "modifyIfUntyped",
2336
modifier: {

0 commit comments

Comments
 (0)