2010-11-18 77 views
3

我有一個簡單的問題文件:我怎麼記錄.ini文件?Doxygen的,如何記錄非標準擴展名(.INI)

我有一個C++項目具有以下佈局:

readme.txt 
src 
    main.cpp 
data 
    simple.ini 

我沒有問題,從readme.txt文件和main.cpp中生成文件,但在simple.ini文檔不會在HTML輸出顯示在所有。我已經修復了Doxygen文件以包含以下內容:

INPUT = . src data 
FILE_PATTERNS = *.cpp *.txt *.ini 

這沒有幫助。我也明確地指定了simple.ini:

INPUT = readme.txt data/simple.ini src 

但它也沒有工作。在simple.ini中,我使用';'評論:

; @file simple.ini 
; This file will do blah blah blah 
[section1] 
key1 = foo 
key2 = bar 
... 

我也嘗試使用'#'評論字符,但它也沒有工作,無論是。我如何使doxygen處理simple.ini?

回答

3

Doxygen的預計/**///用於啓動的doxygen感知註釋塊。我不知道,如果它的工作原理,但我會嘗試與評論:

; /// @file simple.ini 
; /// This file will do blah blah blah 
... 
+0

謝謝mouviciel,它的工作原理。然而,@code和@endcode塊之間的文本輸出是混亂的:它包含「;」因爲Doxygen沒有認出「;」作爲評論字符。現在,我使用具有相同名稱的.TXT文件來記錄我的.INI文件。 – 2010-11-23 17:12:31

0

我想說的Doxygen缺乏記錄

  • 構建腳本
  • 配置文件
  • 定製的功能在你自己的虛擬機中使用的腳本

所以最終的解決方案是叉Doxygen,並添加處理任意語言,如Notepad ++或Kate。在途中,您還應該清理它雜亂的2002式HTML輸出,因此它不再生成div湯。

0

要添加自定義文件擴展名Doxygen的,你必須在配置文件中編輯了兩兩件事:

  • FILE_PATTERNS包括擴展名通常*.extension \
  • EXTENSION_MAPPING是.extension=parser其中解析器是C,C#,C++,蟒等

在你的情況設爲「擴展名」作爲「的.ini」和‘解析器’作爲C. Doxygen的預計的兩行以下兩種/////!。它也接受多行/**/*!
OR
集「解析器」到「Python的使用##風格的註釋爲#被作爲的.ini註釋接受但不建議使用。這應該刪除您的需要; s

相關問題