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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Get rid of module javadoc examples #13429

Closed
stoyanK7 opened this issue Jul 24, 2023 · 2 comments · Fixed by #13662
Closed

Get rid of module javadoc examples #13429

stoyanK7 opened this issue Jul 24, 2023 · 2 comments · Fixed by #13662
Assignees
Milestone

Comments

@stoyanK7
Copy link
Collaborator

The examples from each module Javadoc have to be removed. For example the following:

 * <p>
 * To configure the check so that it check name
 * but ignore {@code abstract} modifier:
 * </p>
 * <pre>
 * &lt;module name="AbstractClassName"&gt;
 *   &lt;property name="ignoreModifier" value="true"/&gt;
 * &lt;/module&gt;
 * </pre>
 * <p>Example:</p>
 * <pre>
 * class Example2 {
 *   abstract class AbstractFirst {}
 *   abstract class Second {} // violation 'must match pattern '\^Abstract\.\+\$''
 *   class AbstractThird {}
 *   class Fourth {}
 *   abstract class GeneratorFifth {} // violation 'must match pattern '\^Abstract\.\+\$''
 *   class GeneratorSixth {}
 * }
 * </pre>

An exclusion list from XdocJavadoc validation is created at #13357. This list should be removed and validation should be skipped for all modules once it's time to close this issue.

@nrmancuso
Copy link
Member

@stoyanK7 please share some details on how we will handle this isssue

@romani
Copy link
Member

romani commented Jul 26, 2023

@stoyanK7 will provide numerous PRs on this in summer to cover all not simple cases (non java Checks, filters, some java), so good practices will popup by themselves

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants