fix api docs lints

alextekartik · alextekartik · commit 6d2704767d9d · 2026-01-12T16:24:01.000+01:00
diff --git a/example/app_pick_crop_image_demo/analysis_options.yaml b/example/app_pick_crop_image_demo/analysis_options.yaml
@@ -3,4 +3,4 @@ include: package:tekartik_lints_flutter/package.yaml
 
 linter:
   rules:
-    public_member_api_docs: false
+     # public_member_api_docs: false
diff --git a/example/app_pick_crop_image_demo/lib/main.dart b/example/app_pick_crop_image_demo/lib/main.dart
@@ -3,14 +3,18 @@ import 'package:shared_preferences/shared_preferences.dart';
 import 'package:tekartik_pick_crop_image_demo/page/main_page.dart';
 import 'package:tekartik_pick_crop_image_demo/src/import.dart';
 
+/// Shared preferences.
 late SharedPreferences prefs;
+
 Future<void> main() async {
   WidgetsFlutterBinding.ensureInitialized();
   prefs = await SharedPreferences.getInstance();
   runApp(const PickCropDemoApp());
 }
 
+/// Pick crop demo app.
 class PickCropDemoApp extends StatelessWidget {
+  /// Pick crop demo app constructor.
   const PickCropDemoApp({super.key});
 
   // This widget is the root of your application.
diff --git a/example/app_pick_crop_image_demo/lib/page/main_page.dart b/example/app_pick_crop_image_demo/lib/page/main_page.dart
@@ -7,7 +7,9 @@ import 'package:tekartik_pick_crop_image_demo/src/import.dart';
 import 'package:tekartik_pick_crop_image_demo/view/body_container.dart';
 import 'package:tekartik_pick_crop_image_demo/view/body_padding.dart';
 
+/// Main page.
 class MainPage extends StatefulWidget {
+  /// Main page constructor.
   const MainPage({super.key});
 
   // This widget is the home page of your application. It is stateful, meaning
@@ -23,7 +25,17 @@ class MainPage extends StatefulWidget {
   State<MainPage> createState() => _MainPageState();
 }
 
-enum AppImageSource { camera, gallery, memory }
+/// App image source.
+enum AppImageSource {
+  /// Camera.
+  camera,
+
+  /// Gallery.
+  gallery,
+
+  /// Memory.
+  memory,
+}
 
 class _MainPageState extends State<MainPage> {
   final _isOpenPanels = ValueNotifier<List<bool>>(List<bool>.filled(4, false));
diff --git a/example/app_pick_crop_image_demo/lib/view/body_container.dart b/example/app_pick_crop_image_demo/lib/view/body_container.dart
@@ -1,9 +1,14 @@
 import 'package:flutter/material.dart';
 
+/// Body container.
 class BodyContainer extends StatelessWidget {
+  /// Child widget.
   final Widget? child;
+
+  /// Width.
   final double? width;
 
+  /// Body container constructor.
   const BodyContainer({super.key, this.child, this.width});
 
   @override
diff --git a/example/app_pick_crop_image_demo/lib/view/body_padding.dart b/example/app_pick_crop_image_demo/lib/view/body_padding.dart
@@ -1,12 +1,16 @@
 import 'package:flutter/material.dart';
 
+/// Horizontal tile padding.
 const horizontalTilePadding = EdgeInsets.symmetric(horizontal: 16);
 
 /// Horizontal padding
 class BodyHPadding extends StatelessWidget {
+  /// The child widget.
   final Widget? child;
 
+  /// Body horizontal padding constructor.
   const BodyHPadding({super.key, this.child});
+
   @override
   Widget build(BuildContext context) {
     return Padding(padding: horizontalTilePadding, child: child);
diff --git a/packages/app_image_web/analysis_options.yaml b/packages/app_image_web/analysis_options.yaml
@@ -3,4 +3,4 @@ include: package:tekartik_lints/package.yaml
 
 linter:
   rules:
-    public_member_api_docs: false
+    # public_member_api_docs: false
diff --git a/packages/app_image_web/lib/src/blob_utils.dart b/packages/app_image_web/lib/src/blob_utils.dart
@@ -20,6 +20,7 @@ Future<Uint8List> blobToBytesUsingFileReader(web.Blob value) async {
   return Uint8List.view(byteBuffer);
 }
 
+/// Convert a blog a list of bytes
 Future<Uint8List> blobToBytes(web.Blob value) async {
   try {
     return await blobToBytesUsingArrayBuffer(value);
diff --git a/packages/app_image_web/lib/src/image_composer/src/common.dart b/packages/app_image_web/lib/src/image_composer/src/common.dart
@@ -2,5 +2,6 @@ import 'package:tekartik_app_image/app_image.dart';
 import 'package:tekartik_app_image/image_composer/image_composer.dart';
 import 'package:tekartik_app_image_web/src/import.dart';
 
+/// Common image composer.
 Future<ImageData> commonComposeImage(ImageComposerData data) =>
     composeImage(data);
diff --git a/packages/app_image_web/lib/src/image_composer/src/io.dart b/packages/app_image_web/lib/src/image_composer/src/io.dart
@@ -3,5 +3,6 @@ import 'package:tekartik_app_image_web/src/image_composer/image_composer.dart';
 
 import 'common.dart';
 
+/// Compose image.
 Future<ImageData> composeImage(ImageComposerData data) =>
     commonComposeImage(data);
diff --git a/packages/app_image_web/lib/src/image_composer/src/web.dart b/packages/app_image_web/lib/src/image_composer/src/web.dart
@@ -6,7 +6,10 @@ import 'package:tekartik_app_image_web/src/offscreen_canvas/src/offscreen_canvas
 // ignore: depend_on_referenced_packages
 import 'package:tekartik_common_utils/size/size.dart';
 
+/// Debug image composer web.
 var debugComposeImageWeb = false; // devWarning(true);
+
+/// Compose image web implementation.
 Future<ImageData> composeImage(ImageComposerData data) async {
   var width = data.width;
   var height = data.height;
diff --git a/packages/app_image_web/lib/src/image_decoder/src/io.dart b/packages/app_image_web/lib/src/image_decoder/src/io.dart
@@ -3,5 +3,6 @@ import 'dart:typed_data';
 import 'package:tekartik_app_image/app_image.dart';
 import 'package:tekartik_app_image/image_decoder/image_decoder.dart' as common;
 
+/// Get image meta from bytes.
 Future<ImageMeta> getImageMetaFromBytes(Uint8List bytes) =>
     common.getImageMetaFromBytes(bytes);
diff --git a/packages/app_image_web/lib/src/image_decoder/src/web.dart b/packages/app_image_web/lib/src/image_decoder/src/web.dart
@@ -5,7 +5,10 @@ import 'package:tekartik_app_image/image_decoder/image_decoder.dart' as common;
 import 'package:tekartik_app_image_web/src/import.dart';
 import 'package:tekartik_app_image_web/src/offscreen_canvas/src/offscreen_canvas.dart';
 
+/// Debug image decoder.
 var debugDecodeImage = false; // devWarning(true);
+
+/// Get image meta from bytes.
 Future<ImageMeta> getImageMetaFromBytes(Uint8List bytes) async {
   var encoding = common.getImageEncodingFromBytes(bytes);
   var canvas = await OffscreenCanvas.fromBytes(bytes);
diff --git a/packages/app_image_web/lib/src/offscreen_canvas/src/offscreen_canvas.dart b/packages/app_image_web/lib/src/offscreen_canvas/src/offscreen_canvas.dart
@@ -97,6 +97,7 @@ class OffscreenCanvas {
     }
   }
 
+  /// Convert canvas to blob.
   Future<web.Blob> canvasToBlob(
     web.HTMLCanvasElement canvas,
     String mimeType,
@@ -117,6 +118,7 @@ class OffscreenCanvas {
   }
 
   // https://developer.mozilla.org/en-US/docs/Web/API/OffscreenCanvas/convertToBlob
+  /// Convert to blob.
   Future<web.Blob> toBlob(ImageEncoding encoding) async {
     if (_offScreenCanvas != null) {
       var blobOptions = web.ImageEncodeOptions();
@@ -143,6 +145,7 @@ class OffscreenCanvas {
     }
   }
 
+  /// Draw image to rect.
   void drawImageToRect(
     OffscreenCanvas offscreenCanvas,
     Rect<double> destRect, {
diff --git a/packages/app_image_web/lib/src/resize.dart b/packages/app_image_web/lib/src/resize.dart
@@ -4,6 +4,7 @@ import 'package:tekartik_app_image/app_image.dart';
 import 'package:tekartik_app_image/app_image_resize.dart';
 import 'package:tekartik_app_image_web/src/image_composer/image_composer.dart';
 
+/// Universal resize to.
 Future<ImageData> universalResizeTo(
   Uint8List bytes, {
   required ResizeOptions options,
@@ -23,5 +24,6 @@ Future<ImageData> universalResizeTo(
   return result;
 }
 
+/// Resize to.
 Future<ImageData> resizeTo(Uint8List bytes, {required ResizeOptions options}) =>
     universalResizeTo(bytes, options: options);
diff --git a/packages/app_pick_crop_image_flutter/analysis_options.yaml b/packages/app_pick_crop_image_flutter/analysis_options.yaml
@@ -3,4 +3,4 @@ include: package:tekartik_lints_flutter/package.yaml
 
 linter:
   rules:
-    public_member_api_docs: false
+    # public_member_api_docs: false
diff --git a/packages/app_pick_crop_image_flutter/lib/src/crop_image_page.dart b/packages/app_pick_crop_image_flutter/lib/src/crop_image_page.dart
@@ -7,18 +7,27 @@ import 'package:tekartik_app_pick_crop_image_flutter/src/pick_crop_image.dart';
 
 import 'oval_editor_painter.dart';
 
+/// Crop image page result.
 class CropImagePageResult {
+  /// Crop rectangle.
   final CropRect cropRect;
 
+  /// Crop image page result constructor.
   CropImagePageResult({required this.cropRect});
 
   @override
   String toString() => {'cropRect': cropRect}.toString();
 }
 
+/// Crop image page.
 class CropImagePage extends StatefulWidget {
+  /// Image bytes.
   final Uint8List bytes;
+
+  /// Pick crop image options.
   final PickCropImageOptions options;
+
+  /// Crop image page constructor.
   const CropImagePage({super.key, required this.bytes, required this.options});
 
   @override
diff --git a/packages/app_pick_crop_image_flutter/lib/src/oval_editor_painter.dart b/packages/app_pick_crop_image_flutter/lib/src/oval_editor_painter.dart
@@ -4,7 +4,9 @@ import 'package:extended_image/extended_image.dart';
 import 'package:flutter/material.dart';
 import 'package:tekartik_app_pick_crop_image_flutter/src/platform.dart';
 
+/// Oval editor crop layer painter.
 class OvalEditorCropLayerPainter extends EditorCropLayerPainter {
+  /// Oval editor crop layer painter constructor.
   const OvalEditorCropLayerPainter();
 
   @override
diff --git a/packages/app_pick_crop_image_flutter/lib/src/pick_crop_image.dart b/packages/app_pick_crop_image_flutter/lib/src/pick_crop_image.dart
@@ -8,14 +8,19 @@ import 'import_image.dart';
 import 'pick_crop_image_page.dart';
 import 'picked_file.dart';
 
+/// PNG mime type.
 const mimeTypePng = 'image/png';
+
+/// JPEG mime type.
 const mimeTypeJpg = 'image/jpeg';
 
 /// Image source.
 abstract class PickCropImageSource implements ImageSource {}
 
+/// Pick from the gallery.
 /// Pick from the gallery.
 class PickCropImageSourceGallery implements PickCropImageSource {
+  /// Pick from the gallery constructor.
   const PickCropImageSourceGallery();
 
   @override
@@ -37,10 +42,13 @@ enum SourceCameraDevice {
   front,
 }
 
+/// Pick from the camera.
 /// Pick from the camera.
 class PickCropImageSourceCamera implements PickCropImageSource {
+  /// Preferred camera device.
   final SourceCameraDevice preferredCameraDevice;
 
+  /// Pick from the camera constructor.
   const PickCropImageSourceCamera({
     this.preferredCameraDevice = SourceCameraDevice.rear,
   });
@@ -52,9 +60,11 @@ class PickCropImageSourceCamera implements PickCropImageSource {
 /// Memory source.
 class PickCropImageSourceMemory
     implements PickCropImageSource, ImageSourceAsyncData, ImageSourceData {
+  /// The bytes of the image.
   @override
   final Uint8List bytes;
 
+  /// Memory source constructor.
   const PickCropImageSourceMemory({required this.bytes});
 
   @override
@@ -64,10 +74,13 @@ class PickCropImageSourceMemory
   Future<Uint8List> getBytes() async => bytes;
 }
 
+/// Asset source.
 /// Asset source.
 class ImageSourceAsset implements PickCropImageSource, ImageSourceAsyncData {
+  /// Asset name.
   final String name;
 
+  /// Asset source constructor.
   ImageSourceAsset({required this.name});
 
   @override
@@ -90,10 +103,12 @@ class PickCropBaseImageOptions {
   /// Wanted encoding
   final ImageEncoding encoding;
 
+  /// Aspect ratio (width and height wins)
   /// Aspect ratio (width and height wins)
   num? get aspectRatio => _aspectRatio;
   num? _aspectRatio;
 
+  /// Pick crop image options constructor.
   PickCropBaseImageOptions({
     this.encoding = const ImageEncodingPng(),
     this.width,
@@ -107,8 +122,10 @@ class PickCropBaseImageOptions {
   }
 }
 
+/// Pick crop image options.
 /// Pick crop image options.
 class PickCropConvertImageOptions extends PickCropBaseImageOptions {
+  /// Convert pick crop image options constructor.
   PickCropConvertImageOptions({
     this.cropRect,
     super.width,
@@ -133,6 +150,7 @@ class PickCropImageOptions extends PickCropBaseImageOptions {
   /// Auto crop the image (fit, center)
   final bool autoCrop;
 
+  /// Pick crop image options constructor.
   PickCropImageOptions({
     super.width,
     super.height,
diff --git a/packages/app_pick_crop_image_flutter/lib/src/pick_crop_image_page.dart b/packages/app_pick_crop_image_flutter/lib/src/pick_crop_image_page.dart
@@ -11,11 +11,18 @@ import 'import_image.dart';
 import 'pick_crop_image.dart';
 import 'picked_file.dart';
 
+/// Pick image crop page.
 class PickImageCropPage extends StatefulWidget {
+  /// File to pick.
   final TkPickedFile? file;
+
+  /// Pick crop image options.
   final PickCropImageOptions options;
+
+  /// Callback to convert the result.
   final ConvertPickCropResultCallback? callback;
 
+  /// Pick image crop page constructor.
   const PickImageCropPage({
     super.key,
     required this.options,
@@ -28,18 +35,26 @@ class PickImageCropPage extends StatefulWidget {
   _PickImageCropPageState createState() => _PickImageCropPageState();
 }
 
+/// Convert pick crop result param.
 class ConvertPickCropResultParam {
+  /// Image source data.
   final ImageSourceData imageSource;
+
+  /// Pick crop image options.
   final PickCropImageOptions options;
+
+  /// Crop rectangle.
   final CropRect cropRect;
 
+  /// Convert pick crop result param constructor.
   ConvertPickCropResultParam({
     required this.imageSource,
     required this.options,
     required this.cropRect,
   });
 }
 
+/// Convert pick crop result callback.
 typedef ConvertPickCropResultCallback =
     Future<ImageData> Function(ConvertPickCropResultParam param);
 
diff --git a/packages/app_pick_crop_image_flutter/lib/src/picked_file.dart b/packages/app_pick_crop_image_flutter/lib/src/picked_file.dart
@@ -8,21 +8,28 @@ import 'import.dart';
 
 /// Picked file result.
 abstract class TkPickedFile {
+  /// Read as bytes.
   Future<Uint8List> readAsBytes();
 }
 
+/// Picked file image.
 class TkPickedFileImage implements TkPickedFile {
+  /// XFile result.
   final XFile xFile;
 
+  /// Picked file image constructor.
   TkPickedFileImage(this.xFile);
 
   @override
   Future<Uint8List> readAsBytes() => xFile.readAsBytes();
 }
 
+/// Picked file platform.
 class TkPickedFilePlatform implements TkPickedFile {
+  /// Platform file result.
   final PlatformFile platformFile;
 
+  /// Picked file platform constructor.
   TkPickedFilePlatform(this.platformFile);
 
   @override
diff --git a/packages/app_pick_crop_image_flutter/lib/src/platform.dart b/packages/app_pick_crop_image_flutter/lib/src/platform.dart
diff --git a/packages/app_pick_crop_image_flutter/lib/src/platform_io.dart b/packages/app_pick_crop_image_flutter/lib/src/platform_io.dart
diff --git a/packages/app_pick_crop_image_flutter/lib/src/platform_stub.dart b/packages/app_pick_crop_image_flutter/lib/src/platform_stub.dart
diff --git a/packages/app_pick_crop_image_flutter/lib/src/platform_web.dart b/packages/app_pick_crop_image_flutter/lib/src/platform_web.dart
diff --git a/packages/app_pick_crop_image_flutter/lib/src/utils.dart b/packages/app_pick_crop_image_flutter/lib/src/utils.dart

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ Future<Uint8List> blobToBytesUsingFileReader(web.Blob value) async {`
`20`	`20`	`return Uint8List.view(byteBuffer);`
`21`	`21`	`}`
`22`	`22`
	`23`	`+/// Convert a blog a list of bytes`
`23`	`24`	`Future<Uint8List> blobToBytes(web.Blob value) async {`
`24`	`25`	`try {`
`25`	`26`	`return await blobToBytesUsingArrayBuffer(value);`