2013-07-01 64 views
1

衆所周知如何獲得Doxygen的待辦事項列表的已完成列表中,鍵入:獲取與doxygen的

\todo Item one 
\todo Item two 

等等,但是當事情已經做了,如何跟蹤的呢?

如果我做項目出現兩次我不想刪除它,我想將其標記爲已完成:

\todo Item ono 
\done Item two 

我該怎麼辦呢?

回答

0

根據the Doxygen manual\todo命令沒有這種「反轉」。也許你可以保留\todo並以某種方式手動標記爲完成。

不幸的是,Doxygen的Markdown似乎並不支持刪除線(顯然不同於Stack Overflow的),否則這將是一個不錯的選擇。也許你可以使用自定義樣式和跨度進行設置。

3

我在Doxygen文檔中挖了一遍,並且偶然發現了\xrefitem。它應該是:

命令的一般化,如\ todo和\ bug。它可用於 創建用戶定義的文本部分,這些部分自動在發生位置和相關頁面之間交叉引用 ,將生成該文本部分。在相關頁面上,將收集相同 類型的所有部分。

第一個參數是唯一代表該部分的 類型的標識符。第二個參數是一個帶引號的字符串 ,表示文本作爲 第四個參數傳入的部分的標題。第三個參數(列表標題)用作包含具有相同關鍵字的所有項目的相關頁面的 標題。鍵是「todo」,「test」,「bug」和「deprecated」是預定義的。

因此,您可以指定一個新的別名,例如, "done"在你的Doxyfile:

ALIASES + = 「DONE = \ xrefitem做\」 實施TODOS \ 「\ 」實施 TODOS \「」

而在你的代碼,你應該能夠使用新"done"標籤的所有其他人一樣:

/// \做固定破碎功能

+0

謝謝了很多,太棒了 – Roberto