2011-10-07 74 views
3

我正在開發自動化領域的C++項目我想開始記錄。我很喜歡Doxygen。但是,除了記錄數據和繪圖類層次結構的UML圖的特定領域,我想記錄的幾種方法用框圖的功能像這樣的: enter image description here用Doxygen繪製控制理論框圖

有什麼解決方法?

我熟悉LaTeX。我讀過Doxygen對LaTeX有一些支持,但我不知道這有多遠。是否可以在Doxygen中使用任何LaTeX軟件包?你會推薦哪些特定的軟件包,你能否提供一些簡單的例子?

我也對Doxygen不同的建議持開放態度。

+1

如果你想在LaTeX中做到這一點,你可以像TikZ上面的那樣做圖表。如果這是您的興趣,請將標誌遷移到http://tex.stackexchange.com或搜索相似的問題。 –

+0

我認爲Doxygen的LaTeX支持更多的是進入數學公式,也許GraphViz在這裏更適合(免責聲明:我不使用Doxygen,也不熟悉它)。 – kennytm

+0

這看起來很有趣。我製作了一個可視化表示生成代碼的工具。 http://memention.com/designer/我很想聽聽你的想法。 – epatel

回答

1

如果僅僅是獲取控制系統結構,變量等文檔,您可以在其他地方生成圖表(例如,如果您想使用開源工具,可以使用Dia,XFig或Inkscape),並將它們嵌入您的Doxygen文檔中從代碼中的圖像關鍵詞:

/*! 
.. Doxygen doc here.. 
\image html Data_Model.png "Figure 1: UML Diagram of the Data Source and Data Model Relationships" 
*/ 

要做到這一點,你需要告訴Doxygen的在的Doxyfile文件在哪裏可以找到的圖像,並且圖像相對的地方,你的doxygen的路徑(DOCROOT /圖像這種情況):

# The IMAGE_PATH tag can be used to specify one or more files or 
# directories that contain image that are included in the documentation (see 
# the \image command). 

IMAGE_PATH    = images 

使用乳膠擴展或其他語言驅動的圖形標記來從Doxygen doc中生成圖形不會證明學習語言的開銷,使工具鏈配置和對齊。另一方面,如果你已經有一些自動生成圖形的工具(從你的代碼或配置文件中),那麼從Makefile中運行該工具應該是一件輕而易舉的事,讓它生成圖像並將圖像嵌入你的doxygen文檔通過圖像關鍵字。