【问题标题】:Show warnings in doxygen ant task在 doxygen ant 任务中显示警告
【发布时间】:2015-12-18 07:15:43
【问题描述】:

我正在使用 ant-doxygen 为 java 项目创建文档,效果很好。不幸的是,尽管在 doxygen 配置文件中启用了 doxygen 的警告,但 ant 任务并没有回显它们。

如果某些类/方法没有任何文档 cmets,我希望收到警告。

以下面的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 cmets。在创建文档时,我希望了解这一点。

这里是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-script => 没有警告

运行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...

有谁知道是否有可能告诉 ant 任务打印命令行工具打印的所有内容?

【问题讨论】:

    标签: java ant doxygen


    【解决方案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 标签是隐藏的 设置为是。 注意这也会禁用有关的警告 设置 WARNINGS 时通常产生的未记录成员 是。

    【讨论】:

    • 我在使用 'verbose="true" ' 时确实获得了更多信息。不幸的是,警告没有打印出来。
    • @JanTheGun 你确定 doxygen 配置文件已加载?
    • 我没有在 Doxyfile 中明确设置 EXTRACT_ALL,所以默认情况下它的值应该是 'NO'。尽管如此,我现在将其明确设置为“否”,但仍然存在同样的问题。我还更改了配置文件中的输出目录,只是为了检查配置文件是否已加载。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2010-11-01
    • 2011-09-14
    • 2012-12-05
    • 2011-03-31
    • 2016-11-07
    • 2013-11-06
    相关资源
    最近更新 更多