Modify

Opened 3 months ago

Last modified 5 days ago

#14794 new defect

Javadoc for every top level class

Reported by: bastiK Owned by: team
Priority: normal Milestone: 17.08
Component: Core Version:
Keywords: javadoc Cc:

Description (last modified by bastiK)

We should have a short description (Javadoc) for the main class or interface in each .java file. Below is a list of all files that are currently missing this basic documentation:

  • src/org/openstreetmap/josm/actions/ActionParameter.java
  • src/org/openstreetmap/josm/actions/AdaptableAction.java
  • src/org/openstreetmap/josm/actions/CloseChangesetAction.java
  • src/org/openstreetmap/josm/actions/CopyCoordinatesAction.java
  • src/org/openstreetmap/josm/actions/ParameterizedAction.java
  • src/org/openstreetmap/josm/actions/ParameterizedActionDecorator.java
  • src/org/openstreetmap/josm/actions/PreferenceToggleAction.java
  • src/org/openstreetmap/josm/actions/ReverseWayAction.java
  • src/org/openstreetmap/josm/actions/SelectAllAction.java
  • src/org/openstreetmap/josm/actions/ShowStatusReportAction.java
  • src/org/openstreetmap/josm/actions/ToggleGPXLinesAction.java
  • src/org/openstreetmap/josm/actions/UnselectAllAction.java
  • src/org/openstreetmap/josm/actions/UpdateDataAction.java
  • src/org/openstreetmap/josm/actions/ZoomToAction.java
  • src/org/openstreetmap/josm/actions/downloadtasks/DownloadNotesUrlBoundsTask.java
  • src/org/openstreetmap/josm/actions/downloadtasks/DownloadNotesUrlIdTask.java
  • src/org/openstreetmap/josm/actions/downloadtasks/DownloadOsmIdTask.java
  • src/org/openstreetmap/josm/actions/downloadtasks/PostDownloadHandler.java
  • src/org/openstreetmap/josm/actions/mapmode/DrawSnapHelper.java
  • src/org/openstreetmap/josm/actions/mapmode/ImproveWayAccuracyAction.java
  • src/org/openstreetmap/josm/actions/mapmode/ParallelWayAction.java
  • src/org/openstreetmap/josm/actions/search/PushbackTokenizer.java
  • src/org/openstreetmap/josm/actions/search/SearchAction.java
  • src/org/openstreetmap/josm/actions/upload/ApiPreconditionCheckerHook.java
  • src/org/openstreetmap/josm/actions/upload/CyclicUploadDependencyException.java
  • src/org/openstreetmap/josm/actions/upload/UploadHook.java
  • src/org/openstreetmap/josm/command/ScaleCommand.java
  • src/org/openstreetmap/josm/data/cache/ICachedLoaderJob.java
  • src/org/openstreetmap/josm/data/conflict/IConflictListener.java
  • src/org/openstreetmap/josm/data/coor/QuadTiling.java
  • src/org/openstreetmap/josm/data/gpx/GpxRoute.java
  • src/org/openstreetmap/josm/data/gpx/ImmutableGpxTrackSegment.java
  • src/org/openstreetmap/josm/data/gpx/WayPoint.java
  • src/org/openstreetmap/josm/data/imagery/Shape.java
  • src/org/openstreetmap/josm/data/oauth/OAuthToken.java
  • src/org/openstreetmap/josm/data/osm/ChangesetCacheEvent.java
  • src/org/openstreetmap/josm/data/osm/ChangesetCacheListener.java
  • src/org/openstreetmap/josm/data/osm/DefaultChangesetCacheEvent.java
  • src/org/openstreetmap/josm/data/osm/NodeData.java
  • src/org/openstreetmap/josm/data/osm/OsmUtils.java
  • src/org/openstreetmap/josm/data/osm/RelationMemberData.java
  • src/org/openstreetmap/josm/data/osm/RelationToChildReference.java
  • src/org/openstreetmap/josm/data/osm/SimplePrimitiveId.java
  • src/org/openstreetmap/josm/data/osm/WayData.java
  • src/org/openstreetmap/josm/data/osm/event/ChangesetIdChangedEvent.java
  • src/org/openstreetmap/josm/data/osm/event/DataChangedEvent.java
  • src/org/openstreetmap/josm/data/osm/event/NodeMovedEvent.java
  • src/org/openstreetmap/josm/data/osm/event/PrimitivesAddedEvent.java
  • src/org/openstreetmap/josm/data/osm/event/PrimitivesRemovedEvent.java
  • src/org/openstreetmap/josm/data/osm/event/RelationMembersChangedEvent.java
  • src/org/openstreetmap/josm/data/osm/event/TagsChangedEvent.java
  • src/org/openstreetmap/josm/data/osm/event/WayNodesChangedEvent.java
  • src/org/openstreetmap/josm/data/osm/history/HistoryDataSetListener.java
  • src/org/openstreetmap/josm/data/osm/visitor/paint/PaintColors.java
  • src/org/openstreetmap/josm/data/preferences/CachedProperty.java
  • src/org/openstreetmap/josm/data/preferences/ParametrizedEnumProperty.java
  • src/org/openstreetmap/josm/data/projection/ProjectionChangeListener.java
  • src/org/openstreetmap/josm/data/projection/ProjectionConfigurationException.java
  • src/org/openstreetmap/josm/data/projection/datum/AbstractDatum.java
  • src/org/openstreetmap/josm/data/validation/ValidatorVisitor.java
  • src/org/openstreetmap/josm/gui/GettingStarted.java
  • src/org/openstreetmap/josm/gui/HelpAwareOptionPane.java
  • src/org/openstreetmap/josm/gui/MapSlider.java
  • src/org/openstreetmap/josm/gui/NameFormatterHook.java
  • src/org/openstreetmap/josm/gui/bbox/SlippyMapBBoxChooser.java
  • src/org/openstreetmap/josm/gui/bbox/SourceButton.java
  • src/org/openstreetmap/josm/gui/conflict/pair/ComparePairListCellRenderer.java
  • src/org/openstreetmap/josm/gui/conflict/pair/IConflictResolver.java
  • src/org/openstreetmap/josm/gui/conflict/pair/MergeDecisionType.java
  • src/org/openstreetmap/josm/gui/conflict/pair/PairTable.java
  • src/org/openstreetmap/josm/gui/conflict/pair/tags/MergedTableCellRenderer.java
  • src/org/openstreetmap/josm/gui/conflict/pair/tags/MineTableCellRenderer.java
  • src/org/openstreetmap/josm/gui/conflict/pair/tags/TagMergeTableCellRenderer.java
  • src/org/openstreetmap/josm/gui/conflict/pair/tags/TheirTableCellRenderer.java
  • src/org/openstreetmap/josm/gui/conflict/tags/PasteTagsConflictResolverDialog.java
  • src/org/openstreetmap/josm/gui/conflict/tags/RelationMemberConflictDecision.java
  • src/org/openstreetmap/josm/gui/conflict/tags/RelationMemberConflictDecisionRenderer.java
  • src/org/openstreetmap/josm/gui/conflict/tags/RelationMemberConflictDecisionType.java
  • src/org/openstreetmap/josm/gui/conflict/tags/RelationMemberConflictResolver.java
  • src/org/openstreetmap/josm/gui/conflict/tags/RelationMemberConflictResolverColumnModel.java
  • src/org/openstreetmap/josm/gui/conflict/tags/RelationMemberConflictResolverTable.java
  • src/org/openstreetmap/josm/gui/conflict/tags/TagConflictResolverModel.java
  • src/org/openstreetmap/josm/gui/conflict/tags/TagConflictResolverTable.java
  • src/org/openstreetmap/josm/gui/dialogs/FilterDialog.java
  • src/org/openstreetmap/josm/gui/dialogs/FilterTableModel.java
  • src/org/openstreetmap/josm/gui/dialogs/LatLonDialog.java
  • src/org/openstreetmap/josm/gui/dialogs/MenuItemSearchDialog.java
  • src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetInSelectionListModel.java
  • src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetListCellRenderer.java
  • src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetListModel.java
  • src/org/openstreetmap/josm/gui/dialogs/properties/RecentTagCollection.java
  • src/org/openstreetmap/josm/gui/dialogs/relation/IMemberModelListener.java
  • src/org/openstreetmap/josm/gui/dialogs/relation/MemberRoleCellEditor.java
  • src/org/openstreetmap/josm/gui/dialogs/relation/MemberTable.java
  • src/org/openstreetmap/josm/gui/dialogs/relation/MemberTableColumnModel.java
  • src/org/openstreetmap/josm/gui/dialogs/relation/MemberTableLinkedCellRenderer.java
  • src/org/openstreetmap/josm/gui/dialogs/relation/MemberTableModel.java
  • src/org/openstreetmap/josm/gui/dialogs/relation/MemberTableRoleCellRenderer.java
  • src/org/openstreetmap/josm/gui/dialogs/relation/ReferringRelationsBrowserModel.java
  • src/org/openstreetmap/josm/gui/dialogs/relation/SelectionTableModel.java
  • src/org/openstreetmap/josm/gui/dialogs/relation/sort/RelationSortUtils.java
  • src/org/openstreetmap/josm/gui/dialogs/relation/sort/RelationSorter.java
  • src/org/openstreetmap/josm/gui/dialogs/relation/sort/WayConnectionType.java
  • src/org/openstreetmap/josm/gui/dialogs/relation/sort/WayConnectionTypeCalculator.java
  • src/org/openstreetmap/josm/gui/download/DownloadSelection.java
  • src/org/openstreetmap/josm/gui/history/NodeListTableCellRenderer.java
  • src/org/openstreetmap/josm/gui/history/SelectionSynchronizer.java
  • src/org/openstreetmap/josm/gui/io/AbstractUploadTask.java
  • src/org/openstreetmap/josm/gui/io/ConfigurationParameterRequestHandler.java
  • src/org/openstreetmap/josm/gui/io/CredentialDialog.java
  • src/org/openstreetmap/josm/gui/io/MaxChangesetSizeExceededPolicy.java
  • src/org/openstreetmap/josm/gui/io/SaveLayersDialog.java
  • src/org/openstreetmap/josm/gui/io/SaveLayersModel.java
  • src/org/openstreetmap/josm/gui/io/SaveLayersTable.java
  • src/org/openstreetmap/josm/gui/io/SaveLayersTableColumnModel.java
  • src/org/openstreetmap/josm/gui/io/UploadAndSaveProgressRenderer.java
  • src/org/openstreetmap/josm/gui/io/UploadOrSaveState.java
  • src/org/openstreetmap/josm/gui/io/UploadParameterSummaryPanel.java
  • src/org/openstreetmap/josm/gui/io/UploadStrategy.java
  • src/org/openstreetmap/josm/gui/layer/CustomizeColor.java
  • src/org/openstreetmap/josm/gui/layer/GpxLayer.java
  • src/org/openstreetmap/josm/gui/layer/ImageryLayer.java
  • src/org/openstreetmap/josm/gui/layer/JumpToMarkerActions.java
  • src/org/openstreetmap/josm/gui/layer/geoimage/ImageDisplay.java
  • src/org/openstreetmap/josm/gui/layer/geoimage/ImageViewerDialog.java
  • src/org/openstreetmap/josm/gui/layer/geoimage/ThumbsLoader.java
  • src/org/openstreetmap/josm/gui/layer/gpx/CustomizeDrawingAction.java
  • src/org/openstreetmap/josm/gui/layer/gpx/DateFilterPanel.java
  • src/org/openstreetmap/josm/gui/layer/gpx/ImportImagesAction.java
  • src/org/openstreetmap/josm/gui/layer/gpx/MarkersFromNamedPointsAction.java
  • src/org/openstreetmap/josm/gui/mappaint/StyleKeys.java
  • src/org/openstreetmap/josm/gui/mappaint/mapcss/CSSColors.java
  • src/org/openstreetmap/josm/gui/mappaint/mapcss/Instruction.java
  • src/org/openstreetmap/josm/gui/mappaint/styleelement/RepeatImageElement.java
  • src/org/openstreetmap/josm/gui/mappaint/styleelement/StyleElement.java
  • src/org/openstreetmap/josm/gui/oauth/AuthorizationProcedure.java
  • src/org/openstreetmap/josm/gui/oauth/AuthorizationProcedureComboBox.java
  • src/org/openstreetmap/josm/gui/oauth/FullyAutomaticPropertiesPanel.java
  • src/org/openstreetmap/josm/gui/oauth/OsmPrivilegesPanel.java
  • src/org/openstreetmap/josm/gui/preferences/DefaultPreferenceSetting.java
  • src/org/openstreetmap/josm/gui/preferences/DefaultTabPreferenceSetting.java
  • src/org/openstreetmap/josm/gui/preferences/PreferenceDialog.java
  • src/org/openstreetmap/josm/gui/preferences/SourceProvider.java
  • src/org/openstreetmap/josm/gui/preferences/projection/AbstractProjectionChoice.java
  • src/org/openstreetmap/josm/gui/preferences/projection/CustomProjectionChoice.java
  • src/org/openstreetmap/josm/gui/preferences/projection/GaussKruegerProjectionChoice.java
  • src/org/openstreetmap/josm/gui/preferences/projection/LambertCC9ZonesProjectionChoice.java
  • src/org/openstreetmap/josm/gui/preferences/projection/LambertProjectionChoice.java
  • src/org/openstreetmap/josm/gui/preferences/projection/PuwgProjectionChoice.java
  • src/org/openstreetmap/josm/gui/preferences/projection/SwissGridProjectionChoice.java
  • src/org/openstreetmap/josm/gui/preferences/projection/UTMFranceDOMProjectionChoice.java
  • src/org/openstreetmap/josm/gui/preferences/projection/UTMProjectionChoice.java
  • src/org/openstreetmap/josm/gui/progress/AbstractProgressMonitor.java
  • src/org/openstreetmap/josm/gui/progress/CancelHandler.java
  • src/org/openstreetmap/josm/gui/progress/ChildProgress.java
  • src/org/openstreetmap/josm/gui/progress/PleaseWaitProgressMonitor.java
  • src/org/openstreetmap/josm/gui/progress/ProgressException.java
  • src/org/openstreetmap/josm/gui/progress/ProgressTaskId.java
  • src/org/openstreetmap/josm/gui/progress/ProgressTaskIds.java
  • src/org/openstreetmap/josm/gui/tagging/presets/TaggingPresetLabel.java
  • src/org/openstreetmap/josm/gui/tagging/presets/TaggingPresetMenu.java
  • src/org/openstreetmap/josm/gui/tagging/presets/items/Roles.java
  • src/org/openstreetmap/josm/gui/widgets/BoundingBoxSelectionPanel.java
  • src/org/openstreetmap/josm/gui/widgets/HistoryChangedListener.java
  • src/org/openstreetmap/josm/gui/widgets/ListPopupMenu.java
  • src/org/openstreetmap/josm/gui/widgets/OsmPrimitivesTableModel.java
  • src/org/openstreetmap/josm/gui/widgets/SearchTextResultListPanel.java
  • src/org/openstreetmap/josm/gui/widgets/SelectAllOnFocusGainedDecorator.java
  • src/org/openstreetmap/josm/gui/widgets/VerticallyScrollablePanel.java
  • src/org/openstreetmap/josm/io/ChangesetQuery.java
  • src/org/openstreetmap/josm/io/DiffResultProcessor.java
  • src/org/openstreetmap/josm/io/FileExporter.java
  • src/org/openstreetmap/josm/io/MissingOAuthAccessTokenException.java
  • src/org/openstreetmap/josm/io/OsmChangeImporter.java
  • src/org/openstreetmap/josm/io/OsmImporter.java
  • src/org/openstreetmap/josm/io/OsmServerReadPostprocessor.java
  • src/org/openstreetmap/josm/io/OsmServerUserInfoReader.java
  • src/org/openstreetmap/josm/io/OsmServerWritePostprocessor.java
  • src/org/openstreetmap/josm/io/StreamProgressUpdater.java
  • src/org/openstreetmap/josm/io/auth/AbstractCredentialsAgent.java
  • src/org/openstreetmap/josm/io/auth/CredentialsAgentException.java
  • src/org/openstreetmap/josm/io/imagery/ImageryReader.java

I will start fixing classes that I understand most, but wouldn't mind some help. Hopefully we can get this list down to zero!

Attachments (2)

TopLevelJavadocCheck.java (2.4 KB) - added by bastiK 3 months ago.
TopLevelJavadocCheck.2.java (3.0 KB) - added by bastiK 3 months ago.

Download all attachments as: .zip

Change History (56)

Changed 3 months ago by bastiK

Attachment: TopLevelJavadocCheck.java added

comment:1 Changed 3 months ago by bastiK

Attached is a Checkstyle check that finds files with missing top level Javadoc.

comment:2 Changed 3 months ago by Don-vip

See also Sonar.

comment:3 Changed 3 months ago by bastiK

In 12148/josm:

see #14794 - javadoc

comment:4 Changed 3 months ago by bastiK

Description: modified (diff)

comment:5 Changed 3 months ago by michael2402

Description: modified (diff)

I'll do src/org/openstreetmap/josm/data/osm/

comment:6 Changed 3 months ago by michael2402

In 12186/josm:

See #14794: Add javadoc for all gpx classes.

comment:7 Changed 3 months ago by michael2402

In 12189/josm:

See #14794: Javadoc for data.osm package

comment:8 Changed 3 months ago by michael2402

Description: modified (diff)

comment:9 Changed 3 months ago by michael2402

In 12190/josm:

See #14794: More javadoc for data.osm package

comment:10 Changed 3 months ago by bastiK

In 12259/josm:

see #14794 - javadoc

comment:11 Changed 3 months ago by bastiK

Description: modified (diff)

comment:12 in reply to:  2 Changed 3 months ago by bastiK

Replying to Don-vip:

See also Sonar.

Good to know! But let's start with something achievable.

Replying to michael2402:

I'll do src/org/openstreetmap/josm/data/osm/

Great!

comment:13 Changed 3 months ago by Don-vip

In 12284/josm:

see #14794 - javadoc

comment:14 Changed 3 months ago by michael2402

Description: modified (diff)

comment:15 Changed 3 months ago by michael2402

In 12300/josm:

See #14794: Add class javadoc for MenuItemSearchDialog

comment:16 Changed 3 months ago by michael2402

Description: modified (diff)

I found some more files. Your list does not include classes with empty javadoc comments (only /** */) or with only an @author tag.

comment:17 Changed 3 months ago by bastiK

Description: modified (diff)

Changed 3 months ago by bastiK

Attachment: TopLevelJavadocCheck.2.java added

comment:18 in reply to:  16 Changed 3 months ago by bastiK

Replying to michael2402:

I found some more files. Your list does not include classes with empty javadoc comments (only /** */) or with only an @author tag.

Right, I've updated the check.

comment:19 Changed 2 months ago by michael2402

Description: modified (diff)

comment:20 Changed 2 months ago by michael2402

In 12371/josm:

See #14794: Class comment for ChangesetInSelectionListModel

comment:21 Changed 2 months ago by michael2402

In 12372/josm:

See #14794: Document package gui.dialogs.changeset

comment:22 Changed 2 months ago by michael2402

Description: modified (diff)

comment:23 Changed 2 months ago by michael2402

In 12376/josm:

See #14794: Document package osm.visitor.paint

comment:24 Changed 2 months ago by michael2402

In 12377/josm:

See #14794: Document the layer.gpx package

comment:25 Changed 2 months ago by michael2402

Description: modified (diff)

comment:26 Changed 2 months ago by michael2402

In 12385/josm:

See #14794: Class comment for CachedProperty

comment:27 Changed 2 months ago by michael2402

In 12390/josm:

See #14794: Document data.validation package and subpackages.

comment:28 Changed 2 months ago by michael2402

In 12391/josm:

See #14794: Documentation for the gui package

comment:29 Changed 2 months ago by michael2402

Description: modified (diff)

comment:30 Changed 6 weeks ago by bastiK

In 12452/josm:

see #14794 - javadoc for the josm.gui.io package

comment:31 Changed 6 weeks ago by bastiK

In 12453/josm:

see #14794 - remaining javadoc for the josm/data/ packages

comment:32 Changed 6 weeks ago by bastiK

Description: modified (diff)

comment:33 Changed 6 weeks ago by bastiK

In 12460/josm:

see #14794 - javadoc

comment:34 Changed 6 weeks ago by bastiK

Description: modified (diff)

comment:35 Changed 5 weeks ago by bastiK

In 12470/josm:

see #14794 - javadoc

comment:36 Changed 5 weeks ago by bastiK

Description: modified (diff)

comment:37 Changed 3 weeks ago by bastiK

In 12546/josm:

see #14794 - javadoc

comment:38 Changed 10 days ago by bastiK

In 12581/josm:

see #14794 - javadoc

comment:39 Changed 10 days ago by bastiK

Description: modified (diff)

comment:40 Changed 10 days ago by bastiK

In 12582/josm:

see #14794 - add checkstyle check

comment:41 Changed 10 days ago by bastiK

In 12583/josm:

see #14794 - unnecessary classpath entry

comment:42 Changed 9 days ago by bastiK

In 12584/josm:

see #14794 - update checkstyle filters

comment:43 Changed 9 days ago by Don-vip

Keywords: javadoc added
Milestone: 17.08

comment:44 Changed 9 days ago by Don-vip

build-common.xml in plugins must be updated as well, as the core checkstyle configuration/filter files are reused.

comment:45 Changed 9 days ago by Don-vip

This also breaks Eclipse checkstyle, as we need now to create a custom plugin: http://eclipse-cs.sourceforge.net/#!/custom-checks

comment:46 Changed 9 days ago by Don-vip

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)

comment:47 Changed 9 days ago by Don-vip

plugins build-common.xml updated in [o33491].

comment:48 in reply to:  47 Changed 9 days ago by bastiK

Replying to Don-vip:

plugins build-common.xml updated in [o33491].

Thank, you beat me to it! (not that I would mind :) )

comment:49 Changed 9 days ago by Don-vip

Well I was already into it because of https://github.com/checkstyle/checkstyle/issues/4612 :) Also I have some experience in custom Checkstyle plugins as I maintain one at work ;)

comment:50 Changed 9 days ago by Don-vip

Damn, this is unexpected:

BUILD FAILED
C:\SVN\josm\plugins\build-common.xml:528: Unable to process files: [C:\SVN\josm\plugins\ColumbusCSV\src\org\openstreetmap\josm\plugins\columbusCSV\ColumbusCSVImporter.java, C:\SVN\josm\plugins\ColumbusCSV\src\org\openstreetmap\josm\plugins\columbusCSV\ColumbusCSVPlugin.java, C:\SVN\josm\plugins\ColumbusCSV\src\org\openstreetmap\josm\plugins\columbusCSV\ColumbusCSVPreferences.java, C:\SVN\josm\plugins\ColumbusCSV\src\org\openstreetmap\josm\plugins\columbusCSV\ColumbusCSVReader.java, C:\SVN\josm\plugins\ColumbusCSV\src\org\openstreetmap\josm\plugins\columbusCSV\ColumbusCSVUtils.java, C:\SVN\josm\plugins\ColumbusCSV\src\org\openstreetmap\josm\plugins\columbusCSV\WayPointHelper.java]
        at com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.processFiles(CheckstyleAntTask.java:366)
...
Caused by: com.puppycrawl.tools.checkstyle.api.CheckstyleException: Exception was thrown while processing C:\SVN\josm\plugins\ColumbusCSV\src\org\openstreetmap\josm\plugins\columbusCSV\ColumbusCSVImporter.java
        at com.puppycrawl.tools.checkstyle.Checker.processFiles(Checker.java:295)
        at com.puppycrawl.tools.checkstyle.Checker.process(Checker.java:213)
        at com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.processFiles(CheckstyleAntTask.java:360)
        ... 18 more
