在doxygen ant任务中显示警告

Question

我正在使用ant-doxygen为java项目创建文档，效果很好。不幸的是，ant任务不会回应doxygen的警告，虽然它们在doxygen配置文件中启用。

我想获得警告，以防某些类/方法没有任何文档注释。

作为一个例子，采取以下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... 

时被示出

结果

有谁知道是否有可能告诉蚂蚁任务打印命令行工具打印的所有东西？

Answer 1

尝试用详细的属性设置为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。