On the dashboard, you observe the violations on Methods must have appropriate JavaDoc @throws tags quality rule . The violations seems to be wrong violations
Release | Yes/No |
---|---|
8.3.x |
RDBMS | Yes/No |
---|---|
CSS |
- Do and analysis and snapshot
- Connect to dashboard and observe violations on Methods must have appropriate JavaDoc @throws tags quality rule which seems to be wrong violations
Case1 - All @throws tags should contain class name and description
"Methods must have appropriate JavaDoc @throws tags" is violated if the description or the class-name as the parameter is not provided.
- Check if all the @throws tags has the class name and description.
The @throws [ClassName] [Description] - Add the class name and the description to all the throws tags.
Case2 - You are using @exception tags
The metric 'Methods must have appropriate JavaDoc @throws tags' and the metric 'Methods must have appropriate JavaDoc @exception tags' are both included in the current quality model.
The reason for this is that while @exceptions tags are deprecated, they are still in use in older applications. Newer applications generally use @throws tags.
Therefore, you may get violations for the metric 'Methods must have appropriate JavaDoc @throws tags' when using @exception tags.
- Please modify your assessment model for these metrics and
- Deactivate the one that is not needed based on your particular application requirements.