Skip to content

Commit

Permalink
... remove library name and references to the term 'glue'
Browse files Browse the repository at this point in the history
  • Loading branch information
sigmundch committed Jul 20, 2023
1 parent 33d9291 commit 1d1664b
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 17 deletions.
14 changes: 7 additions & 7 deletions lib/helpers.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

/// Main entry library for `package:web` glue layer.
/// Main entry library for `package:web` helper layer.
///
/// The glue layer is a collection of libraries with extensions and helper
/// methods that bring functionality to `package:web` that many Dart developers
/// are used to have from `dart:html`.
/// The helper layer is a collection of libraries with extensions and methods
/// that bring functionality to `package:web` that many Dart developers are used
/// to have from `dart:html`.
///
/// This glue layer serves two purposes:
/// This helper layer serves two purposes:
/// * provide useful functionality in environments where `dart:html` is not
/// available (like on Wasm).
/// * help bridge the gap in functionality from the past, which may reduce
Expand All @@ -19,8 +19,8 @@
/// developer. Unlike `dart:html`, each developer needs to make a choice for
/// whether to consume some of the APIs provided here.
///
/// The libraries in the glue layer can also be consumed piece by piece.
library web.glue;
/// The libraries in this helper layer can also be consumed piece by piece.
library;

import 'dart:js_interop';
import 'dart:js_interop_unsafe';
Expand Down
4 changes: 2 additions & 2 deletions lib/src/helpers/enums.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

/// Glue layer library that exposes enums commonly used from `dart:html`.
library web.glue.enums;
/// Helper layer library that exposes enums commonly used from `dart:html`.
library;

import '../../web.dart';

Expand Down
6 changes: 3 additions & 3 deletions lib/src/helpers/events/streams.dart
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ import '../../../helpers.dart' show Device;
import '../../../web.dart' as html;

/// Helper class used to create streams abstracting DOM events. This is a
/// piece of the glue layer directly derived from a similar feature in
/// piece of the helper layer directly derived from a similar feature in
/// `dart:html`.
///
/// A few differences compared to `dart:html`:
/// * The glue layer doesn't have `ElementList` APIs, so this
/// * The helper layer doesn't have `ElementList` APIs, so this
/// provider omits APIs related to them.
///
/// * Streams returned here behave slighly differently. The timing of when
Expand Down Expand Up @@ -176,7 +176,7 @@ class _EventStreamSubscription<T extends html.Event>
// `dart:html` it would have printed 1, 2, 4, 3
//
// ```dart
// import 'package:web/glue/glue.dart';
// import 'package:web/helpers.dart';
//
// main() {
// print('1');
Expand Down
4 changes: 2 additions & 2 deletions lib/src/helpers/extensions.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

/// Glue layer library that includes additional extension methods on existing
/// Helper layer library that includes additional extension methods on existing
/// `package:web` types.
///
/// The extensions here are added by hand over time, depending on needs and use
Expand All @@ -18,7 +18,7 @@
/// `HTMLCanvasElement`).
///
/// * conversions: for example to wrap a `TouchList` as a `List<Touch>`
library web.glue.extensions;
library;

import 'dart:js_interop';
import 'dart:math' show Point;
Expand Down
6 changes: 3 additions & 3 deletions lib/src/helpers/renames.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

/// Glue layer helper that exposes `package:web` types using their legacy
/// Helper layer that exposes some `package:web` types using their legacy
/// `dart:html` type names.
library web.glue.renames;
library;

import '../../web.dart';

Expand All @@ -15,4 +15,4 @@ typedef ImageElement = HTMLImageElement;
typedef VideoElement = HTMLVideoElement;
typedef CssStyleDeclaration = CSSStyleDeclaration;
typedef ContextEvent = WebGLContextEvent;
typedef WebGL = WebGLRenderingContext;
typedef WebGL = WebGLRenderingContextBase;

0 comments on commit 1d1664b

Please sign in to comment.