c - doxygen で完了リストを取得する

Question

次のように入力して、Doxygen で TODO リストを取得する方法はよく知られています。

\todo Item one
\todo Item two

などですが、何かが行われたとき、これをどのように追跡するのでしょうか?

項目 2 を実行した場合、それを削除したくないので、完了としてマークしたいと思います。

\todo Item ono
\done Item two

どうすればいいですか？

Answer 1

私はDoxygenのドキュメントを掘り下げて、\xrefitem. それはあるはずです：

\todo や \bug などのコマンドの一般化。発生場所と生成される関連ページとの間で自動的に相互参照されるユーザー定義のテキスト セクションを作成するために使用できます。関連ページでは、同じタイプのすべてのセクションが収集されます。

最初の引数は、セクションのタイプを一意に表す識別子です。2 番目の引数は、4 番目の引数として渡されたテキストが置かれるセクションの見出しを表す引用符で囲まれた文字列です。3 番目の引数 (リスト タイトル) は、同じキーを持つすべてのアイテムを含む関連ページのタイトルとして使用されます。キー「todo」、「test」、「bug」、および「deprecated」は事前定義されています。

"done"したがって、たとえばDoxyfile で新しいエイリアスを指定できます。

ALIASES += "done=\xrefitem done \"実装された TODOs\" \"実装された TODOs\""

"done"そして、あなたのコードでは、他のすべてのタグと同じように新しいタグを使用できるはずです:

/// \done 壊れた関数を修正

Answer 2

doxygen マニュアルによると、そのような\todoコマンドの「逆」はありません。\todoおそらく、どうにかして、手動で完了としてマークすることができます。

残念ながら、doxygen の Markdown は取り消し線をサポートしていないようです(明らかにスタック オーバーフローのものとは異なります)。おそらく、カスタム スタイルとスパンを使用して設定できます。