From b30c01110aad51c6c7c3dbefd472de8d12c62ff7 Mon Sep 17 00:00:00 2001 From: sevenc-nanashi Date: Fri, 3 Nov 2023 10:01:26 +0900 Subject: [PATCH] =?UTF-8?q?Add:=20@throws=E3=82=92=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../hiroshiba/voicevoxcore/Synthesizer.java | 34 +++++++++++++------ .../jp/hiroshiba/voicevoxcore/UserDict.java | 2 ++ 2 files changed, 26 insertions(+), 10 deletions(-) diff --git a/crates/voicevox_core_java_api/lib/src/main/java/jp/hiroshiba/voicevoxcore/Synthesizer.java b/crates/voicevox_core_java_api/lib/src/main/java/jp/hiroshiba/voicevoxcore/Synthesizer.java index 66d4f5df2..d6437a7d9 100644 --- a/crates/voicevox_core_java_api/lib/src/main/java/jp/hiroshiba/voicevoxcore/Synthesizer.java +++ b/crates/voicevox_core_java_api/lib/src/main/java/jp/hiroshiba/voicevoxcore/Synthesizer.java @@ -29,6 +29,7 @@ protected void finalize() throws Throwable { * モデルを読み込む。 * * @param voiceModel 読み込むモデル。 + * @throws InvalidModelDataException 無効なモデルデータの場合。 */ public void loadVoiceModel(VoiceModel voiceModel) throws InvalidModelDataException { rsLoadVoiceModel(voiceModel); @@ -56,9 +57,10 @@ public boolean isLoadedVoiceModel(String voiceModelId) { /** * AquesTalk風記法から {@link AudioQuery} を生成する。 * - * @param kana AquesTalk風記法。 + * @param kana AquesTalk風記法。 * @param styleId スタイルID。 * @return {@link AudioQuery}。 + * @throws InferenceFailedException 推論に失敗した場合。 */ @Nonnull public AudioQuery createAudioQueryFromKana(String kana, int styleId) @@ -79,9 +81,10 @@ public AudioQuery createAudioQueryFromKana(String kana, int styleId) /** * 日本語のテキストから {@link AudioQuery} を生成する。 * - * @param text 日本語のテキスト。 + * @param text 日本語のテキスト。 * @param styleId スタイルID。 * @return {@link AudioQuery}。 + * @throws InferenceFailedException 推論に失敗した場合。 */ @Nonnull public AudioQuery createAudioQuery(String text, int styleId) throws InferenceFailedException { @@ -101,9 +104,10 @@ public AudioQuery createAudioQuery(String text, int styleId) throws InferenceFai /** * AquesTalk風記法から {@link AccentPhrase} のリストを生成する。 * - * @param kana AquesTalk風記法。 + * @param kana AquesTalk風記法。 * @param styleId スタイルID。 * @return {@link AccentPhrase} のリスト。 + * @throws InferenceFailedException 推論に失敗した場合。 */ @Nonnull public List createAccentPhrasesFromKana(String kana, int styleId) @@ -120,9 +124,10 @@ public List createAccentPhrasesFromKana(String kana, int styleId) /** * 日本語のテキストから {@link AccentPhrase} のリストを生成する。 * - * @param text 日本語のテキスト。 + * @param text 日本語のテキスト。 * @param styleId スタイルID。 * @return {@link AccentPhrase} のリスト。 + * @throws InferenceFailedException 推論に失敗した場合。 */ @Nonnull public List createAccentPhrases(String text, int styleId) @@ -140,8 +145,9 @@ public List createAccentPhrases(String text, int styleId) * アクセント句の音高・音素長を変更する。 * * @param accentPhrases 変更元のアクセント句の配列。 - * @param styleId スタイルID。 + * @param styleId スタイルID。 * @return 変更後のアクセント句の配列。 + * @throws InferenceFailedException 推論に失敗した場合。 */ @Nonnull public List replaceMoraData(List accentPhrases, int styleId) @@ -159,8 +165,9 @@ public List replaceMoraData(List accentPhrases, int * アクセント句の音素長を変更する。 * * @param accentPhrases 変更元のアクセント句の配列。 - * @param styleId スタイルID。 + * @param styleId スタイルID。 * @return 変更後のアクセント句の配列。 + * @throws InferenceFailedException 推論に失敗した場合。 */ @Nonnull public List replacePhonemeLength(List accentPhrases, int styleId) @@ -178,8 +185,9 @@ public List replacePhonemeLength(List accentPhrases, * アクセント句の音高を変更する。 * * @param accentPhrases 変更元のアクセント句の配列。 - * @param styleId スタイルID。 + * @param styleId スタイルID。 * @return 変更後のアクセント句の配列。 + * @throws InferenceFailedException 推論に失敗した場合。 */ @Nonnull public List replaceMoraPitch(List accentPhrases, int styleId) @@ -197,7 +205,7 @@ public List replaceMoraPitch(List accentPhrases, int * {@link AudioQuery} から音声合成するためのオブジェクトを生成する。 * * @param audioQuery {@link AudioQuery}。 - * @param styleId スタイルID。 + * @param styleId スタイルID。 * @return {@link SynthesisConfigurator}。 * @see SynthesisConfigurator#execute */ @@ -209,7 +217,7 @@ public SynthesisConfigurator synthesis(AudioQuery audioQuery, int styleId) { /** * AquesTalk風記法をもとに音声合成を実行するためのオブジェクトを生成する。 * - * @param kana AquesTalk風記法。 + * @param kana AquesTalk風記法。 * @param styleId スタイルID。 * @return {@link TtsFromKanaConfigurator}。 * @see TtsFromKanaConfigurator#execute @@ -222,7 +230,7 @@ public TtsFromKanaConfigurator ttsFromKana(String kana, int styleId) { /** * 日本語のテキストをもとに音声合成を実行するためのオブジェクトを生成する。 * - * @param text 日本語のテキスト。 + * @param text 日本語のテキスト。 * @param styleId スタイルID。 * @return {@link TtsConfigurator}。 * @see TtsConfigurator#execute @@ -382,6 +390,8 @@ public SynthesisConfigurator interrogativeUpspeak(boolean interrogativeUpspeak) * {@link AudioQuery} から音声合成する。 * * @return 音声データ。 + * + * @throws InferenceFailedException 推論に失敗した場合。 */ @Nonnull public byte[] execute() throws InferenceFailedException { @@ -426,6 +436,8 @@ public TtsFromKanaConfigurator interrogativeUpspeak(boolean interrogativeUpspeak * {@link AudioQuery} から音声合成する。 * * @return 音声データ。 + * + * @throws InferenceFailedException 推論に失敗した場合。 */ @Nonnull public byte[] execute() throws InferenceFailedException { @@ -468,6 +480,8 @@ public TtsConfigurator interrogativeUpspeak(boolean interrogativeUpspeak) { * {@link AudioQuery} から音声合成する。 * * @return 音声データ。 + * + * @throws InferenceFailedException 推論に失敗した場合。 */ @Nonnull public byte[] execute() throws InferenceFailedException { diff --git a/crates/voicevox_core_java_api/lib/src/main/java/jp/hiroshiba/voicevoxcore/UserDict.java b/crates/voicevox_core_java_api/lib/src/main/java/jp/hiroshiba/voicevoxcore/UserDict.java index de1e612be..21f6843dd 100644 --- a/crates/voicevox_core_java_api/lib/src/main/java/jp/hiroshiba/voicevoxcore/UserDict.java +++ b/crates/voicevox_core_java_api/lib/src/main/java/jp/hiroshiba/voicevoxcore/UserDict.java @@ -74,6 +74,7 @@ public void importDict(UserDict dict) { * ユーザー辞書を読み込む。 * * @param path ユーザー辞書のパス。 + * @throws LoadUserDictException ユーザー辞書を読み込めなかった場合。 */ public void load(String path) throws LoadUserDictException { rsLoad(path); @@ -83,6 +84,7 @@ public void load(String path) throws LoadUserDictException { * ユーザー辞書を保存する。 * * @param path ユーザー辞書のパス。 + * @throws SaveUserDictException ユーザー辞書を保存できなかった場合。 */ public void save(String path) throws SaveUserDictException { rsSave(path);