docs(katana_router_annotation): Maintenance of Comments.

packages/katana_router_annotation/lib/katana_router_annotation.dart

@@ -1,6 +1,6 @@
 // Copyright 2022 mathru. All rights reserved.
 
-/// Definition of annotation when used in masamune.
+/// Define annotations to use the Katana router builder. Build with katana_router_builder using this annotation.
 ///
 /// To use, import `package:katana_router_annotation/katana_router_annotation.dart`.
 ///

packages/katana_router_annotation/lib/src/app_route.dart

@@ -1,9 +1,11 @@
 part of katana_router_annotation;
 
 /// Automatically generates routing for the entire application.
-/// アプリケーション全体のルーティングを自動生成します。
 ///
 /// By adding this annotation to the global field as shown in the example below, all pages defined with @PagePath will be automatically defined and routable in the application.
+///
+/// アプリケーション全体のルーティングを自動生成します。
+///
 /// 下記の例のようにグローバルのフィールドにこのアノテーションを付与することでアプリケーション内で@PagePathを付与して定義されたすべてのページが自動的に定義されルーティングが可能になります。
 ///
 /// ```dart
@@ -22,9 +24,11 @@ part of katana_router_annotation;
 const appRoute = AppRoute();
 
 /// Automatically generates routing for the entire application.
-/// アプリケーション全体のルーティングを自動生成します。
 ///
 /// By adding this annotation to the global field as shown in the example below, all pages defined with @PagePath will be automatically defined and routable in the application.
+///
+/// アプリケーション全体のルーティングを自動生成します。
+///
 /// 下記の例のようにグローバルのフィールドにこのアノテーションを付与することでアプリケーション内で@PagePathを付与して定義されたすべてのページが自動的に定義されルーティングが可能になります。
 ///
 /// ```dart
