Azure AD B2CのJavadocコメントの体裁を統一する (#1841)

* system-commonのJavadocを修正

* webのJavadocを修正

* UserControllerのAPIの説明をですます調に変更

* API仕様書を再生成

samples/azure-ad-b2c-sample/auth-backend/api-docs/api-specification.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.1.0",
   "info": {
-    "description": "Azure AD B2Cを利用したユーザー認証機能を提供するサンプルアプリケーションです。",
+    "description": "Azure AD B2C を利用したユーザー認証機能を提供するサンプルアプリケーションです。",
     "title": "Azure AD B2C ユーザー認証",
     "version": "v1"
   },
@@ -13,18 +13,18 @@
   ],
   "tags": [
     {
-      "description": "認証不要でサーバーの現在時刻を取得する",
-      "name": "ServerTime"
+      "description": "認証済みユーザのユーザ ID を取得する API です。",
+      "name": "User"
     },
     {
-      "description": "認証済みユーザのユーザIDを取得するAPI",
-      "name": "User"
+      "description": "認証不要でサーバーの現在時刻を取得します。",
+      "name": "ServerTime"
     }
   ],
   "paths": {
     "/api/servertime": {
       "get": {
-        "description": "サーバーの現在時刻を取得します.",
+        "description": "サーバーの現在時刻を取得します。",
         "operationId": "getServerTime",
         "responses": {
           "200": {
@@ -35,18 +35,18 @@
                 }
               }
             },
-            "description": "成功."
+            "description": "成功。"
           }
         },
-        "summary": "サーバーの現在時刻を取得します.",
+        "summary": "サーバーの現在時刻を取得します。",
         "tags": [
           "ServerTime"
         ]
       }
     },
     "/api/user": {
       "get": {
-        "description": "ログインに成功したユーザIDを取得します.",
+        "description": "ログインに成功したユーザ ID を取得します。",
         "operationId": "getUser",
         "responses": {
           "200": {
@@ -57,7 +57,7 @@
                 }
               }
             },
-            "description": "成功."
+            "description": "成功。"
           },
           "401": {
             "content": {
@@ -67,15 +67,15 @@
                 }
               }
             },
-            "description": "未認証エラー."
+            "description": "未認証エラー。"
           }
         },
         "security": [
           {
             "Bearer": []
           }
         ],
-        "summary": "ログインに成功したユーザIDを取得します.",
+        "summary": "ログインに成功したユーザ ID を取得します。",
         "tags": [
           "User"
         ]

samples/azure-ad-b2c-sample/auth-backend/system-common/src/main/java/com/dressca/systemcommon/constant/CommonExceptionIdConstants.java

@@ -1,7 +1,7 @@
 package com.dressca.systemcommon.constant;
 
 /**
- * 例外ID用定数クラス。
+ * 例外 ID 用の定数クラスです。
  */
 public class CommonExceptionIdConstants {
   /** 想定外のシステムエラーが発生しました。 */

samples/azure-ad-b2c-sample/auth-backend/system-common/src/main/java/com/dressca/systemcommon/constant/SystemPropertyConstants.java

@@ -1,7 +1,7 @@
 package com.dressca.systemcommon.constant;
 
 /**
- * システムプロパティ用定数クラス。
+ * システムプロパティ用の定数クラスです。
  */
 public class SystemPropertyConstants {
   /** アプリケーションログのロガー名。 */

samples/azure-ad-b2c-sample/auth-backend/system-common/src/main/java/com/dressca/systemcommon/exception/SystemException.java

@@ -17,12 +17,12 @@ public class SystemException extends RuntimeException {
   private String[] logMessageValue = null;
 
   /**
-   * コンストラクタ。
+   * {@link SystemException} クラスのインスタンスを初期化します。
    *
-   * @param cause             原因例外
-   * @param exceptionId       例外ID
-   * @param frontMessageValue メッセージ用プレースフォルダ（フロント用）
-   * @param logMessageValue   メッセージ用プレースフォルダ（ログ用）
+   * @param cause             原因例外。
+   * @param exceptionId       例外 ID 。
+   * @param frontMessageValue メッセージ用プレースフォルダ（フロント用）。
+   * @param logMessageValue   メッセージ用プレースフォルダ（ログ用）。
    */
   public SystemException(Throwable cause, String exceptionId,
       String[] frontMessageValue, String[] logMessageValue) {

samples/azure-ad-b2c-sample/auth-backend/system-common/src/main/java/com/dressca/systemcommon/util/ApplicationContextWrapper.java

@@ -6,7 +6,7 @@
 import org.springframework.stereotype.Component;
 
 /**
- * ApplicationContextを保持するラッパークラスです。
+ * ApplicationContext を保持するラッパークラスです。
  */
 @Component
 public class ApplicationContextWrapper implements ApplicationContextAware {
@@ -18,11 +18,24 @@ public void setApplicationContext(ApplicationContext applicationContext) throws
     context = applicationContext;
   }
 
+  /**
+   * 指定されたクラスの Bean を取得します。
+   * 
+   * @param <T>   取得する Bean の型。
+   * @param clazz 取得する Bean のクラス。
+   * @return 指定されたクラスの Bean 。
+   */
   public static <T> T getBean(Class<T> clazz) {
     return context.getBean(clazz);
   }
 
+  /**
+   * 指定された名前の Bean を取得します。
+   * 
+   * @param name 取得する Bean の名前。
+   * @return 指定された名前の Bean 。
+   */
   public static Object getBean(String name) {
     return context.getBean(name);
   }
-}
+}

samples/azure-ad-b2c-sample/auth-backend/web/src/main/java/com/dressca/web/WebApplication.java

@@ -7,13 +7,18 @@
 import io.swagger.v3.oas.annotations.info.Info;
 
 /**
- * Azure AD B2Cを利用した認証機能を提供するアプリケーションを起動するためのmainクラスです。
+ * Azure AD B2C を利用した認証機能を提供するアプリケーションを起動するための main クラスです。
  */
 @SpringBootApplication
-@OpenAPIDefinition(info = @Info(title = "Azure AD B2C ユーザー認証", description = "Azure AD B2Cを利用したユーザー認証機能を提供するサンプルアプリケーションです。", version = "v1"))
+@OpenAPIDefinition(info = @Info(title = "Azure AD B2C ユーザー認証", description = "Azure AD B2C を利用したユーザー認証機能を提供するサンプルアプリケーションです。", version = "v1"))
 @ComponentScan(basePackages = { "com.dressca" })
 public class WebApplication {
 
+  /**
+   * Azure AD B2C を利用した認証機能を提供するアプリケーションを起動します。
+   * 
+   * @param args コマンドライン引数。
+   */
   public static void main(String[] args) {
     SpringApplication.run(WebApplication.class, args);
   }

samples/azure-ad-b2c-sample/auth-backend/web/src/main/java/com/dressca/web/constant/WebConstants.java

@@ -1,11 +1,11 @@
 package com.dressca.web.constant;
 
 /**
- * web プロジェクトで利用する汎用定数クラス。
+ * web プロジェクトで利用する汎用定数クラスです。
  */
 public class WebConstants {
 
-  /** Exception ID。 */
+  /** Exception ID 。 */
   public static final String EXCEPTION_ID = "exceptionId";
 
   /** Exception ID に紐づく例外値。 */

samples/azure-ad-b2c-sample/auth-backend/web/src/main/java/com/dressca/web/controller/ServerTimeController.java

@@ -15,24 +15,23 @@
 import io.swagger.v3.oas.annotations.tags.Tag;
 
 /**
- * Azure AD B2Cに接続するためのコントローラークラス。
+ * Azure AD B2C に接続するためのコントローラークラスです。
  */
 @RestController
-@Tag(name = "ServerTime", description = "認証不要でサーバーの現在時刻を取得する")
+@Tag(name = "ServerTime", description = "認証不要でサーバーの現在時刻を取得します。")
 @RequestMapping("/api/servertime")
 public class ServerTimeController {
 
   /**
-   * サーバーの現在時刻取得。
+   * サーバーの現在時刻を取得します。
    * 
-   * @return レスポンス
-   * @throws Exception 例外
+   * @return レスポンス。
+   * @throws Exception 例外。
    */
-  @Operation(summary = "サーバーの現在時刻を取得します.", description = "サーバーの現在時刻を取得します.")
+  @Operation(summary = "サーバーの現在時刻を取得します。", description = "サーバーの現在時刻を取得します。")
   @ApiResponses(value = {
-      @ApiResponse(responseCode = "200", description = "成功.", content = @Content(mediaType = "application/json", schema = @Schema(implementation = TimeResponse.class)))
+      @ApiResponse(responseCode = "200", description = "成功。", content = @Content(mediaType = "application/json", schema = @Schema(implementation = TimeResponse.class)))
   })
-
   @GetMapping
   public ResponseEntity<TimeResponse> getServerTime() throws Exception {
 

samples/azure-ad-b2c-sample/auth-backend/web/src/main/java/com/dressca/web/controller/UserController.java

@@ -18,26 +18,25 @@
 import io.swagger.v3.oas.annotations.tags.Tag;
 
 /**
- * Azure AD B2Cに接続するためのコントローラークラス。
+ * Azure AD B2C に接続するためのコントローラークラスです。
  */
 @RestController
-@Tag(name = "User", description = "認証済みユーザのユーザIDを取得するAPI")
+@Tag(name = "User", description = "認証済みユーザのユーザ ID を取得する API です。")
 @RequestMapping("/api/user")
 public class UserController {
 
   /**
-   * ログイン時のメッセージ取得。
+   * ログイン時のメッセージを取得します。
    * 
-   * @return レスポンス
-   * @throws Exception 例外
+   * @return レスポンス。
+   * @throws Exception 例外。
    */
-  @Operation(summary = "ログインに成功したユーザIDを取得します.", description = "ログインに成功したユーザIDを取得します.", security = {
+  @Operation(summary = "ログインに成功したユーザ ID を取得します。", description = "ログインに成功したユーザ ID を取得します。", security = {
       @SecurityRequirement(name = "Bearer") })
   @ApiResponses(value = {
-      @ApiResponse(responseCode = "200", description = "成功.", content = @Content(mediaType = "application/json", schema = @Schema(implementation = UserResponse.class))),
-      @ApiResponse(responseCode = "401", description = "未認証エラー.", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class)))
+      @ApiResponse(responseCode = "200", description = "成功。", content = @Content(mediaType = "application/json", schema = @Schema(implementation = UserResponse.class))),
+      @ApiResponse(responseCode = "401", description = "未認証エラー。", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class)))
   })
-
   @GetMapping
   @CrossOrigin
   @PreAuthorize(value = "isAuthenticated()")

samples/azure-ad-b2c-sample/auth-backend/web/src/main/java/com/dressca/web/controller/advice/ExceptionHandlerControllerAdvice.java

@@ -28,11 +28,11 @@ public class ExceptionHandlerControllerAdvice extends ResponseEntityExceptionHan
   private ProblemDetailsFactory problemDetailsFactory;
 
   /**
-   * 未認証の例外をステータースコード401で返却する。
+   * 未認証の例外をステータースコード 401 で返却します。
    *
-   * @param e   未認証の例外
-   * @param req リクエスト
-   * @return ステータースコード401のレスポンス
+   * @param e   未認証の例外。
+   * @param req リクエスト。
+   * @return ステータースコード 401 のレスポンス。
    */
   @ExceptionHandler(AccessDeniedException.class)
   public ResponseEntity<ProblemDetail> accessDeniedHandleException(AccessDeniedException e, HttpServletRequest req) {
@@ -48,11 +48,11 @@ public ResponseEntity<ProblemDetail> accessDeniedHandleException(AccessDeniedExc
   }
 
   /**
-   * その他の例外をステータースコード500で返却する。
+   * その他の例外をステータースコード 500 で返却します。
    *
-   * @param e   その他の例外
-   * @param req リクエスト
-   * @return ステータースコード500のレスポンス
+   * @param e   その他の例外。
+   * @param req リクエスト。
+   * @return ステータースコード 500 のレスポンス。
    */
   @ExceptionHandler(Exception.class)
   public ResponseEntity<ProblemDetail> handleException(Exception e, HttpServletRequest req) {

samples/azure-ad-b2c-sample/auth-backend/web/src/main/java/com/dressca/web/controller/advice/ProblemDetailsFactory.java

@@ -29,10 +29,10 @@ public class ProblemDetailsFactory {
   /**
    * エラーレスポンスに含める ProblemDetails を作成する。
    *
-   * @param errorBuilder 例外ビルダー
-   * @param titleId      タイトルのメッセージ ID
-   * @param status       ステータスコード
-   * @return エラーレスポンスに格納する ProblemDetails
+   * @param errorBuilder 例外ビルダー。
+   * @param titleId      タイトルのメッセージ ID 。
+   * @param status       ステータスコード。
+   * @return エラーレスポンスに格納する ProblemDetails 。
    */
   public ProblemDetail createProblemDetail(ErrorMessageBuilder errorBuilder, String titleId, HttpStatus status) {
 

samples/azure-ad-b2c-sample/auth-backend/web/src/main/java/com/dressca/web/controller/dto/auth/UserResponse.java

@@ -6,7 +6,7 @@
 import lombok.NoArgsConstructor;
 
 /**
- * ログインに成功した際のユーザIDを格納するクラス。
+ * ログインに成功した際のユーザ ID を格納するクラスです。
  */
 @Data
 @NoArgsConstructor

samples/azure-ad-b2c-sample/auth-backend/web/src/main/java/com/dressca/web/controller/dto/time/TimeResponse.java

@@ -6,7 +6,7 @@
 import lombok.NoArgsConstructor;
 
 /**
- * サーバーの現在時刻を格納するクラス。
+ * サーバーの現在時刻を格納するクラスです。
  */
 @Data
 @NoArgsConstructor

samples/azure-ad-b2c-sample/auth-backend/web/src/main/java/com/dressca/web/log/ErrorMessageBuilder.java

@@ -25,9 +25,9 @@ public class ErrorMessageBuilder {
   private String[] frontMessageValue;
 
   /**
-   * ProblemDetailsのdetail情報に格納するスタックトレースを作成します。
+   * ProblemDetails の detail 情報に格納するスタックトレースを作成します。
    * 
-   * @return スタックトレース
+   * @return スタックトレース。
    */
   public String createLogMessageStackTrace() {
     StringBuilder builder = new StringBuilder();

samples/azure-ad-b2c-sample/auth-backend/web/src/main/java/com/dressca/web/security/UserIdThreadContextFilter.java

@@ -15,7 +15,7 @@
 import jakarta.servlet.http.HttpServletResponse;
 
 /**
- * ユーザーIDをthreadLocalに格納するためのフィルタークラス。
+ * ユーザー ID を threadLocal に格納するためのフィルタークラスです。
  */
 public class UserIdThreadContextFilter extends OncePerRequestFilter {
 
@@ -24,7 +24,7 @@ public class UserIdThreadContextFilter extends OncePerRequestFilter {
   public static final ThreadLocal<String> threadLocalUserId = new ThreadLocal<>();
 
   /**
-   * フィルターの実行クラス。
+   * フィルターの実行クラスです。
    */
   @Override
   protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)

samples/azure-ad-b2c-sample/auth-backend/web/src/main/java/com/dressca/web/security/WebSecurityConfig.java

@@ -16,7 +16,7 @@
 import java.util.List;
 
 /**
- * セキュリティ関連の実行クラス。
+ * セキュリティ関連の実行クラスです。
  */
 @Configuration(proxyBeanMethods = false)
 @EnableWebSecurity
@@ -28,11 +28,11 @@ public class WebSecurityConfig {
   private String allowedOrigins;
 
   /**
-   * CORS設定、JWTトークン検証を実行。
+   * CORS 設定、JWT トークン検証を設定します。
    *
-   * @param http httpリクエスト
-   * @return フィルターチェーン
-   * @throws Exception 例外
+   * @param http http リクエスト。
+   * @return フィルターチェーン。
+   * @throws Exception 例外。
    */
   @Bean
   public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {

samples/azure-ad-b2c-sample/auth-backend/web/src/test/java/com/dressca/web/controller/ServerTimeControllerTest.java

@@ -14,7 +14,7 @@
 import com.dressca.web.WebApplication;
 
 /**
- * {@link ServerTimeController}の動作をテストするクラスです。
+ * {@link ServerTimeController} の動作をテストするクラスです。
  */
 @SpringJUnitConfig
 @SpringBootTest(classes = WebApplication.class)

samples/azure-ad-b2c-sample/auth-backend/web/src/test/java/com/dressca/web/controller/UserControllerTest.java

@@ -16,7 +16,7 @@
 import com.dressca.web.WebApplication;
 
 /**
- * {@link UserController}の動作をテストするクラスです。
+ * {@link UserController} の動作をテストするクラスです。
  */
 @SpringJUnitConfig
 @SpringBootTest(classes = WebApplication.class)