Modify

Opened 9 days ago

Last modified 8 days ago

#14794 new defect

Javadoc for every top level class

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

Description (last modified by michael2402)

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/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/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/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/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/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/HistoryChangedListener.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 (1)

TopLevelJavadocCheck.java (2.4 KB) - added by bastiK 9 days ago.

Download all attachments as: .zip

Change History (10)

Changed 9 days ago by bastiK

Attachment: TopLevelJavadocCheck.java added

comment:1 Changed 9 days ago by bastiK

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

comment:2 Changed 9 days ago by Don-vip

See also Sonar.

comment:3 Changed 9 days ago by bastiK

In 12148/josm:

see #14794 - javadoc

comment:4 Changed 9 days ago by bastiK

Description: modified (diff)

comment:5 Changed 8 days ago by michael2402

Description: modified (diff)

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

comment:6 Changed 8 days ago by michael2402

In 12186/josm:

See #14794: Add javadoc for all gpx classes.

comment:7 Changed 8 days ago by michael2402

In 12189/josm:

See #14794: Javadoc for data.osm package

comment:8 Changed 8 days ago by michael2402

Description: modified (diff)

comment:9 Changed 8 days ago by michael2402

In 12190/josm:

See #14794: More javadoc for data.osm package

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.