search

qulacs / qulacs-rtd

Qulacs documentation for readthedocs. Configured to support automatically generate C++/Python API, and internationalization.
MIT License
3 stars 3 forks source link

Fix OUTPUT_LANGUAGE in Doxygen config #88

Closed Hiroya-W closed 1 year ago

Hiroya-W commented 1 year ago

https://github.com/qulacs/qulacs-rtd/blob/0e03d9ac1361938ab6645d976cb483a20f1ae894/ja/source/conf.py#L57-L72

OUTPUT_LANGUAGEが重複して設定されており、日本語ドキュメント向けのJapanese-enの設定がEnglishで上書きされ無視されているために、日本語向けドキュメントが生成されない問題がある。 このOUTPUT_LANGUAGEと\~[langid]の記述を利用して、日本語向けと英語向けのAPIドキュメントで表示内容を切り替えられるので、修正が必要。

/**
 * @brief \~english A class doing something
 *        \~japanese-en 何かするクラス
 *
 * @details \~english English details
 *          \~japanese-en 日本語の詳細
 */