我正在使用Doxygen和Markdown編寫技術手冊。降低生成HTML的簡單性,以及Doxygen,因爲多年使用代碼的經驗以及知道如何使用\ingroup
工具生成良好的交叉文檔。如何使用Markdown頁面和Doxygen組?
我無法讓後者在Doxygen處理Markdown時正常工作。
我想實現的是寫一個完全描述性的培訓文檔,但要能夠標記重要的部分,並讓Doxygen將這些部分拉出到單獨的「提示」頁面中(例如)以便稍後快速參考。
這些片段說明了這個問題。所有的文件是.md
,我有一個單獨的mainpage.md工作正常。相關的MARKDOWN選項在doxyfile中設置爲YES。使用/ ** * /在.h
文件中定義組,這是因爲我無法在.md文件中可靠地運行(這可能與此問題有關)。
A '組1' 文本的塊
@ingroup group_01
# Group 01 MD heading
Text 1 for Group 1. Mirum est notare quam littera gothica.
,一個用於組2文本
@ingroup group_02
# Group 02 MD Heading
Text 1 for group 2. Lorem banana dolor sit amet elit.
,並用信息在組1和其它部件在組文件欲2
@ingroup group_01
@{
# Text 2 group 1
Text 2 for group 1. Duis autem vel eum iriure dolor.
@}
@ingroup group_02
@{
# T2G2 THIS NEVER APPEARS
Text 2 for group 2. Nibble liber tempor cum soluta nobis.
@}
我期待的是'模塊'部分包含兩個組(它所做的)兩個條目,而且gr oup 1/2頁面包含由@ingroup標記的文本。
我得到的是第一次看到@ingroup
正在處理完全按照我想到,Doxygen的正確整理到一個頁面中的各個組條目。該文本之外的文本根本不出現在輸出中。如果我交換最後一個文件中文本塊的順序,則會顯示另一個塊,並且之前可見的塊會消失。
如果我不使用@{ @}
支撐,並且只有和@ingroup_02
,我會得到類似的輸出故障。 FWIW,@ingroup (group_01 group_02)
似乎根本不適用於Markdown文件。
我在做什麼錯?
有沒有人有其他建議如何實現我的目標?
我正在使用最新發布的Doxygen 1.8.5。 Doxygen手冊說這沒什麼用處。
這個問題與this有一些相似之處,但這是從代碼的角度來看待問題。