2014-04-14 44 views
1

我正在嘗試使用Doxygen獲得以下功能。Doxygen的自定義/分佈式文檔更改

這是可能的,以及如何最好地做到這一點?

我們正在使用EDA工具附帶的現有Tcl代碼庫,其中很多代碼是「源代碼」,不一定按程序組織。我們已經對這個代碼庫進行了許多改進/修改。自定義示例的形式爲「允許使用新配置變量Y控制功能X」,並涉及對fileA,fileB和fileC進行的修改。

我有Doxygen解析整個代碼庫。除了標準語言文檔之外,我還希望提取我們所做的所有定製的列表,包括修改了哪些文件(和大概行號),每個文件中進行了哪些更改,從每個文件中捕獲修改後的代碼以及指向文件列表和行號進行了修改。

我預計這將需要的fileA,FILEB和fileC定製Doxygen的意見/標籤,我設法得到最接近的是通過將以下在那裏的東西在的fileA FILEB和fileC修改的每個位置:

## 
# \page custom_mypage1 Customization enabling control of X with variable Y 
# 
# This is a test comment 1 
# 

這允許用於收集從三個位置的意見,但我不能弄清楚如何:

  1. 包括隨後的源代碼的一部分,並且
  2. 如何有將所生成的documen塔季翁包括引用文件的註釋從

回答

0

使用的xrefitem代替page將提供摘要頁面和源極之間的聯繫來的地方/行號。

要在頁面中包含代碼片段,snippet可能會有所幫助。

例子:

/** 
\xrefitem customization1 "Change for 1" "Changes for customization1" 
Description of change. 
\snippet CurrentSourceFile.cpp change1 
*/ 
//! [change1] 
Modified code here... 
//! [change1] 
+0

埃裏克,這看起來非常有前途。如果沒有\ page參考,Doxygen會在哪裏放置用\ xrefitem標記的評論內容? –

+0

Doxygen爲每個不同的xrefitem「標籤」(在我的示例中爲「customization1」)創建一個頁面 –

+0

我似乎無法讓DoxyGen生成與\ xrefitem甚至\ todo相關的任何內容。它使用這些指令解析文件,並從中提取其他提取的信息。我已經全部配置的以下設置的: GENERATE_TODOLIST = YES GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES GENERATE_DEPRECATEDLIST = YES –