Exclude methods from javadoc

we use javadoc to create a test documentation report for our JUnit tests. which still works. But we want to exclude methods like @BeforeClass @AfterClass @Before @After , but they must be publicly available.

I found a similar question in stackoverflow. I do not want to mark methods as deprecated.

+5
source share
1 answer

We cannot do this for publicly available methods.

You can also add the tag @ exclude tag

From Documents.

@exclude

That the API was excluded from the Javadoc generation. Programmer mark class, interface, constructor, method or field using @exclude. The presence of a tag will exclude the API from the generated documentation. The text following the tag may explain the reason for the exception, but Javadok will be ignored. (It was previously proposed as @hide, but the term “hide” is more suitable for dynamic show / hide at run time.) For more information, see: Request for functions # 4058216 in Connection with developers.

You can get an alternative here .

+4
source

Source: https://habr.com/ru/post/1211686/


All Articles