diff --git a/packages/firebase_common/lib/src/firestore_repositories/review.dart b/packages/firebase_common/lib/src/firestore_repositories/review.dart index 41b4781e..a7285f62 100644 --- a/packages/firebase_common/lib/src/firestore_repositories/review.dart +++ b/packages/firebase_common/lib/src/firestore_repositories/review.dart @@ -59,7 +59,7 @@ class ReviewRepository { Future fetchReview({required String reviewId}) => _query.fetchDocument(reviewId: reviewId); - /// [Review] の情報を作成する。 + /// [Review] を作成する。 Future create({ required String workerId, required String jobId, @@ -77,7 +77,7 @@ class ReviewRepository { ), ); - /// [Review] の情報を更新する。 + /// [Review] を更新する。 Future update({ required String reviewId, String? title, diff --git a/packages/mottai_flutter_app/lib/development/review/ui/review_create.dart b/packages/mottai_flutter_app/lib/development/review/ui/review_create.dart index 65d4acd0..e933dd36 100644 --- a/packages/mottai_flutter_app/lib/development/review/ui/review_create.dart +++ b/packages/mottai_flutter_app/lib/development/review/ui/review_create.dart @@ -5,7 +5,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import '../../../auth/ui/auth_dependent_builder.dart'; import 'review_form.dart'; -/// レビュー投稿画面。 +/// `Job` に紐づく `Review` (=感想)の投稿画面。 @RoutePage() class ReviewCreatePage extends ConsumerWidget { const ReviewCreatePage({ diff --git a/packages/mottai_flutter_app/lib/development/review/ui/review_form.dart b/packages/mottai_flutter_app/lib/development/review/ui/review_form.dart index 1c1af363..05d6d7c8 100644 --- a/packages/mottai_flutter_app/lib/development/review/ui/review_form.dart +++ b/packages/mottai_flutter_app/lib/development/review/ui/review_form.dart @@ -9,8 +9,8 @@ import '../../../widgets/optional_badge.dart'; import '../../firebase_storage/firebase_storage.dart'; import '../../firebase_storage/ui/firebase_storage_controller.dart'; -/// - `create` の場合、ログイン済みの `workerId`(ユーザー ID) -/// - `update` の場合、更新対象の [Review] とその本人であることが確認された `workerId`(ユーザー ID) +/// - `create` の場合、ログイン済みの `workerId`(ユーザー ID)と、対象の `jobId` +/// - `update` の場合、更新対象の [Review] と、対象の`jobId`、本人であることが確認された `workerId`(ユーザー ID) /// /// を受け取り、それに応じた [Review] の作成または更新を行うフォーム。 class ReviewForm extends ConsumerStatefulWidget { diff --git a/packages/mottai_flutter_app/lib/development/review/ui/review_update.dart b/packages/mottai_flutter_app/lib/development/review/ui/review_update.dart index 7cdf0a9e..d18d504c 100644 --- a/packages/mottai_flutter_app/lib/development/review/ui/review_update.dart +++ b/packages/mottai_flutter_app/lib/development/review/ui/review_update.dart @@ -6,7 +6,7 @@ import '../../../auth/ui/auth_dependent_builder.dart'; import '../../../review/review.dart'; import 'review_form.dart'; -/// レビュー更新画面。 +/// `Job` に紐づく `Review` (=感想)の更新画面。 @RoutePage() class ReviewUpdatePage extends ConsumerWidget { const ReviewUpdatePage({ diff --git a/packages/mottai_flutter_app/lib/review/review.dart b/packages/mottai_flutter_app/lib/review/review.dart index 69841b97..95fc5328 100644 --- a/packages/mottai_flutter_app/lib/review/review.dart +++ b/packages/mottai_flutter_app/lib/review/review.dart @@ -40,6 +40,9 @@ final reviewServiceProvider = Provider.autoDispose( ), ); +/// [Job] に紐づく [Review] (=感想)に関する振る舞いを担当するサービスクラス。 +/// +/// [Review] (=感想)の取得、作成、更新のメソッドを提供する。 class ReviewService { const ReviewService({required ReviewRepository reviewRepository}) : _reviewRepository = reviewRepository; @@ -50,7 +53,7 @@ class ReviewService { Future fetchReview({required String reviewId}) => _reviewRepository.fetchReview(reviewId: reviewId); - /// [Review] の情報を作成する。 + /// [Review] を作成する。 Future create({ required String workerId, required String jobId, @@ -66,7 +69,7 @@ class ReviewService { imageUrl: imageUrl, ); - /// [Review] の情報を更新する。 + /// [Review] を更新する。 Future update({ required String reviewId, String? title,