documentation improvements

dart-lang · Jul 15, 2024 · 57fe25f · 57fe25f
1 parent 8871562
commit 57fe25f
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/pkgs/ok_http/README.md b/pkgs/ok_http/README.md
@@ -30,6 +30,8 @@ This size of the [example application][] APK file using different packages:
 - Configured System Proxy on Android
 - HTTP/2
 
+**Example Usage of `OkHttpWebSocket`:**
+
 ```dart
 import 'package:ok_http/ok_http.dart';
 import 'package:web_socket/web_socket.dart';

diff --git a/pkgs/ok_http/lib/src/ok_http_web_socket.dart b/pkgs/ok_http/lib/src/ok_http_web_socket.dart
@@ -15,7 +15,7 @@ import 'jni/bindings.dart' as bindings;
 /// [WebSocket](https://square.github.io/okhttp/5.x/okhttp/okhttp3/-web-socket/index.html)
 /// API.
 ///
-///
+/// Example usage of [OkHttpWebSocket]:
 /// ```dart
 /// import 'package:ok_http/ok_http.dart';
 /// import 'package:web_socket/web_socket.dart';