2014-09-04 32 views
1

我對doxygen比較陌生,喜歡Javadocs(當我在寫更多的Java時)和普通的文字處理工具(當時我在爲IBM工作時)。如何將多個備註分組到一個段落中?

我的評論風格是在整個代碼庫中包含大量貫穿敘述的敘述,以便代碼的目的非常明確。我寧願重新處理該文本,以便可以將其用於我正在生成的API的外部文檔。

當我使用\ remark標籤時,每次\ remark都會在HTML輸出中作爲單獨的段落結束。這看起來並不像我希望的樣子。我不想有一個可能涵蓋6或8個代碼塊的巨人\評論。

我的問題是這樣的 - 我如何告訴doxygen將多個\備註部分「合併」爲一個段落,僅在需要時纔開始新段落?

+0

我知道這是舊的,但我遇到了相同類型的問題,嘗試在\ test命令中使用\ copydoc,但使用\ copydoc會自動啓動一個新段落(很像\ remark) parblock – 2015-11-13 17:48:08

回答

0

我不知道如果我完全理解這個問題,但如果問題是:「如何使用單一句話標籤內超過100款,你可以使用parblockendparblock命令:

/** 
* \file utils.h 
* \brief TODO complete the documentation of utils.h 
* 
* \remark Lorem ipsum dolor sit amet, ex everti iracundia laboramus vel, in tota sensibus posidonium eam. His ei expetenda splendide, has eu iusto delicatissimi. Mei dolor deseruisse et. Viris graeco necessitatibus an est, quod reque vulputate sea cu, an has simul nihil numquam. Modo animal assentior pri ut, te mea duis prima, esse sonet ut vim. Duo in duis legere molestie. 
* 
* Ea mel prima atomorum liberavisse, ei odio voluptua dissentiet vix. Vix an ornatus suscipit perfecto. Ut propriae omnesque cum, usu ferri commune tacimates te, erant definitionem vim id. Vix cu copiosae imperdiet. Vis fierent nominati patrioque et, eam menandri vituperatoribus ei, ea has veritus volutpat neglegentur. Ius cu posse novum utroque. 
* 
* Ad per nobis periculis, legere cetero duo ut. In vis nihil admodum suscipit, per alia consequat expetendis ad, ex erant vocibus adversarium mel. Vix ut modus gloriatur, falli vitae eu eam, te per dicat persius. Vis nostrud maiorum et, sea ut etiam perfecto. Cum ut quod legimus convenire, iriure fabellas gloriatur qui ex. 
* 
* \remark 
* 
* \remark \parblock 
* 
* Lorem ipsum dolor sit amet, ex everti iracundia laboramus vel, in tota sensibus posidonium eam. His ei expetenda splendide, has eu iusto delicatissimi. Mei dolor deseruisse et. Viris graeco necessitatibus an est, quod reque vulputate sea cu, an has simul nihil numquam. Modo animal assentior pri ut, te mea duis prima, esse sonet ut vim. Duo in duis legere molestie. 
* 
* Ea mel prima atomorum liberavisse, ei odio voluptua dissentiet vix. Vix an ornatus suscipit perfecto. Ut propriae omnesque cum, usu ferri commune tacimates te, erant definitionem vim id. Vix cu copiosae imperdiet. Vis fierent nominati patrioque et, eam menandri vituperatoribus ei, ea has veritus volutpat neglegentur. Ius cu posse novum utroque. 
* 
* Ad per nobis periculis, legere cetero duo ut. In vis nihil admodum suscipit, per alia consequat expetendis ad, ex erant vocibus adversarium mel. Vix ut modus gloriatur, falli vitae eu eam, te per dicat persius. Vis nostrud maiorum et, sea ut etiam perfecto. Cum ut quod legimus convenire, iriure fabellas gloriatur qui ex. 
* 
* \endparblock 
* 
* \remark 
* third remark 
*/ 

下面是HTML輸出:。output with and without parblock 您可以隨時通過以下鏈接parblock doxygen documentation檢查parblock文檔 如果你仍不滿意,HTML輸出,我建議你添加自定義CSS文件指定備註規則。您可以通過HTML_EXTRA_STYLESHEET添加額外的CSS文件:有一個名爲「section remark」的CSS類應該允許您自定義外觀;更多關於這個的信息here。我希望我幫助你。

+0

我在找相反的東西 - 將多個非連續的\ remark標籤合併到一個段落中。我要看\ parblock,看看它是否會做我想要的。 – 2014-09-06 18:49:56

+0

沒有。簡短的回答似乎是,沒有辦法創建文本轉換,它將從多個註釋塊中收集文本,然後將其作爲單個段落髮布。 – 2014-09-06 19:00:26

相關問題