Skip to content

docs: Java APIの封を解く #1095

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
qryxip wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Java APIの封を解く #1095

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions docs/ghpages/apis/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,7 @@
<li><a href="./rust_api/voicevox_core">Rust API</a></li>
Copy link
Member

@Hiroshiba Hiroshiba Jun 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

（この行に関係ないコメントです）

「0.16.0はAndroid限定で既に出ていることにして」というのはvoicevox_pjから「0.16.0リリースの際にJava APIも出てました！」という声明を出すみたいなイメージではなく、0.16.1を出すときに破壊的変更は控える、という意味でした。

なーるほどです！
であれば、0.16.1を出すときに破壊的変更は控えるは同意です！

Copy link
Member

@Hiroshiba Hiroshiba Jun 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

（この行に関係ないコメントです）

0.16.0のリリース内容にjava_package.zipがあります。
またドキュメントにおいても以下の箇所に言及が残っている状態ではあります。readmeとかにはありませんが。

すいません！　ここの2つのコメントってどういう意図でしょうか？
この3つのどれかかなと思ってます：

  1. 「現状どういう案内があるのか調べてみたので、せっかくなのでコメントして残しておきます」
  2. 「Javaは0.16.0の時点ですでにドキュメントを書いているということにしましょう」
  3. 「ヒホは0.16.1でJava APIの破壊的変更をしても良いと考えているのかもしれず、それは阻止したい」＋2.の内容

２だったら「さすがにドキュメントを書いてるとは言えなそう」、３だったら「0.16.1で破壊的変更をするのは避ける方針で良いと思います！」という感じです。

Copy link
Member Author

@qryxip qryxip Jun 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2.寄りの1.ですね。Java APIの存在は特に秘匿されておらず、実験的機能ですとも明言されていない状態に感じたので。かなり微妙な感じですが。

Java APIを「正式」に出すのであればドキュメントは書く必要があるというのは異論は無いです。

Copy link
Member

@Hiroshiba Hiroshiba Jun 4, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

なるほどです！
ちょっとエスパーすると、一番気にされているのは多分、「0.16.1のJava APIで0.16.0からの破壊的変更をしないようにしよう」ということですよね。
この点は個人的には賛成です！

他の細かいところはこんな感じかなと思います（ユーザー目線で考えると認識揃いやすいと思ってます）：

  • 0.16.0の時点でJavaのドキュメントはない
    • 書かれてるかではなく、存在がわかるようになっているかどうか

Copy link
Member

@Hiroshiba Hiroshiba Jun 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

（この行に関係ないコメントです）

ということで、「実験的機能」にするかどうかは、自信がちょっとあるかないかだと思います！
自信がないなら実験的機能、自信がちょっとあるなら一思いに正式リリースにしましょう！！

まず私の認識としては、今のJava APIには目立った課題は残っていないはずです。

特に課題は無さそうだけどPython APIやRust APIレベルの「質」になっているか確認できるまで実験的機能のラベルを付けておきましょう、というのを特にマイルストーンを打ち立てるといったこともせずに行うというなら反対であるくらいの気持ちです。

なるほどです！
となると、どういう条件で実験的機能のラベルを外すのか考えてから、実験的機能扱いにするのが良さそうでしょうか？

この辺決めるためのissueを作るのどうでしょう。
まあ言うてあと2つのやり取りぐらいで決まりそうなので、決まってからJava APIまとめissueに転記するとかでも良いと思います！

<li><a href="./c_api/voicevox__core_8h.html">C API</a></li>
<li><a href="./python_api/autoapi/voicevox_core/index.html">Python API</a></li>
<!--
TODO: Java APIが正式版になったらコメントアウトをやめる
<li><a href="./java_api">Java API</a></li>
-->
<li><a href="./java_api">Java API</a></li>
</ul>
</body>
</html>