CODEWITHSUNDEEP
javaantjavadoc
jsparks
jsparks

Reputation: 150

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. Here's a sample of the ant task target:

<target name="doc">
    <javadoc 
        access="public" 
        additionalparam=" -tag SequenceStep:a:&quot;Sequence Step:&quot;"
        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:

/**
 * @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:

Sequence Step:

methodOne() Method one specifics, methodTwo() Method two specifics

My expectation was to get something more equivalent to how @param works, listing one per use of the tag.

Can anyone provide suggestions on how to instead get one of the following outputs, if possible?

Sequence Step:

methodOne() Method one specifics

methodTwo() Method two specifics

or

Sequence Step:

methodOne() Method one specifics

Sequence Step:

methodTwo() Method two specifics

Upvotes: 2

Views: 229

Answers (1)

Andy Thomas
Andy Thomas

Reputation: 86411

Try this: 

/**
 * @SequenceStep 
 * <p>{@link package.DummyClass#methodOne()} Method one specifics</p>
 * <p>{@link package.DummyClass#methodTwo()} Method two specifics</p>
 */

Upvotes: 2

Related Questions