APIドキュメントが欲しい

[sevenc-nanashi]

内容

簡易的なAPIドキュメントが欲しいです。
引数の説明や実行結果のサンプルなどが書いてあると嬉しい。

Pros 良くなる点

ラッパーライブラリを作りやすくなる

Cons 悪くなる点

ドキュメントを整備する必要が出てくる

実現方法

core.hにコメントで書いたり、docsフォルダにmdで書いたり？

OSの種類/ディストリ/バージョン

（なし）

その他

（なし）

[Hiroshiba]

Rustってなにかかっこいいドキュメント生成ツールみたいなのってあるんでしょうか？👀
（PythonのSphinxみたいな）

[qryxip]

Rustのでよければrustdocですかね?
https://docs.rs/pyo3

[qryxip]

[qwerty2501]

現在C API定義の改善を予定しており、ドキュメント化するのであればその後にしたほうが良さそうというのはあります。
#217

cbindgenがコメント出力できるようですが、そのときにスタイル指定できるようでDoxyとあるようです。恐らくDoxygen?
rustdoc形式で書いておけばDoxygen形式で出してくれる可能性はありそうです。
rustdoc形式だと型などがRust文脈のものなので外から見るとやや違和感があるのでできればDoxygen形式で出せそうならDoxygen形式のほうが良いと思います。

[qryxip]

あーcbindgenがコメント出力できるんですね。普通に考えればコメント変換機能くらいあるか。

/**
 * TTSします。
 *
 * ```c
 * //なんかCの例
 * ```
 */
#ifdef _WIN32
__declspec(dllimport)
#endif

VoicevoxResultCode voicevox_tts(const char *text,
                                int64_t speaker_id,
                                int *output_binary_size,
                                uint8_t **output_wav);

[qwerty2501]

お、できそうですねぇ

[qwerty2501]

とりあえずAPIドキュメントは生成できるようになりました

まだ説明不足だったり、Doxygenの表示がイマイチだったりしますが