使用python的Doxygen沒有提取文件的方法描述

Question

我記錄了一個使用doxygen的python項目。我創建了我的配置文件，並設置了輸入和輸出目錄，但這是我真正做到的。當我生成文檔時，它會提取類和類的層次結構，但是對於具有不具有函數的模塊。

因爲，我有一個.py文件，它有一個主要的一組函數，我已經在正確的註釋語法中記錄了這些函數，但是這些函數在文檔中沒有任何表示。爲什麼是這樣？

Answer 1

對於默認的doxygen配置，只有記錄它們所在的文件或模塊時，纔會記錄模塊級功能。例如：

## 
# My function 
# 
def func(): 
    pass 

不會被記錄，除非該文件記載：

## 
# @file 
# File documentation 
# 

或模塊進行了說明：

## 
# @package MyModule Module documentation 
# 

有關在Doxygen的記錄Python代碼的更多信息，見http://www.stack.nl/~dimitri/doxygen/docblocks.html#pythonblocks。