Add: ドキュメントを追加

VOICEVOX · Aug 3, 2023 · a4187c8 · a4187c8
1 parent f172d6b
commit a4187c8
Show file tree

Hide file tree

Showing 7 changed files with 165 additions and 9 deletions.
diff --git a/crates/voicevox_core_java_api/lib/src/main/java/jp/Hiroshiba/VoicevoxCore/AccentPhrase.java b/crates/voicevox_core_java_api/lib/src/main/java/jp/Hiroshiba/VoicevoxCore/AccentPhrase.java
@@ -10,24 +10,29 @@
 import com.google.gson.annotations.Expose;
 import com.google.gson.annotations.SerializedName;
 
+/** AccentPhrase (アクセント句ごとの情報)。 */
 public class AccentPhrase {
+  /** モーラの配列。 */
   @JsonProperty("moras")
   @SerializedName("moras")
   @Expose
   @Nonnull
   public List<Mora> moras;
 
+  /** アクセント箇所。 */
   @JsonProperty("accent")
   @SerializedName("accent")
   @Expose
   public int accent;
 
+  /** 後ろに無音を付けるかどうか。 */
   @JsonProperty("pause_mora")
   @SerializedName("pause_mora")
   @Expose
   @Nullable
   public Mora pauseMora;
 
+  /** 疑問系かどうか。 */
   @JsonProperty("is_interrogative")
   @SerializedName("is_interrogative")
   @Expose

diff --git a/crates/voicevox_core_java_api/lib/src/main/java/jp/Hiroshiba/VoicevoxCore/AudioQuery.java b/crates/voicevox_core_java_api/lib/src/main/java/jp/Hiroshiba/VoicevoxCore/AudioQuery.java
@@ -9,58 +9,73 @@
 import com.google.gson.annotations.Expose;
 import com.google.gson.annotations.SerializedName;
 
+/** AudioQuery (音声合成用のクエリ)。 */
 public class AudioQuery {
+  /** アクセント句の配列。 */
   @JsonProperty("accent_phrases")
   @SerializedName("accent_phrases")
   @Expose
   @Nonnull
   public List<AccentPhrase> accentPhrases;
 
+  /** 全体の話速。 */
   @JsonProperty("speed_scale")
   @SerializedName("speed_scale")
   @Expose
   public double speedScale;
 
+  /** 全体の音高。 */
   @JsonProperty("pitch_scale")
   @SerializedName("pitch_scale")
   @Expose
   public double pitchScale;
 
+  /** 全体の抑揚。 */
   @JsonProperty("intonation_scale")
   @SerializedName("intonation_scale")
   @Expose
   public double intonationScale;
 
+  /** 全体の音量。 */
   @JsonProperty("volume_scale")
   @SerializedName("volume_scale")
   @Expose
   public double volumeScale;
 
+  /** 音声の前の無音時間。 */
   @JsonProperty("pre_phoneme_length")
   @SerializedName("pre_phoneme_length")
   @Expose
   public double prePhonemeLength;
 
+  /** 音声の後の無音時間。 */
   @JsonProperty("post_phoneme_length")
   @SerializedName("post_phoneme_length")
   @Expose
   public double postPhonemeLength;
 
+  /** 音声データの出力サンプリングレート。 */
   @JsonProperty("output_sampling_rate")
   @SerializedName("output_sampling_rate")
   @Expose
   public int outputSamplingRate;
 
+  /** 音声データをステレオ出力するか否か。 */
   @JsonProperty("output_stereo")
   @SerializedName("output_stereo")
   @Expose
   public boolean outputStereo;
 
+  /**
+   * [読み取り専用] AquesTalk風記法。
+   *
+   * {@link Synthesizer#audioQuery} が返すもののみ ``str`` となる。入力としてのAudioQueryでは無視される。
+   */
   @JsonProperty("kana")
   @SerializedName("kana")
   @Expose
   @Nonnull
-  public String kana;
+  final public String kana;
 
   public AudioQuery() {
     this.accentPhrases = new ArrayList<>();

diff --git a/crates/voicevox_core_java_api/lib/src/main/java/jp/Hiroshiba/VoicevoxCore/Mora.java b/crates/voicevox_core_java_api/lib/src/main/java/jp/Hiroshiba/VoicevoxCore/Mora.java
@@ -7,46 +7,53 @@
 import com.google.gson.annotations.Expose;
 import com.google.gson.annotations.SerializedName;
 
+/** モーラ（子音＋母音）ごとの情報。 */
 public class Mora {
+  /** 文字。 */
   @JsonProperty("text")
   @SerializedName("text")
   @Expose
   @Nonnull
   @SuppressWarnings("NullableProblems")
   public String text;
 
+  /** 子音の音素。 */
   @JsonProperty("consonant")
   @SerializedName("consonant")
   @Expose
   @Nullable
   public String consonant;
 
+  /** 子音の音長。 */
   @JsonProperty("consonant_length")
   @SerializedName("consonant_length")
   @Expose
   public java.lang.Double consonantLength;
 
+  /** 母音の音素。 */
   @JsonProperty("vowel")
   @SerializedName("vowel")
   @Expose
   @Nonnull
   @SuppressWarnings("NullableProblems")
   public String vowel;
 
+  /** 母音の音長。 */
   @JsonProperty("vowel_length")
   @SerializedName("vowel_length")
   @Expose
   public double vowelLength;
 
+  /** 音高。 */
   @JsonProperty("pitch")
   @SerializedName("pitch")
   @Expose
   public double pitch;
 
   public Mora() {
     this.text = "";
-    this.consonant = "";
-    this.consonantLength = 0.0;
+    this.consonant = null;
+    this.consonantLength = null;
     this.vowel = "";
     this.vowelLength = 0.0;
     this.pitch = 0.0;

diff --git a/crates/voicevox_core_java_api/lib/src/main/java/jp/Hiroshiba/VoicevoxCore/OpenJtalk.java b/crates/voicevox_core_java_api/lib/src/main/java/jp/Hiroshiba/VoicevoxCore/OpenJtalk.java
@@ -1,20 +1,30 @@
 package jp.Hiroshiba.VoicevoxCore;
 
+/** テキスト解析器としてのOpen JTalk。 */
 public class OpenJtalk implements AutoCloseable {
   protected long internal;
 
-  public OpenJtalk() {
-    rsNewWithoutDic();
-  }
-
+  /**
+   * Open JTalkの辞書ディレクトリ。
+   *
+   * @param openJtalkDictDir 辞書のディレクトリ。
+   */
   public OpenJtalk(String openJtalkDictDir) {
     rsNewWithInitialize(openJtalkDictDir);
   }
 
+  /**
+   * ユーザー辞書を設定する。
+   *
+   * この関数を呼び出した後にユーザー辞書を変更した場合は、再度この関数を呼ぶ必要がある。
+   *
+   * @param userDict ユーザー辞書。
+   */
   public void useUserDict(UserDict userDict) {
     rsUseUserDict(userDict);
   }
 
+  /** Open JTalkを廃棄する。 */
   public void close() {
     rsDrop();
   }