DoxygenでPythonプロジェクトをドキュメント化しましたが、パラメータがうまくリスト表示されません。

下記リンクを参考に以下のようなドキュメンテーションコメントを入れてDoxygenでHTMLファイルを出力しました。

https://qiita.com/tomopiro/items/407e3bf5c08342cd4867

python
1 # -*- coding: utf-8 -*-
2"""
3@file ファイル名
4@version バージョン番号
5@author 作成者・更新者
6@date パッケージの作成日時・更新日時
7@brief 簡単な説明
8@details 詳細な説明
9@warning 警告メッセージ
10@note メモ
11"""
12
13"""
14@package パッケージの名前
15@version バージョン番号
16@author 作成者・更新者
17@date パッケージの作成日時・更新日時
18@brief 簡単な説明
19@details 詳細な説明
20@warning 警告メッセージ
21@note メモ
22"""
23
24class Hoge(object):
25    """
26    @class クラス名
27    @brief クラスの簡単な説明
28    @details クラスの詳細な説明
29    @warning 警告メッセージ
30    @note メモ
31    """
32
33    def __init__(self,arg):
34        """
35        @fn __init__()
36        @brief Hogeクラスの初期化関数
37        @param arg argの説明
38        @return None 戻り値なし
39        @details 関数の詳細
40        @warning 警告メッセージ
41        @note メモ
42        """
43        self.arg = arg
44
45    def fuga(self,a:float,b:float) -> tuple:
46        """
47        @fn fuga()
48        @brief
49        @param a オペランド（float）
50        @param b オペランド（float)
51        @retval sum_ab aとbの和（float）
52        @retval sub_ab aとbの差（float）
53        @details 詳細な説明
54        @warning 警告メッセージ
55        @note メモ
56        """
57        sum_ab = a+b
58        sub_ab = a-b
59        return sum_ab,sub_ab

しかしながら、以下のように、きれいにリスト表示されず、ドキュメンテーションコメントがそのまま出力されてしまいます。

出力例

本当はこのようにきれいに出力させたいのですが、どのようにすればよろしいでしょうか。

#" 理想の出力

行動規範の内容に同意します

回答1件

ベストアンサー

参考にされているサイトが間違ってますね。
公式のドキュメントでは、Pythonのドキュメント文字列では「doxygenの特殊コマンドはどれもサポートされていない」とハッキリ書いてあります。

Note that in this case none of doxygen's special commands are supported.

Comment blocks in Python
(日本語訳)

doxygenスタイルならいいそうです。

python
1    ##
2    # @fn fuga()
3    # @brief
4    # @param a オペランド（float）
5    # @param b オペランド（float)
6    # @retval sum_ab aとbの和（float）
7    # @retval sub_ab aとbの差（float）
8    # @details 詳細な説明
9    # @warning 警告メッセージ
10    # @note メモ
11    def fuga(self,a:float,b:float) -> tuple:
12        pass