From b814c081e1a3cd0a64b7a0debaacf870125dfdff Mon Sep 17 00:00:00 2001 From: Erick Almeida Date: Tue, 17 Sep 2024 00:31:42 -0300 Subject: [PATCH] docs: improve documentation markup --- src/parsing/swift-file-tree.ts | 4 ++-- .../rules/accessibility-hidden-modifier-remover.ts | 2 +- src/transforming/rules/accessibility-modifier-remover.ts | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/parsing/swift-file-tree.ts b/src/parsing/swift-file-tree.ts index 945ef70..4f74ae8 100644 --- a/src/parsing/swift-file-tree.ts +++ b/src/parsing/swift-file-tree.ts @@ -94,7 +94,7 @@ export class SwiftFileTree { return []; } - // A SwiftUI view is a property declaration with an opaque type annotation that matches "some View". + // A SwiftUI view is a property declaration with an opaque type annotation that matches `some View`. const swiftUIViewQueryText = ` ( (property_declaration @@ -119,7 +119,7 @@ export class SwiftFileTree { /** * Replace the text in the tree with the given replacement text. - * Prefer using `replaceNode` instead of this method, which uses this one under the hood. + * Prefer using {@link replaceNode} instead of this method, which uses this one under the hood. */ replaceText( originalStart: Point, diff --git a/src/transforming/rules/accessibility-hidden-modifier-remover.ts b/src/transforming/rules/accessibility-hidden-modifier-remover.ts index 93060c5..c2e7d94 100644 --- a/src/transforming/rules/accessibility-hidden-modifier-remover.ts +++ b/src/transforming/rules/accessibility-hidden-modifier-remover.ts @@ -6,7 +6,7 @@ import { } from '../fault-transformation-rule.js'; /** - * This rule matches to a SwiftUI View element with a `.accessibilityHidden` modifier, which + * This rule matches to a SwiftUI view element with a `.accessibilityHidden` modifier, which * is used to hide views with decorative or repetitive content from screen readers. The transformation * removes the modifier. * diff --git a/src/transforming/rules/accessibility-modifier-remover.ts b/src/transforming/rules/accessibility-modifier-remover.ts index 12855ba..0b95c07 100644 --- a/src/transforming/rules/accessibility-modifier-remover.ts +++ b/src/transforming/rules/accessibility-modifier-remover.ts @@ -6,7 +6,7 @@ import { } from '../fault-transformation-rule.js'; /** - * This rule matches to a SwiftUI View element with a `.accessibility` modifier, which + * This rule matches to a SwiftUI view element with a `.accessibility` modifier, which * is used to provide a text alternative for screen reader users to a view that doesn't * display text. The transformation removes the label. *