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

Commit ce73a8b

Browse files
authored
Update dartdoc for gpu.dart (#54529)
Update dartdoc for package:flutter_gpu with: 1) details on how to use the sdk dep 2) the current docs link [C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
1 parent 0339bfe commit ce73a8b

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

lib/gpu/lib/gpu.dart

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,22 @@
22
// Use of this source code is governed by a BSD-style license that can be
33
// found in the LICENSE file.
44

5-
/// The Flutter GPU library.
5+
/// Flutter GPU is a low level API for building rendering packages from scratch.
66
///
7-
/// To use, import `package:flutter_gpu/gpu.dart`.
7+
/// To use, first add an SDK dependency in your `pubspec.yaml` file:
8+
/// ```
9+
/// dependencies:
10+
/// flutter_gpu:
11+
/// sdk: flutter
12+
/// ```
13+
/// And then add an import statement in your Dart files:
14+
/// ```dart
15+
/// import `package:flutter_gpu/gpu.dart`;
16+
/// ```
817
///
918
/// See also:
1019
///
11-
/// * [Flutter GPU Wiki page](https://github.com/flutter/flutter/wiki/Flutter-GPU).
20+
/// * [Flutter GPU documentation](https://github.com/flutter/engine/blob/main/docs/impeller/Flutter-GPU.md).
1221
library flutter_gpu;
1322

1423
import 'dart:ffi';

0 commit comments

Comments
 (0)