Skip to content

Commit 494e4e7

Browse files
authored
Added a more complete docstring for SemanticsFlags (flutter#19817)
1 parent bf9d2ea commit 494e4e7

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

lib/ui/semantics.dart

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,12 @@ part of dart.ui;
88

99
/// The possible actions that can be conveyed from the operating system
1010
/// accessibility APIs to a semantics node.
11-
//
12-
// When changes are made to this class, the equivalent APIs in
13-
// `lib/ui/semantics/semantics_node.h` and in each of the embedders *must* be
14-
// updated.
11+
///
12+
/// \warning When changes are made to this class, the equivalent APIs in
13+
/// `lib/ui/semantics/semantics_node.h` and in each of the embedders
14+
/// *must* be updated.
15+
/// See also:
16+
/// - file://./../../lib/ui/semantics/semantics_node.h
1517
class SemanticsAction {
1618
const SemanticsAction._(this.index) : assert(index != null); // ignore: unnecessary_null_comparison
1719

lib/ui/semantics/semantics_node.h

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,12 @@ const int kScrollableSemanticsActions =
4848
static_cast<int32_t>(SemanticsAction::kScrollUp) |
4949
static_cast<int32_t>(SemanticsAction::kScrollDown);
5050

51-
// Must match the SemanticsFlags enum in semantics.dart.
51+
/// C/C++ representation of `SemanticsFlags` defined in
52+
/// `lib/ui/semantics.dart`.
53+
///\warning This must match the `SemanticsFlags` enum in
54+
/// `lib/ui/semantics.dart`.
55+
/// See also:
56+
/// - file://./../../../lib/ui/semantics.dart
5257
enum class SemanticsFlags : int32_t {
5358
kHasCheckedState = 1 << 0,
5459
kIsChecked = 1 << 1,

0 commit comments

Comments
 (0)