Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃悶: Description using Javadoc includes @throws declarations #1039

Open
1 task done
netmikey opened this issue Apr 26, 2024 · 0 comments
Open
1 task done

馃悶: Description using Javadoc includes @throws declarations #1039

netmikey opened this issue Apr 26, 2024 · 0 comments
Labels
triage type:bug Something isn't working

Comments

@netmikey
Copy link

What happened?

When using the Javadoc as description using @Description, it looks like @throws parts of the method's Javadoc are simply appended verbatim to the documentation.

Example:

    /**
     * This is my test description.
     * 
     * @throws Exception
     *             Thrown when the test unexpectedly fails.
     */
    @Test
    @Description
    public void testSomething() throws Exception {
        // ...
    }

Allure shows:

image

We would not expect the @throws Javadoc tag to be part of the message.

What Allure Integration are you using?

allure-junit5

What version of Allure Integration you are using?

2.27.0

What version of Allure Report you are using?

2.27.0

Code of Conduct

  • I agree to follow this project's Code of Conduct
@netmikey netmikey added triage type:bug Something isn't working labels Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triage type:bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant