Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Fix docs for SemanticsAction #52229

Merged
merged 3 commits into from
Apr 18, 2024
Merged

Fix docs for SemanticsAction #52229

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d93dfde
Fix docs for SemanticsAction
goderbauer Apr 18, 2024
a285e63
add >
goderbauer Apr 18, 2024
d157a2d
make private
goderbauer Apr 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions lib/ui/semantics.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,10 @@ part of dart.ui;
/// The possible actions that can be conveyed from the operating system
/// accessibility APIs to a semantics node.
///
/// \warning When changes are made to this class, the equivalent APIs in
/// `lib/ui/semantics/semantics_node.h` and in each of the embedders
/// *must* be updated.
/// See also:
/// - file://./../../lib/ui/semantics/semantics_node.h
/// > [!Warning]
/// > When changes are made to this class, the equivalent APIs in
/// > `lib/ui/semantics/semantics_node.h` and in each of the embedders
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this have to be in public doc?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like something we can use // instead

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/flutter/engine/pull/19817/files turned it from private to public with this non-existing \warning thingy. I would also prefer keeping this private, but also don't want to flip-flop between the two every four years or so. Should we once and for all (lol) take this out of the public docs?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's take it out, I missed this part when I reviewed the pr.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

/// > *must* be updated.
class SemanticsAction {
const SemanticsAction._(this.index, this.name);

Expand Down