[英]Multiple Custom Tags in Javadoc Displayed Separately?
When building our documentation, we've decided to use some custom tags to add details at a class level, leveraging Ant tasks for the build. 构建文档时,我们决定使用一些自定义标签在类级别添加详细信息,并利用Ant任务进行构建。 Here's a sample of the ant task target: 这是ant任务目标的示例:
<target name="doc">
<javadoc
access="public"
additionalparam=" -tag SequenceStep:a:"Sequence Step:""
author="true"
destdir="ant/doc"
doctitle="Test"
nodeprecated="false"
nodeprecatedlist="false"
noindex="true"
nonavbar="true"
notree="true"
source="1.6"
sourcepath="${src.dir};${test.dir}"
splitindex="false"
use="false"
version="true"
private="on"
failonerror="false">
<classpath path="${full.test.classpath}" />
</javadoc>
Internal to the class I've been testing, here's a sample Javadoc: 在我正在测试的类的内部,下面是一个示例Javadoc:
/**
* @SequenceStep {@link package.DummyClass#methodOne()} Method one specifics
*
* @SequenceStep {@link package.DummyClass#methodTwo()} Method two specifics
*/
My generated Javadoc gives me a section that looks like this: 我生成的Javadoc给出了如下所示的部分:
Sequence Step: 顺序步骤:
methodOne() Method one specifics, methodTwo() Method two specifics methodOne()方法一个细节,methodTwo()方法两个细节
My expectation was to get something more equivalent to how @param works, listing one per use of the tag. 我的期望是获得与@param的工作原理等效的东西,并在每次使用该标记时列出一个。
Can anyone provide suggestions on how to instead get one of the following outputs, if possible? 如有可能,任何人都可以提供有关如何获取以下输出之一的建议吗?
Sequence Step: 顺序步骤:
methodOne() Method one specifics methodOne()方法一的细节
methodTwo() Method two specifics methodTwo()方法两个细节
or 要么
Sequence Step: 顺序步骤:
methodOne() Method one specifics methodOne()方法一的细节
Sequence Step: 顺序步骤:
methodTwo() Method two specifics methodTwo()方法两个细节
Try this: 尝试这个:
/**
* @SequenceStep
* <p>{@link package.DummyClass#methodOne()} Method one specifics</p>
* <p>{@link package.DummyClass#methodTwo()} Method two specifics</p>
*/
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.