adminのjavadocを修正

AlesInfiny · Jan 14, 2025 · 239f263 · 239f263
1 parent 2c767ef
commit 239f263
Show file tree

Hide file tree

Showing 25 changed files with 94 additions and 96 deletions.
diff --git a/samples/web-csr/dressca-backend/api-docs/web-admin/api-specification.json b/samples/web-csr/dressca-backend/api-docs/web-admin/api-specification.json
@@ -13,16 +13,20 @@
   ],
   "tags": [
     {
-      "description": "カタログブランドの情報にアクセスするAPI",
-      "name": "CatalogBrands"
+      "description": "アセットの情報にアクセスする API",
+      "name": "Assets"
     },
     {
-      "description": "ログイン中のユーザーの情報を取得します。",
+      "description": "ログイン中のユーザーの情報にアクセスする API",
       "name": "Users"
     },
     {
-      "description": "カタログアイテムの情報にアクセスする API コントローラーです.",
-      "name": "CatalogItems"
+      "description": "カタログカテゴリの情報にアクセスする API",
+      "name": "CatalogCategories"
+    },
+    {
+      "description": "カタログブランドの情報にアクセスする API",
+      "name": "CatalogBrands"
     },
     {
       "description": "Monitor and interact",
@@ -33,12 +37,8 @@
       "name": "Actuator"
     },
     {
-      "description": "アセットの情報にアクセスするAPI",
-      "name": "Assets"
-    },
-    {
-      "description": "カタログカテゴリの情報にアクセスするAPI",
-      "name": "CatalogCategories"
+      "description": "カタログアイテムの情報にアクセスする API",
+      "name": "CatalogItems"
     }
   ],
   "paths": {
@@ -105,7 +105,7 @@
     },
     "/api/assets/{assetCode}": {
       "get": {
-        "description": "与えられたアセットコードに対応するアセットを返却する.",
+        "description": "与えられたアセットコードに対応するアセットを返却する。",
         "operationId": "get",
         "parameters": [
           {
@@ -142,15 +142,15 @@
             "description": "サーバーエラー。"
           }
         },
-        "summary": "アセットを取得する.",
+        "summary": "アセットを取得する。",
         "tags": [
           "Assets"
         ]
       }
     },
     "/api/catalog-brands": {
       "get": {
-        "description": "カタログブランドの一覧を取得する.",
+        "description": "カタログブランドの一覧を取得する。",
         "operationId": "getCatalogBrands",
         "responses": {
           "200": {
@@ -173,15 +173,15 @@
             "description": "サーバーエラー。"
           }
         },
-        "summary": "カタログブランドの一覧を取得する.",
+        "summary": "カタログブランドの一覧を取得する。",
         "tags": [
           "CatalogBrands"
         ]
       }
     },
     "/api/catalog-categories": {
       "get": {
-        "description": "カタログカテゴリの一覧を取得します.",
+        "description": "カタログカテゴリの一覧を取得します。",
         "operationId": "getCatalogCategories",
         "responses": {
           "200": {
@@ -204,15 +204,15 @@
             "description": "サーバーエラー。"
           }
         },
-        "summary": "カタログカテゴリの一覧を取得します.",
+        "summary": "カタログカテゴリの一覧を取得します。",
         "tags": [
           "CatalogCategories"
         ]
       }
     },
     "/api/catalog-items": {
       "get": {
-        "description": "カタログアイテムを検索して返します.",
+        "description": "カタログアイテムを検索して返します。",
         "operationId": "getByQuery",
         "parameters": [
           {
@@ -280,7 +280,7 @@
             "description": "サーバーエラー。"
           }
         },
-        "summary": "カタログアイテムを検索して返します.",
+        "summary": "カタログアイテムを検索して返します。",
         "tags": [
           "CatalogItems"
         ]
@@ -371,7 +371,7 @@
         ]
       },
       "put": {
-        "description": "指定したIDのカタログアイテムの情報を更新します。",
+        "description": "指定した ID のカタログアイテムの情報を更新します。",
         "operationId": "putCatalogItem",
         "parameters": [
           {
@@ -414,15 +414,15 @@
             "description": "サーバーエラー。"
           }
         },
-        "summary": "指定したIDのカタログアイテムの情報を更新します。",
+        "summary": "指定した ID のカタログアイテムの情報を更新します。",
         "tags": [
           "CatalogItems"
         ]
       }
     },
     "/api/catalog-items/{id}": {
       "get": {
-        "description": "指定したIDのカタログアイテムを返します。",
+        "description": "指定した ID のカタログアイテムを返します。",
         "operationId": "getCatalogItem",
         "parameters": [
           {
@@ -459,7 +459,7 @@
             "description": "サーバーエラー。"
           }
         },
-        "summary": "指定したIDのカタログアイテムを返します。",
+        "summary": "指定した ID のカタログアイテムを返します。",
         "tags": [
           "CatalogItems"
         ]
@@ -492,7 +492,7 @@
     },
     "/api/users": {
       "get": {
-        "description": "ユーザーの情報。",
+        "description": "ログイン中のユーザーの情報を取得します。",
         "operationId": "getLoginUser",
         "responses": {
           "200": {

diff --git a/...web-csr/dressca-backend/web-admin/src/main/java/com/dressca/web/admin/WebApplication.java b/...web-csr/dressca-backend/web-admin/src/main/java/com/dressca/web/admin/WebApplication.java
@@ -7,13 +7,18 @@
 import io.swagger.v3.oas.annotations.info.Info;
 
 /**
- * Dresscaアプリケーションを起動するためのmainクラスです。
+ * Dressca アプリケーションを起動するための main クラスです。
  */
 @SpringBootApplication
 @OpenAPIDefinition(info = @Info(title = "Dressca", description = "ECサイトDressca", version = "v1"))
 @ComponentScan(basePackages = { "com.dressca" })
 public class WebApplication {
 
+  /**
+   * Dressca アプリケーションを起動します。
+   * 
+   * @param args コマンドライン引数。
+   */
   public static void main(String[] args) {
     SpringApplication.run(WebApplication.class, args);
   }

diff --git a/...ca-backend/web-admin/src/main/java/com/dressca/web/admin/authorization/UserStoreImpl.java b/...ca-backend/web-admin/src/main/java/com/dressca/web/admin/authorization/UserStoreImpl.java
@@ -10,16 +10,11 @@
 import com.dressca.applicationcore.authorization.UserStore;
 
 /**
- * ユーザのセッション情報。
+ * ユーザのセッション情報です。
  */
 @Component
 public class UserStoreImpl implements UserStore {
 
-  /**
-   * ログイン中のユーザー名を取得します。
-   *
-   * @return ログイン中のユーザー名。未ログインの場合、空文字。
-   */
   @Override
   public String getLoginUserName() {
     Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
@@ -29,11 +24,6 @@ public String getLoginUserName() {
     return "";
   }
 
-  /**
-   * ログイン中のユーザーのロールを取得します。
-   *
-   * @return ログイン中のユーザーのロールの配列。未ログインの場合、空の配列。
-   */
   @Override
   public List<String> getLoginUserRoles() {
     Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
@@ -45,11 +35,7 @@ public List<String> getLoginUserRoles() {
     return new ArrayList<>();
   }
 
-  /**
-   * ログイン中のユーザーが指定したロールに属しているかどうか確認します。
-   *
-   * @return ロールに属している場合true。未ログインの場合false。
-   */
+  @Override
   public boolean isInRole(String role) {
     Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
     if (authentication != null) {

diff --git a/...ressca-backend/web-admin/src/main/java/com/dressca/web/admin/config/DresscaWebConfig.java b/...ressca-backend/web-admin/src/main/java/com/dressca/web/admin/config/DresscaWebConfig.java
@@ -4,7 +4,7 @@
 import org.springframework.context.annotation.Configuration;
 
 /**
- * Dressca Web用の設定クラス。
+ * Dressca Web 用の設定クラスです。
  */
 @Configuration
 public class DresscaWebConfig {

diff --git a/...ressca-backend/web-admin/src/main/java/com/dressca/web/admin/config/H2ServerLauncher.java b/...ressca-backend/web-admin/src/main/java/com/dressca/web/admin/config/H2ServerLauncher.java
@@ -8,7 +8,7 @@
 import java.sql.SQLException;
 
 /**
- * 開発環境でh2データベースを立ち上げるためのクラスです。
+ * 開発環境で h2 データベースを立ち上げるためのクラスです。
  */
 @Component
 @Profile("local")
@@ -17,7 +17,7 @@ public class H2ServerLauncher {
   private Server tcpServer;
 
   /**
-   * h2サーバをサーバーモードで起動します。
+   * h2 サーバをサーバーモードで起動します。
    */
   @PostConstruct
   public void start() {
@@ -29,7 +29,7 @@ public void start() {
   }
 
   /**
-   * h2サーバを停止します。
+   * h2 サーバを停止します。
    */
   @PreDestroy
   public void stop() {

diff --git a/...ca-backend/web-admin/src/main/java/com/dressca/web/admin/controller/AssetsController.java b/...ca-backend/web-admin/src/main/java/com/dressca/web/admin/controller/AssetsController.java
@@ -29,10 +29,10 @@
 import lombok.AllArgsConstructor;
 
 /**
- * {@link Asset} の情報にアクセスするAPIコントローラーです。
+ * {@link Asset} の情報にアクセスする API コントローラーです。
  */
 @RestController
-@Tag(name = "Assets", description = "アセットの情報にアクセスするAPI")
+@Tag(name = "Assets", description = "アセットの情報にアクセスする API")
 @RequestMapping("/api/assets")
 @AllArgsConstructor
 @PreAuthorize(value = "isAuthenticated()")
@@ -46,10 +46,10 @@ public class AssetsController {
   /**
    * アセットを取得します。
    * 
-   * @param assetCode アセットコード
-   * @return アセット
+   * @param assetCode アセットコード。
+   * @return アセット。
    */
-  @Operation(summary = "アセットを取得する.", description = "与えられたアセットコードに対応するアセットを返却する.")
+  @Operation(summary = "アセットを取得する。", description = "与えられたアセットコードに対応するアセットを返却する。")
   @ApiResponses(value = {
       @ApiResponse(responseCode = "200", description = "成功。", content = @Content(mediaType = "image/*", schema = @Schema(implementation = Resource.class))),
       @ApiResponse(responseCode = "401", description = "未認証。", content = @Content),
@@ -75,8 +75,8 @@ public ResponseEntity<Resource> get(
   /**
    * アセットタイプから Content-Type に変換します。
    * 
-   * @param asset アセット
-   * @return Content-Type の名称
+   * @param asset アセット。
+   * @return Content-Type の名称。
    */
   private MediaType getContentType(Asset asset) {
     switch (asset.getAssetType()) {

diff --git a/...end/web-admin/src/main/java/com/dressca/web/admin/controller/CatalogBrandsController.java b/...end/web-admin/src/main/java/com/dressca/web/admin/controller/CatalogBrandsController.java
@@ -25,7 +25,7 @@
  * {@link CatalogBrand} の情報にアクセスする API コントローラーです。
  */
 @RestController
-@Tag(name = "CatalogBrands", description = "カタログブランドの情報にアクセスするAPI")
+@Tag(name = "CatalogBrands", description = "カタログブランドの情報にアクセスする API")
 @RequestMapping("/api/catalog-brands")
 @AllArgsConstructor
 @PreAuthorize(value = "isAuthenticated()")
@@ -39,7 +39,7 @@ public class CatalogBrandsController {
    * 
    * @return カタログブランドの一覧
    */
-  @Operation(summary = "カタログブランドの一覧を取得する.", description = "カタログブランドの一覧を取得する.")
+  @Operation(summary = "カタログブランドの一覧を取得する。", description = "カタログブランドの一覧を取得する。")
   @ApiResponses(value = {
       @ApiResponse(responseCode = "200", description = "成功。", content = @Content(mediaType = "application/json", array = @ArraySchema(schema = @Schema(implementation = GetCatalogBrandsResponse.class)))),
       @ApiResponse(responseCode = "401", description = "未認証。", content = @Content),

diff --git a/...web-admin/src/main/java/com/dressca/web/admin/controller/CatalogCategoriesController.java b/...web-admin/src/main/java/com/dressca/web/admin/controller/CatalogCategoriesController.java
@@ -25,7 +25,7 @@
  * {@link CatalogCategory} の情報にアクセスする API コントローラーです。
  */
 @RestController
-@Tag(name = "CatalogCategories", description = "カタログカテゴリの情報にアクセスするAPI")
+@Tag(name = "CatalogCategories", description = "カタログカテゴリの情報にアクセスする API")
 @RequestMapping("/api/catalog-categories")
 @AllArgsConstructor
 @PreAuthorize(value = "isAuthenticated()")
@@ -39,7 +39,7 @@ public class CatalogCategoriesController {
    * 
    * @return カタログカテゴリの一覧。
    */
-  @Operation(summary = "カタログカテゴリの一覧を取得します.", description = "カタログカテゴリの一覧を取得します.")
+  @Operation(summary = "カタログカテゴリの一覧を取得します。", description = "カタログカテゴリの一覧を取得します。")
   @ApiResponses(value = {
       @ApiResponse(responseCode = "200", description = "成功。", content = @Content(mediaType = "application/json", array = @ArraySchema(schema = @Schema(implementation = GetCatalogCategoriesResponse.class)))),
       @ApiResponse(responseCode = "401", description = "未認証。", content = @Content),