如何告訴doxygen使用/ **作爲class doc而不是/ *！ \類

我試圖從phpDocumentor的切換到Doxygen的，但我所有的類都在下面的樣式記載：如何告訴doxygen使用/ **作爲class doc而不是/ *！類

/** 
* DESCRIPTION 
* 
* @category PHP 
* @package UserManagement.Class 
* @author Name <[email protected]> 
* @copyright 2011 Company 
* @link  http://www.company.com 
*/

但doxygen的不承認，作爲類的文檔，除非我改變的第一行

/*! \class CLASSNAME

有沒有辦法告訴doxygen使用「/ **」風格？

關於

來源

2011-06-06 ChrFin

排序偏離主題;但如果您對PHPDocumentor感到厭煩 - 就像我一樣 - 您可能需要考慮查看[DocBlox]（http://www.docblox-project.org）。 – 2011-06-06 14:07:12

我發現這個問題（但不是真正的解決方案）：Doxygen的不喜歡在類文檔塊@Category & @package。如果我刪除它，它的作品。

來源

2011-06-08 17:36:07 ChrFin

如果你在PHP 5.3你應該能夠使用命名空間來提供這個功能（有點黑客，但可能會提供你需要的功能）當然，根據具體情況，這可能/不可能與你有什麼相關 – JoshB 2011-06-27 16:56:26

實際上，如果存在'@ category'和/或'@ package'，則類的詳細描述可以在生成文檔的_Namespaces_部分找到。 – 2014-07-03 06:54:30

Doxygen應該識別JavaDoc（即/ **）註釋。問題可能是您的簡短說明未被自動檢測到。

爲了使Doxygen使用這些簡短的描述，你需要在你的配置文件中設置JAVADOC_AUTOBRIEF到YES。

更多關於Doxygen文檔樣式怎麼也得看看at this

來源

2011-06-06 15:30:22 JoshB

JAVADOC_AUTOBRIEF已啓用，它確實可以識別它們的功能，但不能識別類。所以文檔的「詳細描述」是空的。 – ChrFin 2011-06-06 15:55:35

@chrfin它是什麼顯示然後爲類？ – JoshB 2011-06-06 16:28:21

什麼都沒有：詳細描述定義在第21行的文件... – ChrFin 2011-06-06 18:18:39

例如，如果你的同事仍然使用PHPDoc的，你可以使用INPUT_FILTER配置來過濾不必要的標籤遠：

$ grep INPUT_FILTER doc/doxygen.config 
INPUT_FILTER  = /home/gorgo/someproj/doc/doxygen.inputfilter

的輸入過濾腳本必須是可執行的，其內容可以是這樣的：

$ cat doc/doxygen.inputfilter 
#!/bin/sh 

grep -Fv '@package' $1 | grep -Fv '@category'

來源

2013-07-26 08:57:24

如何告訴doxygen使用/ **作爲class doc而不是/ *！ \類

回答

相關問題