Skip to content

Commit

Permalink
Remove superfluous words from comments (flutter#39068)
Browse files Browse the repository at this point in the history
* Remove superfluous words.

* Format

* Duplicate in consecutive lines.
  • Loading branch information
asashour authored Jan 24, 2023
1 parent 7f38d0d commit 71ee5f1
Show file tree
Hide file tree
Showing 59 changed files with 84 additions and 85 deletions.
2 changes: 1 addition & 1 deletion DEPS
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ deps = {
#
# The dependencies in this section should match the layout in the Fuchsia gn
# build. Eventually, we'll manage these dependencies together with Fuchsia
# and not have to specific specific hashes.
# and not have to specific hashes.

'src/third_party/rapidjson':
Var('fuchsia_git') + '/third_party/rapidjson' + '@' + 'ef3564c5c8824989393b87df25355baf35ff544b',
Expand Down
2 changes: 1 addition & 1 deletion Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -707,7 +707,7 @@ SHOW_NAMESPACES = YES
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
# popen()) the command command input-file, where command is the value of the
# popen()) the command input-file, where command is the value of the
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
# by doxygen. Whatever the program writes to standard output is used as the file
# version. For an example see the documentation.
Expand Down
2 changes: 1 addition & 1 deletion ci/scan_flattened_deps.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
SECONDS_PER_YEAR = 31556952
UPSTREAM_PREFIX = 'upstream_'

failed_deps = [] # deps which fail to be be cloned or git-merge based
failed_deps = [] # deps which fail to be cloned or git-merge based

sarif_log = {
'$schema':
Expand Down
2 changes: 1 addition & 1 deletion impeller/entity/entity_unittests.cc
Original file line number Diff line number Diff line change
Expand Up @@ -679,7 +679,7 @@ TEST_P(EntityTest, BlendingModeOptions) {
std::vector<BlendMode> blend_mode_values;
{
// Force an exhausiveness check with a switch. When adding blend modes,
// update this switch with a new name/value to to make it selectable in the
// update this switch with a new name/value to make it selectable in the
// test GUI.

const BlendMode b{};
Expand Down
2 changes: 1 addition & 1 deletion impeller/geometry/path.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ enum class FillType {
//------------------------------------------------------------------------------
/// @brief Paths are lightweight objects that describe a collection of
/// linear, quadratic, or cubic segments. These segments may be
/// be broken up by move commands, which are effectively linear
/// broken up by move commands, which are effectively linear
/// commands that pick up the pen rather than continuing to draw.
///
/// All shapes supported by Impeller are paths either directly or
Expand Down
2 changes: 1 addition & 1 deletion impeller/renderer/texture_descriptor.h
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ namespace impeller {

//------------------------------------------------------------------------------
/// @brief A lightweight object that describes the attributes of a texture
/// that can then used used an allocator to create that texture.
/// that can then used an allocator to create that texture.
///
struct TextureDescriptor {
StorageMode storage_mode = StorageMode::kDeviceTransient;
Expand Down
2 changes: 1 addition & 1 deletion lib/snapshot/BUILD.gn
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ group("generate_snapshot_bins") {
deps += [ ":create_arm_gen_snapshot" ]
}

# Build analyze_snapshot for for 64-bit target CPUs.
# Build analyze_snapshot for 64-bit target CPUs.
if (target_cpu == "x64" || target_cpu == "arm64") {
deps +=
[ "//third_party/dart/runtime/bin:analyze_snapshot($host_toolchain)" ]
Expand Down
2 changes: 1 addition & 1 deletion lib/ui/geometry.dart
Original file line number Diff line number Diff line change
Expand Up @@ -1227,7 +1227,7 @@ class RRect {
brRadiusY: bottomRight.y,
);

/// Construct a rounded rectangle from its bounding box and and topLeft,
/// Construct a rounded rectangle from its bounding box and topLeft,
/// topRight, bottomRight, and bottomLeft radii.
///
/// The corner radii default to [Radius.zero], i.e. right-angled corners. Will
Expand Down
8 changes: 4 additions & 4 deletions lib/ui/painting.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2646,7 +2646,7 @@ class Path extends NativeFieldWrapperClass1 {
/// `clockwise` and `largeArc` in such a way that the sweep angle
/// is always less than 360 degrees.
///
/// A simple line is appended if either either radii are zero or the last
/// A simple line is appended if either radii are zero or the last
/// point in the path is `arcEnd`. The radii are scaled to fit the last path
/// point if both are greater than zero but too small to describe an arc.
///
Expand Down Expand Up @@ -2674,7 +2674,7 @@ class Path extends NativeFieldWrapperClass1 {
/// path in a direction determined by `clockwise` and `largeArc`
/// in such a way that the sweep angle is always less than 360 degrees.
///
/// A simple line is appended if either either radii are zero, or, both
/// A simple line is appended if either radii are zero, or, both
/// `arcEndDelta.dx` and `arcEndDelta.dy` are zero. The radii are scaled to
/// fit the last path point if both are greater than zero but too small to
/// describe an arc.
Expand Down Expand Up @@ -4972,7 +4972,7 @@ class Canvas extends NativeFieldWrapperClass1 {
///
/// Use [save] and [saveLayer] to push state onto the stack.
///
/// If the state was pushed with with [saveLayer], then this call will also
/// If the state was pushed with [saveLayer], then this call will also
/// cause the new layer to be composited into the previous layer.
@Native<Void Function(Pointer<Void>)>(symbol: 'Canvas::restore', isLeaf: true)
external void restore();
Expand Down Expand Up @@ -6259,7 +6259,7 @@ class Shadow {

/// Linearly interpolate between two shadows.
///
/// If either shadow is null, this function linearly interpolates from a
/// If either shadow is null, this function linearly interpolates from
/// a shadow that matches the other shadow in color but has a zero
/// offset and a zero blurRadius.
///
Expand Down
2 changes: 1 addition & 1 deletion lib/ui/platform_dispatcher.dart
Original file line number Diff line number Diff line change
Expand Up @@ -1928,7 +1928,7 @@ class Locale {
/// [language](https://github.com/unicode-org/cldr/blob/master/common/validity/language.xml),
/// [region](https://github.com/unicode-org/cldr/blob/master/common/validity/region.xml). The
/// primary language subtag must be at least two and at most eight lowercase
/// letters, but not four letters. The region region subtag must be two
/// letters, but not four letters. The region subtag must be two
/// uppercase letters or three digits. See the [Unicode Language
/// Identifier](https://www.unicode.org/reports/tr35/#Unicode_language_identifier)
/// specification.
Expand Down
4 changes: 2 additions & 2 deletions lib/ui/text.dart
Original file line number Diff line number Diff line change
Expand Up @@ -1194,7 +1194,7 @@ class TextHeightBehavior {
/// Whether to apply the [TextStyle.height] modifier to the ascent of the first
/// line in the paragraph.
///
/// When true, the [TextStyle.height] modifier will be applied to to the ascent
/// When true, the [TextStyle.height] modifier will be applied to the ascent
/// of the first line. When false, the font's default ascent will be used and
/// the [TextStyle.height] will have no effect on the ascent of the first line.
///
Expand All @@ -1206,7 +1206,7 @@ class TextHeightBehavior {
/// Whether to apply the [TextStyle.height] modifier to the descent of the last
/// line in the paragraph.
///
/// When true, the [TextStyle.height] modifier will be applied to to the descent
/// When true, the [TextStyle.height] modifier will be applied to the descent
/// of the last line. When false, the font's default descent will be used and
/// the [TextStyle.height] will have no effect on the descent of the last line.
///
Expand Down
2 changes: 1 addition & 1 deletion lib/ui/ui_dart_state.h
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ class UIDartState : public tonic::DartState {
return unhandled_exception_callback_;
}

/// Returns a enumeration that that uniquely represents this root isolate.
/// Returns a enumeration that uniquely represents this root isolate.
/// Returns `0` if called from a non-root isolate.
int64_t GetRootIsolateToken() const;

Expand Down
4 changes: 2 additions & 2 deletions lib/web_ui/lib/src/engine/html/path/path.dart
Original file line number Diff line number Diff line change
Expand Up @@ -658,7 +658,7 @@ class SurfacePath implements ui.Path {
/// `clockwise` and `largeArc` in such a way that the sweep angle
/// is always less than 360 degrees.
///
/// A simple line is appended if either either radii are zero or the last
/// A simple line is appended if either radii are zero or the last
/// point in the path is `arcEnd`. The radii are scaled to fit the last path
/// point if both are greater than zero but too small to describe an arc.
///
Expand Down Expand Up @@ -851,7 +851,7 @@ class SurfacePath implements ui.Path {
/// path in a direction determined by `clockwise` and `largeArc`
/// in such a way that the sweep angle is always less than 360 degrees.
///
/// A simple line is appended if either either radii are zero, or, both
/// A simple line is appended if either radii are zero, or, both
/// `arcEndDelta.dx` and `arcEndDelta.dy` are zero. The radii are scaled to
/// fit the last path point if both are greater than zero but too small to
/// describe an arc.
Expand Down
2 changes: 1 addition & 1 deletion lib/web_ui/lib/src/engine/keyboard_binding.dart
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ class KeyboardConverter {
_keyGuards.remove(physicalKey)?.call();
_keyGuards[physicalKey] = cancelingCallback;
}
// Call this method on an up event event of a non-modifier key.
// Call this method on an up event of a non-modifier key.
void _stopGuardingKey(int physicalKey) {
_keyGuards.remove(physicalKey)?.call();
}
Expand Down
2 changes: 1 addition & 1 deletion lib/web_ui/lib/src/engine/navigation/history.dart
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ BrowserHistory createHistoryForExistingState(UrlStrategy? urlStrategy) {
/// interact with the html browser history and should come up with their own
/// ways to manage the states in the browser history.
///
/// There should only be one global instance among all all subclasses.
/// There should only be one global instance among all subclasses.
///
/// See also:
///
Expand Down
2 changes: 1 addition & 1 deletion lib/web_ui/lib/src/engine/safe_browser_api.dart
Original file line number Diff line number Diff line change
Expand Up @@ -1040,7 +1040,7 @@ class OffScreenCanvas {
}
}

/// Draws an image to canvas for both offscreen canvas canvas context2d.
/// Draws an image to canvas for both offscreen canvas context2d.
void drawImage(Object image, int x, int y, int width, int height) {
js_util.callMethod<void>(
getContext2d()!, 'drawImage', <dynamic>[image, x, y, width, height]);
Expand Down
2 changes: 1 addition & 1 deletion lib/web_ui/lib/src/engine/text/font_collection.dart
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ class FontManager {
///
/// Safari 12 and Firefox crash if you create a [DomFontFace] with a font
/// family that is not correct CSS syntax. Font family names with invalid
/// characters are accepted accepted on these browsers, when wrapped it in
/// characters are accepted on these browsers, when wrapped it in
/// quotes.
///
/// Additionally, for Safari 12 to work [DomFontFace] name should be
Expand Down
2 changes: 1 addition & 1 deletion lib/web_ui/lib/src/engine/text_editing/text_editing.dart
Original file line number Diff line number Diff line change
Expand Up @@ -1364,7 +1364,7 @@ abstract class DefaultTextEditingStrategy with CompositionAwareMixin implements
editingDeltaState.deltaStart = lastEditingState!.extentOffset!;
editingDeltaState.deltaEnd = lastEditingState!.extentOffset!;
} else if (eventData != null) {
// When event.data is not null we we will begin by considering this delta as an insertion
// When event.data is not null we will begin by considering this delta as an insertion
// at the selection extentOffset. This may change due to logic in handleChange to handle
// composition and other IME behaviors.
editingDeltaState.deltaText = eventData;
Expand Down
2 changes: 1 addition & 1 deletion lib/web_ui/test/engine/profiler_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ void _profilerTests() {
() => Profiler.instance.benchmark('foo', 123),

// dart2js throws a NoSuchMethodError, dart2wasm throws a TypeError here.
// Just make make sure it throws an error in this case.
// Just make sure it throws an error in this case.
throwsA(isA<Error>()),
);
expect(data, isEmpty);
Expand Down
2 changes: 1 addition & 1 deletion runtime/dart_isolate.h
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ class DartIsolate : public UIDartState {
///
Uninitialized,
//--------------------------------------------------------------------------
/// The Dart isolate has been been fully initialized but none of the
/// The Dart isolate has been fully initialized but none of the
/// libraries referenced by that isolate have been loaded yet. This is an
/// internal phase and callers can never get a reference to a Dart isolate
/// in this phase.
Expand Down
4 changes: 2 additions & 2 deletions runtime/runtime_controller.h
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,7 @@ class RuntimeController : public PlatformConfigurationClient {
/// @brief Get an identifier that represents the Dart isolate group the
/// root isolate is in.
///
/// @return The root isolate isolate group identifier, zero if one can't
/// @return The root isolate group identifier, zero if one can't
/// be established.
uint64_t GetRootIsolateGroup() const;

Expand Down Expand Up @@ -535,7 +535,7 @@ class RuntimeController : public PlatformConfigurationClient {
/// temporary conditions such as no network.
/// Transient errors allow the dart VM to
/// re-request the same deferred library and
/// and loading_unit_id again. Non-transient
/// loading_unit_id again. Non-transient
/// errors are permanent and attempts to
/// re-request the library will instantly
/// complete with an error.
Expand Down
2 changes: 1 addition & 1 deletion shell/common/animator.h
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ class Animator final {

// Enqueue |trace_flow_id| into |trace_flow_ids_|. The flow event will be
// ended at either the next frame, or the next vsync interval with no active
// active rendering.
// rendering.
void EnqueueTraceFlowId(uint64_t trace_flow_id);

private:
Expand Down
4 changes: 2 additions & 2 deletions shell/common/engine.h
Original file line number Diff line number Diff line change
Expand Up @@ -707,7 +707,7 @@ class Engine final : public RuntimeDelegate, PointerDataDispatcher::Delegate {
/// @param[in] trace_flow_id The trace flow identifier associated with the
/// pointer data packet. The engine uses this trace
/// identifier to connect trace flows in the
/// timeline from the input event event to the
/// timeline from the input event to the
/// frames generated due to those input events.
/// These flows are tagged as "PointerEvent" in the
/// timeline and allow grouping frames and input
Expand Down Expand Up @@ -870,7 +870,7 @@ class Engine final : public RuntimeDelegate, PointerDataDispatcher::Delegate {
/// temporary conditions such as no network.
/// Transient errors allow the dart VM to
/// re-request the same deferred library and
/// and loading_unit_id again. Non-transient
/// loading_unit_id again. Non-transient
/// errors are permanent and attempts to
/// re-request the library will instantly
/// complete with an error.
Expand Down
4 changes: 2 additions & 2 deletions shell/common/platform_message_handler.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ class PlatformMessageHandler {
virtual void HandlePlatformMessage(
std::unique_ptr<PlatformMessage> message) = 0;

/// Returns true if the platform message will ALWAYS be be dispatched to the
/// Returns true if the platform message will ALWAYS be dispatched to the
/// platform thread.
///
/// Platforms thats support Background Platform Channels will return
/// Platforms that support Background Platform Channels will return
/// false.
virtual bool DoesHandlePlatformMessageOnPlatformThread() const = 0;

Expand Down
4 changes: 2 additions & 2 deletions shell/common/platform_view.h
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ class PlatformView {
/// temporary conditions such as no network.
/// Transient errors allow the dart VM to
/// re-request the same deferred library and
/// and loading_unit_id again. Non-transient
/// loading_unit_id again. Non-transient
/// errors are permanent and attempts to
/// re-request the library will instantly
/// complete with an error.
Expand Down Expand Up @@ -759,7 +759,7 @@ class PlatformView {
/// temporary conditions such as no network.
/// Transient errors allow the dart VM to
/// re-request the same deferred library and
/// and loading_unit_id again. Non-transient
/// loading_unit_id again. Non-transient
/// errors are permanent and attempts to
/// re-request the library will instantly
/// complete with an error.
Expand Down
2 changes: 1 addition & 1 deletion shell/common/run_configuration.h
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class RunConfiguration {
/// will attempt to look for the VM and isolate snapshots in the
/// assets directory (must be specified in settings). In AOT mode,
/// it will attempt to look for known snapshot symbols in the
/// currently currently loaded process. The entrypoint defaults to
/// currently loaded process. The entrypoint defaults to
/// the "main" method in the root library.
///
/// @param[in] settings The settings object used to look for the various
Expand Down
2 changes: 1 addition & 1 deletion shell/common/shell.cc
Original file line number Diff line number Diff line change
Expand Up @@ -1709,7 +1709,7 @@ bool Shell::OnServiceProtocolFlushUIThreadTasks(
// It can potentially starve the service isolate if the main isolate pauses
// at a breakpoint or is in an infinite loop.
//
// It should be invoked from the VM Service and and blocks it until UI thread
// It should be invoked from the VM Service and blocks it until UI thread
// tasks are processed.
response->SetObject();
response->AddMember("type", "Success", response->GetAllocator());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ private static String[] getArgsFromIntent(Intent intent) {
args.add("--endless-trace-buffer");
}
// NOTE: all flags provided with this argument are subject to filtering
// based on a a list of allowed flags in shell/common/switches.cc. If any
// based on a list of allowed flags in shell/common/switches.cc. If any
// flag provided is not allowed, the process will immediately terminate.
if (intent.hasExtra("dart-flags")) {
args.add("--dart-flags=" + intent.getStringExtra("dart-flags"));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ public static FlutterShellArgs fromIntent(@NonNull Intent intent) {
}

// NOTE: all flags provided with this argument are subject to filtering
// based on a a list of allowed flags in shell/common/switches.cc. If any
// based on a list of allowed flags in shell/common/switches.cc. If any
// flag provided is not allowed, the process will immediately terminate.
if (intent.hasExtra(ARG_KEY_DART_FLAGS)) {
args.add(ARG_DART_FLAGS + "=" + intent.getStringExtra(ARG_KEY_DART_FLAGS));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,12 @@ public interface DeferredComponentManager {
* negative loadingUnitId is passed, then componentName must not be null. Passing a
* loadingUnitId larger than the highest valid loading unit's id will cause the Dart
* loadLibrary() to complete with a failure.
* @param componentName The deferred component component name as defined in bundle_config.yaml.
* This may be null if the deferred component to be loaded is associated with a loading
* unit/deferred dart library. In this case, it is this method's responsibility to map the
* loadingUnitId to its corresponding componentName. When loading asset-only or other deferred
* components without an associated Dart deferred library, loading unit id should a negative
* value and componentName must be non-null.
* @param componentName The deferred component name as defined in bundle_config.yaml. This may be
* null if the deferred component to be loaded is associated with a loading unit/deferred dart
* library. In this case, it is this method's responsibility to map the loadingUnitId to its
* corresponding componentName. When loading asset-only or other deferred components without
* an associated Dart deferred library, loading unit id should a negative value and
* componentName must be non-null.
*/
public abstract void installDeferredComponent(int loadingUnitId, String componentName);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,7 @@ private void configureForHybridComposition(
private long configureForVirtualDisplay(
@NonNull PlatformView platformView,
@NonNull PlatformViewsChannel.PlatformViewCreationRequest request) {
// This mode adds the view to a virtual display, which is is wired up to a GL texture that
// This mode adds the view to a virtual display, which is wired up to a GL texture that
// is composed by the Flutter engine.

// API level 20 is required to use VirtualDisplay#setSurface.
Expand Down
Loading

0 comments on commit 71ee5f1

Please sign in to comment.