2013-11-25 46 views
1

即使使用描述(不是真正的文檔化),我也可以將自定義頁面添加到doxygen文檔中。不過,我有這樣的位置:如何添加已棄用列表的說明?

/*! 
* \page fielname Here comes the title 
* \brief A short introduction which explains this page. 
* 
* The real page content... 
*/ 

這工作正常,但我怎麼加\brief(介紹)已過時的名單?現在,這看起來是一個我想要避免的無記錄​​的頁面。

+0

可我只是確認您想從'\ deprecated'添加標籤的介紹頁面通過Doxygen的_automatically GENERATED_? – Cheeseminer

+0

@Cheeseminer也會很酷,但是我不希望在生成的「pages.html」中添加一個描述,例如, *棄用清單*和所有其他清單,如待辦清單和其他'\ xrefitem'清單。 – rekire

回答

1

我想你在找什麼可以實現如下:

/** Test class 
* @deprecated Will be removed in release 2.0 
*/ 
class Test 
{ 
}; 

/** @page deprecated 
* @brief Deprecated page brief 
* 
* Deprecated page contents. 
*/ 
+0

非常感謝你!一些小問題我應該在哪裏報告一個錯誤?我有一個泛型類,它包含一個嵌套的靜態類,即使泛型沒有使用doxygen進行文檔化。 – rekire

+0

doxygen網站有一個鏈接到它用於bug報告的bugzilla數據庫。請參閱http://www.stack.nl/~dimitri/doxygen/manual/trouble.html#bug_reports – Cheeseminer