Merge pull request #13 from KobayashiYoh/feature/documentation

Add documentation to CameraUtil and FocusedAreaOCRPainter classes
KobayashiYoh · Apr 14, 2024 · cdb1656 · cdb1656
2 parents f95bfd9 + 67d0ca7
commit cdb1656
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.0.3
+
+* Add documentation to CameraUtil and FocusedAreaOCRPainter classes.
+
 ## 0.0.2
 
 * Add documentation to classes and members.

diff --git a/lib/camera_util.dart b/lib/camera_util.dart
@@ -4,6 +4,7 @@ import 'package:camera/camera.dart';
 import 'package:flutter/services.dart';
 import 'package:google_mlkit_commons/google_mlkit_commons.dart';
 
+/// Utility class for handling camera-related operations.
 class CameraUtil {
   /// Utility class for handling camera-related operations.
   static final _orientations = {

diff --git a/lib/focused_area_ocr_painter.dart b/lib/focused_area_ocr_painter.dart
@@ -6,6 +6,7 @@ import 'package:flutter/material.dart';
 import 'package:focused_area_ocr_flutter/coordinate_util.dart';
 import 'package:google_mlkit_text_recognition/google_mlkit_text_recognition.dart';
 
+/// A custom painter for rendering the focused area and recognized text on a canvas.
 class FocusedAreaOCRPainter extends CustomPainter {
   FocusedAreaOCRPainter({
     required this.recognizedText,

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 name: focused_area_ocr_flutter
 description: This is a package to get text in the focused area on the camera. It is created based on OCR technology by https://pub.dev/packages/google_mlkit_text_recognition.
-version: 0.0.2
+version: 0.0.3
 repository: https://github.com/KobayashiYoh/focused_area_ocr_flutter
 
 environment: