Modify

Opened 3 months ago

Closed 3 months ago

Last modified 3 months ago

#23465 closed defect (fixed)

Remove custom checkstyle plugin

Reported by: taylor.smock Owned by: team
Priority: normal Milestone: 24.02
Component: Core Version:
Keywords: Cc:

Description

source:trunk/tools/checkstyle/src/org/openstreetmap/josm/TopLevelJavadocCheck.java is duplicating functionality from MissingJavadocType. Our custom class is from #14794 (closed 2017-10-16). The check that makes it redundant was added in checkstyle 8.20 (released 2019-04-28).

The additional locations are found with the new check (it looks for all public classes by default):

[checkstyle] [WARN] src/org/openstreetmap/josm/actions/JoinAreasAction.java:105:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/actions/JoinAreasAction.java:237:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/data/osm/Filter.java:95:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/gui/conflict/pair/AbstractListMergeModel.java:834:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/gui/dialogs/relation/sort/WayConnectionType.java:35:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/gui/io/CustomConfigurator.java:378:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/gui/io/SaveLayersModel.java:24:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/gui/layer/ImageryLayer.java:195:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/gui/layer/JumpToMarkerActions.java:126:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/gui/layer/JumpToMarkerActions.java:142:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/gui/layer/markerlayer/MarkerLayer.java:622:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/gui/mappaint/StyleSetting.java:121:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/gui/mappaint/mapcss/ExpressionFactory.java:42:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/gui/mappaint/mapcss/ExpressionFactory.java:47:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/gui/preferences/ToolbarPreferences.java:242:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/gui/preferences/map/TaggingPresetPreference.java:191:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/gui/preferences/projection/CustomProjectionChoice.java:141:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/gui/util/MultikeyShortcutAction.java:16:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/io/session/SessionReader.java:450:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/tools/template_engine/Tokenizer.java:16:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] src/org/openstreetmap/josm/tools/template_engine/Tokenizer.java:49:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] test/unit/org/openstreetmap/josm/testutils/PluginServer.java:27:1: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] test/unit/org/openstreetmap/josm/testutils/PluginServer.java:28:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] test/unit/org/openstreetmap/josm/testutils/PluginServer.java:228:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] test/unit/org/openstreetmap/josm/testutils/annotations/AssertionsInEDT.java:24:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] test/unit/org/openstreetmap/josm/testutils/annotations/FakeImagery.java:116:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] test/unit/org/openstreetmap/josm/testutils/annotations/HTTPS.java:33:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] test/unit/org/openstreetmap/josm/testutils/annotations/LayerManager.java:27:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] test/unit/org/openstreetmap/josm/testutils/annotations/Logging.java:16:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] test/unit/org/openstreetmap/josm/testutils/annotations/MapPaintStyles.java:28:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] test/unit/org/openstreetmap/josm/testutils/annotations/MeasurementSystem.java:44:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] test/unit/org/openstreetmap/josm/testutils/annotations/OsmApi.java:33:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] test/unit/org/openstreetmap/josm/testutils/annotations/OsmApi.java:42:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] test/unit/org/openstreetmap/josm/testutils/annotations/ProjectionNadGrids.java:30:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] test/unit/org/openstreetmap/josm/testutils/annotations/ResetUniquePrimitiveIdCounters.java:39:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] test/unit/org/openstreetmap/josm/testutils/annotations/TaggingPresets.java:34:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] test/unit/org/openstreetmap/josm/testutils/annotations/TestUser.java:35:5: Missing a Javadoc comment. [MissingJavadocType]
[checkstyle] [WARN] test/unit/org/openstreetmap/josm/testutils/annotations/Timezone.java:23:5: Missing a Javadoc comment. [MissingJavadocType]

Attachments (1)

23465.patch (5.0 KB ) - added by taylor.smock 3 months ago.
Replace custom Javadoc check with upstream check

Download all attachments as: .zip

Change History (8)

by taylor.smock, 3 months ago

Attachment: 23465.patch added

Replace custom Javadoc check with upstream check

comment:1 by taylor.smock, 3 months ago

Additional notes from #14794:

  • comment:46:ticket:14794

    In 12586/josm: see #14794 - update to checkstyle 8.0 (to match the version used by Eclipse CS) + add new project to build custom Eclipse plugin (now required)

  • Don't forget to update build-common.xml for plugins!

comment:2 by taylor.smock, 3 months ago

In 18972/josm:

See #23465: Add additional javadoc comments

This also fixes some sonarlint issues

comment:3 by taylor.smock, 3 months ago

Resolution: fixed
Status: newclosed

In 18974/josm:

Fix #23465: Remove custom checkstyle plugin

TopLevelJavadocCheck.java is duplicating functionality from MissingJavadocType.
Our custom class is from #14794 (closed 2017-10-16). The check that makes it
redundant was added in checkstyle 8.20 (released 2019-04-28).

This adds the missing javadocs for the more comprehensive checkstyle version.

comment:4 by taylor.smock, 3 months ago

In 36208/osm:

Fix #23465: Remove custom checkstyle plugin

TopLevelJavadocCheck.java is duplicating functionality from MissingJavadocType.
Our custom class is from #14794 (closed 2017-10-16). The check that makes it
redundant was added in checkstyle 8.20 (released 2019-04-28).

This adds the missing javadocs for the more comprehensive checkstyle version.

comment:5 by taylor.smock, 3 months ago

In 18975/josm:

See #23465: Add missing documentation for SessionReader

comment:6 by GerdP, 3 months ago

I assumes that I can now use the checkstyle plugin in Eclipse instead of using

ant checkstyle-changed

Right?

comment:7 by taylor.smock, 3 months ago

You should be able to use the checkstyle eclipse plugin, yes.

You can still use ant checkstyle-changed though. When I made the change, I did check to make certain that it worked (on mac anyway). It should still work on Windows.

Modify Ticket

Change Properties
Set your email in Preferences
Action
as closed The owner will remain team.
as The resolution will be set.
The resolution will be deleted. Next status will be 'reopened'.

Add Comment


E-mail address and name can be saved in the Preferences .
 
Note: See TracTickets for help on using tickets.