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

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

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

來源

2011-09-02 Colton Phillips

＃如果EXTRACT_ALL標記設置爲YES，則doxygen將假定＃文檔中的所有實體記錄在案，即使沒有可用的文檔。＃私有類成員和靜態文件的成員，除非＃隱藏的EXTRACT_PRIVATE和EXTRACT_STATIC代碼設置爲YES EXTRACT_ALL = YES ＃如果EXTRACT_PRIVATE標籤設置爲YES類的所有私有成員＃會包括在文檔中。 EXTRACT_PRIVATE = YES –

將「否」更改爲yes。問題解決了......不知道如何解決這個問題。 –

科爾頓，發佈您的解決方案作爲答案，然後接受它。 – smci

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

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

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

## 
# @file 
# File documentation 
#

或模塊進行了說明：

## 
# @package MyModule Module documentation 
#

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

來源

2011-12-28 18:49:34 DRH

另請注意，由於Doxygen在這些註釋中不支持特殊命令，因此不能使用Pythons'「」「來記錄文件/模塊。 –

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

回答

相關問題