強制doxygen模塊以小寫字母開頭

我正在使用doxygen記錄一個C項目，並將文件的集合分組到模塊中（其中每個模塊包含c風格類的所有文檔）。除了所有的模塊名都以大寫字母開頭，即使我用全部小寫名稱創建模塊組時，我所有的工作都可以正常工作。強制doxygen模塊以小寫字母開頭

例如，下面的doxygen的意見將我的文檔生成模塊「Foobar的」，即使我添加到組「foobar的」，並希望該模塊被稱爲「FOOBAR」：

/** 
    *@addtogroup foobar 
    *@{ 
    * (some documentation elements...) 
    *@} 
    */

雖然大寫並不會以任何嚴肅的方式影響文檔，我想修復它以保持一致性（並且因爲我不能讓自己放手）。谷歌已經幹了，有什麼建議？

來源

2013-06-19 theck01

嗯。我也找不到解決方案。你確定你沒有在其他地方引用Foobar，導致大寫字母在某種「預處理」過程中粘住嗎？而且，這是一個很長的，但我看到大寫的唯一參考是在http://svn.apache.org/repos/asf/subversion/trunk/doc/doxygen.conf中的「CASE_SENSE_NAMES」部分，但是這不應該'與doxygen修改_your_大寫有什麼關係。祝你好運解決此問題！ –

我敢肯定，我將「addtogroup」語句切換爲「defgroup」，以確保僅使用每個組名稱一次。我想我會多一點谷歌，如果沒有出現提交錯誤報告。 – theck01

我幾乎錯過了這個在Doxygen manual：

定義一組，你應該在一個特殊的註釋塊放在\ defgroup命令。該命令的第一個參數是一個應該唯一標識該組的標籤。第二個參數是組的名稱或標題，因爲它應該出現在文檔中。

所以，你應該能夠做到

@addtogroup foobar foobar

來源

2013-08-13 22:13:50

的answer by @E-rich提供了一個可行的解決方案。

但是，如果你在很多地方/文件使用

\addtogroup foobar

，這將是一個維護頭痛在所有這些地方使用

\addtogroup foobar foobar

。這將是更好的使用：

\defgroup foobar foobar

，然後離開使用

\addtogroup foobar

原樣。

使用我的建議，如果您覺得喜歡，可以很容易地將名稱更改爲更具描述性的名稱。

\defgroup foobar The Foo and Bar Module

來源

2017-02-03 19:56:29

強制doxygen模塊以小寫字母開頭

回答

相關問題