Python コードで関数を文書化しようとしていて、\return
コマンドを含めたいと考えています。次のように言いましょう。
## \file
# File description
## Function to show you the problem.
#
# \return boolean True
def retTrue():
return True
これで doxygen を実行すると、対応するファイルにエントリが作成されますが"Function to show you the problem."
、関数の横にテキストが配置されるだけです。関数自体はリンクされておらず、\return
コマンドは使用されていません。
私が設定EXTRACT_ALL = YES
した場合は機能します (関数名がリンクされ、戻りテキストを示す説明ブロックが作成されることを意味します) が、プロジェクトのすべてのファイルをリストすることなく、これを行うためのよりエレガントな方法があると確信しています。
クラスメソッドを試し\return
てみましたが、すぐに機能するので、どちらを設定するのが正しいオプションなのかわかりません。他のEXTRACT_
オプションは私にはうまくいきませんでした。
どなたか魔法の設定を教えていただけるとありがたいです。