@@ -42,9 +46,11 @@ const appRoute = AppRoute();
 /// ```
 class AppRoute {
   /// Automatically generates routing for the entire application.
-  /// アプリケーション全体のルーティングを自動生成します。
   ///
   /// By adding this annotation to the global field as shown in the example below, all pages defined with @PagePath will be automatically defined and routable in the application.
+  ///
+  /// アプリケーション全体のルーティングを自動生成します。
+  ///
   /// 下記の例のようにグローバルのフィールドにこのアノテーションを付与することでアプリケーション内で@PagePathを付与して定義されたすべてのページが自動的に定義されルーティングが可能になります。
   ///
   /// ```dart

packages/katana_router_annotation/lib/src/page_param.dart

@@ -1,9 +1,11 @@
 part of katana_router_annotation;
 
 /// Annotation to map each widget parameter to a variable in the page root.
-/// 各ウィジェットのパラメーターとページのルートの変数を対応するためのアノテーション。
 ///
 /// The name of the parameter itself, i.e. `userId`, is used.
+///
+/// 各ウィジェットのパラメーターとページのルートの変数を対応するためのアノテーション。
+///
 /// パラメーターの名前そのもの、つまり`userId`が利用されます。
 ///
 /// ```dart
@@ -19,12 +21,15 @@ part of katana_router_annotation;
 const pageParam = PageParam();
 
 /// Annotation to map each widget parameter to a variable in the page root.
-/// 各ウィジェットのパラメーターとページのルートの変数を対応するためのアノテーション。
 ///
 /// Write `@ParaPathParam(\"user_id\")` as a parameter annotation to link the `user_id` in the path to the class argument `userId` as in the example below.
-/// 下記の例のようにパス内の`user_id`をクラス引数の`userId`に紐付けるために`@ParaPathParam("user_id")`をパラメータのアノテーションとして記述します。
 ///
 /// If [name] is set to [Null], the parameter name itself, i.e. `userId`, is used.
+///
+/// 各ウィジェットのパラメーターとページのルートの変数を対応するためのアノテーション。
+///
+/// 下記の例のようにパス内の`user_id`をクラス引数の`userId`に紐付けるために`@ParaPathParam("user_id")`をパラメータのアノテーションとして記述します。
+///
 /// [name]を[Null]にした場合はパラメーターの名前そのもの、つまり`userId`が利用されます。
 ///
 /// ```dart
@@ -39,12 +44,15 @@ const pageParam = PageParam();
 /// ```
 class PageParam {
   /// Annotation to map each widget parameter to a variable in the page root.
-  /// 各ウィジェットのパラメーターとページのルートの変数を対応するためのアノテーション。
   ///
   /// Write `@ParaPathParam(\"user_id\")` as a parameter annotation to link the `user_id` in the path to the class argument `userId` as in the example below.
-  /// 下記の例のようにパス内の`user_id`をクラス引数の`userId`に紐付けるために`@ParaPathParam("user_id")`をパラメータのアノテーションとして記述します。
   ///
   /// If [name] is set to [Null], the parameter name itself, i.e. `userId`, is used.
+  ///
+  /// 各ウィジェットのパラメーターとページのルートの変数を対応するためのアノテーション。
+  ///
+  /// 下記の例のようにパス内の`user_id`をクラス引数の`userId`に紐付けるために`@ParaPathParam("user_id")`をパラメータのアノテーションとして記述します。
+  ///
   /// [name]を[Null]にした場合はパラメーターの名前そのもの、つまり`userId`が利用されます。
   ///
   /// ```dart
@@ -60,6 +68,7 @@ class PageParam {
   const PageParam([this.name]);
 
   /// Name of parameter.
+  ///
   /// パラメータの名前。
   final String? name;
 }

packages/katana_router_annotation/lib/src/page_path.dart

@@ -1,12 +1,15 @@
 part of katana_router_annotation;
 
 /// Annotation defining the page.
-/// ページを定義するアノテーション。
 ///
 /// Specify the path of the page in [path] as it is.
-/// [path]にページのパスをそのまま指定します。
 ///
 /// When [redirect] is set, it is possible to write reroute settings for only that page.
+///
+/// ページを定義するアノテーション。
+///
+/// [path]にページのパスをそのまま指定します。
+///
 /// [redirect]を設定するとそのページのみに対応するリルート設定を記述することが可能です。
 ///
 /// ```dart
@@ -23,12 +26,15 @@ part of katana_router_annotation;
 /// ```
 class PagePath {
   /// Annotation defining the page.
-  /// ページを定義するアノテーション。
   ///
   /// Specify the path of the page in [path] as it is.
-  /// [path]にページのパスをそのまま指定します。
   ///
   /// When [redirect] is set, it is possible to write reroute settings for only that page.
+  ///
+  /// ページを定義するアノテーション。
+  ///
+  /// [path]にページのパスをそのまま指定します。
+  ///
   /// [redirect]を設定するとそのページのみに対応するリルート設定を記述することが可能です。
   ///
   /// ```dart
@@ -49,16 +55,20 @@ class PagePath {
   });
 
   /// Page path.
+  ///
   /// ページパス。
   final String path;
 
   /// Reroute settings.
-  /// リルート設定。
   ///
   /// When [redirect] is set, it is possible to write reroute settings for only that page.
-  /// [redirect]を設定するとそのページのみに対応するリルート設定を記述することが可能です。
   ///
   /// Only `RerouteQuery` and classes that extend it are used by the builder.
+  ///
+  /// リルート設定。
+  ///
+  /// [redirect]を設定するとそのページのみに対応するリルート設定を記述することが可能です。
+  ///
   /// `RerouteQuery`とそれを継承したクラスのみがbuilderで利用されます。
   final List<Object> redirect;
 }

packages/katana_router_annotation/lib/src/page_query.dart

@@ -1,12 +1,15 @@
 part of katana_router_annotation;
 
 /// Annotation to define the `RouteQuery` of the page.
-/// ページの`RouteQuery`を定義するためのアノテーション。
 ///
 /// Be sure to define it in the `static const` field.
-/// 必ず`static const`のフィールドに定義してください。
 ///
 /// By doing so, pages with annotations are defined in the routing object for all pages defined in [AppRoute].
+///
+/// ページの`RouteQuery`を定義するためのアノテーション。
+///
+/// 必ず`static const`のフィールドに定義してください。
+///
 /// こうすることにより[AppRoute]で定義した全ページのルーティングオブジェクトにアノテーションを付与したページが定義されます。
 ///
 /// ```dart
@@ -26,12 +29,15 @@ part of katana_router_annotation;
 const pageRouteQuery = PageRouteQuery();
 
 /// Annotation to define the `RouteQuery` of the page.
-/// ページの`RouteQuery`を定義するためのアノテーション。
 ///
 /// Be sure to define it in the `static const` field.
-/// 必ず`static const`のフィールドに定義してください。
 ///
 /// By doing so, pages with annotations are defined in the routing object for all pages defined in [AppRoute].
+///
+/// ページの`RouteQuery`を定義するためのアノテーション。
+///
+/// 必ず`static const`のフィールドに定義してください。
+///
 /// こうすることにより[AppRoute]で定義した全ページのルーティングオブジェクトにアノテーションを付与したページが定義されます。
 ///
 /// ```dart
@@ -50,12 +56,15 @@ const pageRouteQuery = PageRouteQuery();
 /// ```
 class PageRouteQuery {
   /// Annotation to define the `RouteQuery` of the page.
-  /// ページの`RouteQuery`を定義するためのアノテーション。
   ///
   /// Be sure to define it in the `static const` field.
-  /// 必ず`static const`のフィールドに定義してください。
   ///
   /// By doing so, pages with annotations are defined in the routing object for all pages defined in [AppRoute].
+  ///
+  /// ページの`RouteQuery`を定義するためのアノテーション。
+  ///
+  /// 必ず`static const`のフィールドに定義してください。
+  ///
   /// こうすることにより[AppRoute]で定義した全ページのルーティングオブジェクトにアノテーションを付与したページが定義されます。
   ///
   /// ```dart