Caused by: java.lang.NullPointerException
        at org.openstreetmap.josm.TopLevelJavadocCheck.hasProperText(TopLevelJavadocCheck.java:74)
        at org.openstreetmap.josm.TopLevelJavadocCheck.hasJavadoc(TopLevelJavadocCheck.java:70)
        at org.openstreetmap.josm.TopLevelJavadocCheck.visitToken(TopLevelJavadocCheck.java:90)
        at com.puppycrawl.tools.checkstyle.TreeWalker.notifyVisit(TreeWalker.java:368)
        at com.puppycrawl.tools.checkstyle.TreeWalker.processIter(TreeWalker.java:505)
        at com.puppycrawl.tools.checkstyle.TreeWalker.walk(TreeWalker.java:310)
        at com.puppycrawl.tools.checkstyle.TreeWalker.processFiltered(TreeWalker.java:187)
        at com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck.process(AbstractFileSetCheck.java:78)
        at com.puppycrawl.tools.checkstyle.Checker.processFile(Checker.java:316)
        at com.puppycrawl.tools.checkstyle.Checker.processFiles(Checker.java:286)
        ... 20 more

It seems your check is not happy with this class:

/**
 * This program is free software: you can redistribute it and/or modify it under 
 * the terms of the GNU General Public License as published by the 
 * Free Software Foundation, either version 3 of the License, or 
 * (at your option) any later version. 
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
 * See the GNU General Public License for more details. 
 * 
 * You should have received a copy of the GNU General Public License along with this program. 
 * If not, see <http://www.gnu.org/licenses/>.
 */

package org.openstreetmap.josm.plugins.columbusCSV;

import static org.openstreetmap.josm.tools.I18n.tr;

import java.io.File;
import java.io.IOException;

import org.openstreetmap.josm.Main;
import org.openstreetmap.josm.actions.AutoScaleAction;
import org.openstreetmap.josm.actions.ExtensionFileFilter;
import org.openstreetmap.josm.data.gpx.GpxData;
import org.openstreetmap.josm.gui.layer.GpxLayer;
import org.openstreetmap.josm.gui.layer.markerlayer.MarkerLayer;
import org.openstreetmap.josm.gui.progress.NullProgressMonitor;
import org.openstreetmap.josm.gui.progress.ProgressMonitor;
import org.openstreetmap.josm.io.FileImporter;
import org.openstreetmap.josm.io.IllegalDataException;

/**
 * 
 * @author Oliver Wieland <oliver.wieland@online.de>
 * 
 */
public class ColumbusCSVImporter extends FileImporter {
...
}
Last edited 9 days ago by Don-vip (previous) (diff)

comment:51 Changed 8 days ago by bastiK

In 12587/josm:

see #14794 - fix NPE

comment:52 in reply to:  50 Changed 8 days ago by bastiK

Replying to Don-vip:

Damn, this is unexpected:
[...]

Just a small NPE-bug.

The ant output is not particularly helpful, but this gave a stacktrace:

$ java -classpath build2:tools/checkstyle/checkstyle-all.jar com.puppycrawl.tools.checkstyle.Main -c tools/checkstyle/josm_checks.xml ../plugins/ColumbusCSV/src/org/openstreetmap/josm/plugins/columbusCSV/ColumbusCSVImporter.java 
Last edited 8 days ago by bastiK (previous) (diff)

comment:53 Changed 8 days ago by Don-vip

I got it in debug mode (cd plugins/ColumbusCSV && and -d checkstyle).

comment:54 Changed 5 days ago by Don-vip

In 12597/josm:

see #14794 - checkstyle/javadoc

Modify Ticket

Change Properties
Set your email in Preferences
Action
as new The owner will remain team.
as The resolution will be set. Next status will be 'closed'.
to The owner will be changed from team to the specified user. Next status will be 'new'.
Next status will be 'needinfo'.The owner will change to bastiK
as duplicate The resolution will be set to duplicate. Next status will be 'closed'.The specified ticket will be cross-referenced with this ticket
The owner will be changed from team to anonymous. Next status will be 'assigned'.

Add Comment


E-mail address and name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.