Skip to content
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.

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

APIドキュメントにjsonフォーマットに関する説明が必要 #278

Open
qwerty2501 opened this issue Sep 14, 2022 · 0 comments

Comments

@qwerty2501
Copy link
Contributor

内容

AudioQuery,Metas,SupportedDevicesはjsonで返されるが、wrapperを提供する際にはこれらのjsonを元に言語ごとのclassやstructに割り当てられるのが望ましい。
しかしAPIドキュメントにこれらのjsonに関する説明がないためjsonフォーマットに関する説明が必要であると思われる。

Pros 良くなる点

wrapperが作りやすくなる

Cons 悪くなる点

なし

実現方法

ドキュメントコメント内にjsonのフォーマットの説明やwrapperの実装例を記載する

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants