2015-09-21 44 views
0

我正在使用ant-doxygen爲java項目創建文檔,效果很好。不幸的是,ant任務不會迴應doxygen的警告,雖然它們在doxygen配置文件中啓用。在doxygen ant任務中顯示警告

我想獲得警告,以防某些類/方法沒有任何文檔註釋。

作爲一個例子,採取以下Java類...

類Foo

package com.example; 
/** 
* 
* The class Foo is a test class 
*/ 
public class Foo 
{ 

    /** 
    * The test method 
    * @param args 
    */ 
    public static void main(String[] args) 
    { 

    } 

    public static void undocumentedMethod() 
    { 

    } 
} 

正如你所看到的靜態方法 「undocumentedMethod」 沒有任何Javadoc註釋。在創建文檔時,我希望獲得相關信息。

下面是doxygen的配置文件:

的Doxyfile

DOXYFILE_ENCODING  = UTF-8 
PROJECT_NAME   = "DoxyTest" 
OUTPUT_DIRECTORY  = "docs" 
OUTPUT_LANGUAGE  = English 
RECURSIVE    = YES 
WARNINGS    = YES 
WARN_IF_UNDOCUMENTED = YES 
WARN_IF_DOC_ERROR  = YES 
WARN_NO_PARAMDOC  = NO 
GENERATE_LATEX   = NO 

這裏是ant腳本...

的build.xml

<?xml version="1.0" encoding="UTF-8" standalone="no"?> 
<project xmlns:ivy="antlib:org.apache.ivy.ant" xmlns:doxygen="antlib:org.doxygen.tools" basedir="." default="test" name="DoxyTest"> 
    <target name="test" description="test target"> 
     <doxygen:doxygen configFilename="Doxyfile"/> 
    </target> 
</project> 

這是結果,當我運行ant腳本=>有運行時,Ant腳本

D:\ws\DoxyTest01>ant 
Buildfile: D:\ws\DoxyTest01\build.xml 

test: 
[doxygen:doxygen] Exec: doxygen Doxyfile 

BUILD SUCCESSFUL 
Total time: 0 seconds 

這裏是結果,當我直接=>運行doxygen的任何警告

結果警告(和大量的其它信息)的doxygen運行直接

D:\ws\DoxyTest01>doxygen Doxyfile 
Searching for include files... 
Searching for example files... 
Searching for images... 
Searching for dot files... 
Searching for msc files... 
Searching for dia files... 
Searching for files to exclude 
Searching INPUT for files to process... 
Searching for files in directory D:/ws/DoxyTest01 
Searching for files in directory D:/ws/DoxyTest01/bin 
Searching for files in directory D:/ws/DoxyTest01/bin/com 
Searching for files in directory D:/ws/DoxyTest01/bin/com/example 
Searching for files in directory D:/ws/DoxyTest01/docs 
Searching for files in directory D:/ws/DoxyTest01/src 
Searching for files in directory D:/ws/DoxyTest01/src/com 
Searching for files in directory D:/ws/DoxyTest01/src/com/example 
Reading and parsing tag files 
Parsing files 
Reading D:/ws/DoxyTest01/src/com/example/Foo.java... 
Parsing file D:/ws/DoxyTest01/src/com/example/Foo.java... 
Building group list... 
Building directory list... 
Building namespace list... 
Building file list... 
Building class list... 
Associating documentation with classes... 
Computing nesting relations for classes... 
Building example list... 
Searching for enumerations... 
Searching for documented typedefs... 
Searching for members imported via using declarations... 
Searching for included using directives... 
Searching for documented variables... 
Building interface member list... 
Building member list... 
Searching for friends... 
Searching for documented defines... 
Computing class inheritance relations... 
Computing class usage relations... 
Flushing cached template relations that have become invalid... 
Creating members for template instances... 
Computing class relations... 
Add enum values to enums... 
Searching for member function documentation... 
Building page list... 
Search for main page... 
Computing page relations... 
Determining the scope of groups... 
Sorting lists... 
Freeing entry tree 
Determining which enums are documented 
Computing member relations... 
Building full member lists recursively... 
Adding members to member groups. 
Computing member references... 
Inheriting documentation... 
Generating disk names... 
Adding source references... 
Adding xrefitems... 
Sorting member lists... 
Computing dependencies between directories... 
Generating citations page... 
Counting data structures... 
Resolving user defined references... 
Finding anchors and sections in the documentation... 
Transferring function references... 
Combining using relations... 
Adding members to index pages... 
Generating style sheet... 
Generating search indices... 
Generating example documentation... 
Generating file sources... 
Generating file documentation... 
Generating page documentation... 
Generating group documentation... 
Generating class documentation... 
Generating namespace index... 
Generating docs for compound com::example::Foo... 
D:/ws/DoxyTest01/src/com/example/Foo.java:7: warning: Member undocumentedMethod() (function) of class com::example::Foo is not documented. 
Generating graph info page... 
Generating directory documentation... 
Generating index page... 
Generating page index... 
Generating module index... 
Generating namespace index... 
Generating namespace member index... 
Generating annotated compound index... 
Generating alphabetical compound index... 
Generating hierarchical class index... 
Generating member index... 
Generating file index... 
Generating file member index... 
Generating example index... 
finalizing index lists... 
writing tag file... 
lookup cache used 2/65536 hits=2 misses=2 
finished... 
時被示出

結果

有誰知道是否有可能告訴螞蟻任務打印命令行工具打印的所有東西?

回答

0

嘗試用詳細的屬性設置爲true:

<doxygen:doxygen configFilename="Doxyfile" verbose="true"/> 

對於其他用法示例見github ant-doxygen
- 編輯 -
也許EXTRACT_ALL設置爲YES? 從doxygen site

構建相關的配置選項

EXTRACT_ALL

如果EXTRACT_ALL標籤設置爲YES,doxygen的將承擔所有實體 在文檔中記錄,即使沒有文檔是 可用。除非EXTRACT_PRIVATE和EXTRACT_STATIC標記被設置爲YES,否則私有類成員和靜態文件成員將隱藏 。 注意這還會禁用有關 未記錄成員的警告,通常在設置警告時將生成 爲YES。

+0

當使用'verbose =「true」'時,我會獲得更多信息。不幸的是,警告不會被打印。 – JanTheGun

+0

@JanTheGun你確定doxygen configfile被加載? – Rebse

+0

我沒有在Doxyfile中直接設置EXTRACT_ALL,所以默認情況下它的值應該是'NO'。儘管如此,我現在明確地將其設置爲'不',但仍然存在同樣的問題。我也改變了配置文件中的輸出目錄來檢查配置文件是否被加載。 – JanTheGun