Added a more complete docstring for SemanticsFlags (#19817)

This commit is contained in:
gaaclarke 2020-07-16 13:13:26 -07:00 committed by GitHub
parent bf9d2eadb7
commit 494e4e7e21
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 5 deletions

View File

@ -8,10 +8,12 @@ part of dart.ui;
/// The possible actions that can be conveyed from the operating system
/// accessibility APIs to a semantics node.
//
// 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.
///
/// \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
class SemanticsAction {
const SemanticsAction._(this.index) : assert(index != null); // ignore: unnecessary_null_comparison

View File

@ -48,7 +48,12 @@ const int kScrollableSemanticsActions =
static_cast<int32_t>(SemanticsAction::kScrollUp) |
static_cast<int32_t>(SemanticsAction::kScrollDown);
// Must match the SemanticsFlags enum in semantics.dart.
/// C/C++ representation of `SemanticsFlags` defined in
/// `lib/ui/semantics.dart`.
///\warning This must match the `SemanticsFlags` enum in
/// `lib/ui/semantics.dart`.
/// See also:
/// - file://./../../../lib/ui/semantics.dart
enum class SemanticsFlags : int32_t {
kHasCheckedState = 1 << 0,
kIsChecked = 1 << 1,