Skip to content
This repository has been archived by the owner on Nov 1, 2022. It is now read-only.

detekt: Enable Comments.UndocumentedPublicClass #76

Closed
pocmo opened this issue Apr 17, 2018 · 4 comments
Closed

detekt: Enable Comments.UndocumentedPublicClass #76

pocmo opened this issue Apr 17, 2018 · 4 comments
Labels
⌨️ code Technical debt, code clean up, small API change .. help wanted Extra attention is needed
Milestone
⛑ 15.0.0

Comments

@pocmo
Copy link
Contributor

pocmo commented Apr 17, 2018 •
edited by data-sync-user

Libraries should have javadoc comments for all public classes. Detekt has a check for that.

In order to enable this we'd need add comments to those classes:

UndocumentedPublicClass - [AutocompleteResult] at components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt:63:5
UndocumentedPublicClass - [ErrorPages] at components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt:11:1
UndocumentedPublicClass - [AutocompleteSource] at components/browser/domains/src/main/java/mozilla/components/browser/domains/DomainAutoCompleteProvider.kt:22:5
UndocumentedPublicClass - [SearchEngineManager] at components/browser/search/src/main/java/mozilla/components/browser/search/SearchEngineManager.kt:14:1
UndocumentedPublicClass - [ThreadUtils] at components/support/utils/src/main/java/mozilla/components/support/utils/ThreadUtils.kt:12:1
UndocumentedPublicClass - [DownloadUtils] at components/support/utils/src/main/java/mozilla/components/support/utils/DownloadUtils.kt:31:1
UndocumentedPublicClass - [DrawableUtils] at components/support/utils/src/main/java/mozilla/components/support/utils/DrawableUtils.kt:13:1
UndocumentedPublicClass - [ColorUtils] at components/support/utils/src/main/java/mozilla/components/support/utils/ColorUtils.kt:9:1
UndocumentedPublicClass - [StatusBarUtils] at components/support/utils/src/main/java/mozilla/components/support/utils/StatusBarUtils.kt:9:1

┆Issue is synchronized with this Jira Task
@pocmo pocmo added help wanted Extra attention is needed ⌨️ code Technical debt, code clean up, small API change .. labels Apr 17, 2018
@dector
Copy link
Contributor

dector commented Jun 17, 2019 •
edited

Don't want to sound too pessimistic 😄

but 
        UndocumentedPublicClass - [WebSetting] at components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt:238:5
        UndocumentedPublicClass - [SystemEngineSessionState] at components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSessionState.kt:11:1
        UndocumentedPublicClass - [ImageHandler] at components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineView.kt:634:5
        UndocumentedPublicClass - [GeckoEngineSessionState] at components/browser/engine-gecko-nightly/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSessionState.kt:14:1
        UndocumentedPublicClass - [SettingUpdater] at components/browser/engine-gecko-nightly/src/main/java/mozilla/components/browser/engine/gecko/integration/SettingUpdater.kt:3:1
        UndocumentedPublicClass - [GeckoViewFetchTestCases] at components/browser/engine-gecko-nightly/src/androidTest/java/mozilla/components/browser/engine/gecko/fetch/geckoview/GeckoViewFetchTestCases.kt:15:1
        UndocumentedPublicClass - [ProcessorDiskCache] at components/browser/icons/src/main/java/mozilla/components/browser/icons/processor/DiskIconProcessor.kt:17:5
        UndocumentedPublicClass - [ProcessorMemoryCache] at components/browser/icons/src/main/java/mozilla/components/browser/icons/processor/MemoryIconProcessor.kt:17:5
        UndocumentedPublicClass - [Result] at components/browser/icons/src/main/java/mozilla/components/browser/icons/loader/IconLoader.kt:21:5
        UndocumentedPublicClass - [NoResult] at components/browser/icons/src/main/java/mozilla/components/browser/icons/loader/IconLoader.kt:22:9
        UndocumentedPublicClass - [BitmapResult] at components/browser/icons/src/main/java/mozilla/components/browser/icons/loader/IconLoader.kt:24:9
        UndocumentedPublicClass - [BytesResult] at components/browser/icons/src/main/java/mozilla/components/browser/icons/loader/IconLoader.kt:29:9
        UndocumentedPublicClass - [LoaderDiskCache] at components/browser/icons/src/main/java/mozilla/components/browser/icons/loader/DiskIconLoader.kt:17:5
        UndocumentedPublicClass - [LoaderMemoryCache] at components/browser/icons/src/main/java/mozilla/components/browser/icons/loader/MemoryIconLoader.kt:18:5
        UndocumentedPublicClass - [PreparerDiskCache] at components/browser/icons/src/main/java/mozilla/components/browser/icons/preparer/DiskIconPreparer.kt:17:5
        UndocumentedPublicClass - [PreparerMemoryCache] at components/browser/icons/src/main/java/mozilla/components/browser/icons/preparer/MemoryIconPreparer.kt:17:5
        UndocumentedPublicClass - [TabThumbnailView] at components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/thumbnail/TabThumbnailView.kt:14:1
        UndocumentedPublicClass - [GeckoEngineSessionState] at components/browser/engine-gecko/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSessionState.kt:14:1
        UndocumentedPublicClass - [GeckoViewFetchTestCases] at components/browser/engine-gecko/src/androidTest/java/mozilla/components/browser/engine/gecko/fetch/geckoview/GeckoViewFetchTestCases.kt:15:1
        UndocumentedPublicClass - [Visit] at components/browser/storage-memory/src/main/java/mozilla/components/browser/storage/memory/InMemoryHistoryStorage.kt:17:1
        UndocumentedPublicClass - [Hit] at components/browser/storage-memory/src/main/java/mozilla/components/browser/storage/memory/InMemoryHistoryStorage.kt:88:9
        UndocumentedPublicClass - [ResponseParserException] at components/browser/search/src/main/java/mozilla/components/browser/search/suggestions/SearchSuggestionClient.kt:28:5
        UndocumentedPublicClass - [GeckoEngineSessionState] at components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSessionState.kt:14:1
        UndocumentedPublicClass - [SettingUpdater] at components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/integration/SettingUpdater.kt:3:1
        UndocumentedPublicClass - [GeckoViewFetchTestCases] at components/browser/engine-gecko-beta/src/androidTest/java/mozilla/components/browser/engine/gecko/fetch/geckoview/GeckoViewFetchTestCases.kt:15:1
        UndocumentedPublicClass - [Binding] at components/browser/state/src/main/java/mozilla/components/browser/session/store/BrowserStore.kt:105:9
        UndocumentedPublicClass - [CustomTabActionButtonConfig] at components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt:196:1
        UndocumentedPublicClass - [CustomTabMenuItem] at components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt:197:1
        UndocumentedPublicClass - [AutoSave] at components/browser/session/src/main/java/mozilla/components/browser/session/storage/AutoSave.kt:23:1
        UndocumentedPublicClass - [Storage] at components/browser/session/src/main/java/mozilla/components/browser/session/storage/AutoSave.kt:28:5
        UndocumentedPublicClass - [LoadRequestMetadata] at components/browser/session/src/main/java/mozilla/components/browser/session/engine/request/LoadRequestMetadata.kt:9:1
        UndocumentedPublicClass - [Snapshot] at components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt:155:5
        UndocumentedPublicClass - [Item] at components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt:161:9
        UndocumentedPublicClass - [Observer] at components/browser/session/src/main/java/mozilla/components/browser/session/utils/AllSessionsObserver.kt:57:5
        UndocumentedPublicClass - [DomainList] at components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt:18:1
        UndocumentedPublicClass - [DomainAutocompleteProvider] at components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt:33:1
        UndocumentedPublicClass - [AutocompleteSource] at components/browser/domains/src/main/java/mozilla/components/browser/domains/DomainAutoCompleteProvider.kt:26:5
        UndocumentedPublicClass - [ErrorPages] at components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt:11:1
        UndocumentedPublicClass - [Orientation] at components/browser/menu/src/main/java/mozilla/components/browser/menu/BrowserMenu.kt:108:5
        UndocumentedPublicClass - [BrowserMenuItemViewHolder] at components/browser/menu/src/main/java/mozilla/components/browser/menu/BrowserMenuAdapter.kt:46:1
        UndocumentedPublicClass - [Highlight] at components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuHighlightableItem.kt:111:5
        UndocumentedPublicClass - [Listener] at components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/view/FindInPageView.kt:39:5
        UndocumentedPublicClass - [DownloadManager] at components/feature/downloads/src/main/java/mozilla/components/feature/downloads/manager/DownloadManager.kt:13:1
        UndocumentedPublicClass - [SearchUseCase] at components/feature/search/src/main/java/mozilla/components/feature/search/SearchUseCases.kt:28:5
        UndocumentedPublicClass - [DefaultSearchUseCase] at components/feature/search/src/main/java/mozilla/components/feature/search/SearchUseCases.kt:32:5
        UndocumentedPublicClass - [NewTabSearchUseCase] at components/feature/search/src/main/java/mozilla/components/feature/search/SearchUseCases.kt:70:5
        UndocumentedPublicClass - [WorkManagerSyncDispatcher] at components/feature/sync/src/main/java/mozilla/components/feature/sync/WorkManagerSyncDispatcher.kt:79:1
        UndocumentedPublicClass - [WorkManagerSyncWorker] at components/feature/sync/src/main/java/mozilla/components/feature/sync/WorkManagerSyncDispatcher.kt:187:1
        UndocumentedPublicClass - [Permission] at components/feature/sitepermissions/src/main/java/mozilla/components/feature/sitepermissions/SitePermissionsStorage.kt:153:5
        UndocumentedPublicClass - [PromptsStyling] at components/feature/sitepermissions/src/main/java/mozilla/components/feature/sitepermissions/SitePermissionsFeature.kt:485:5
        UndocumentedPublicClass - [Action] at components/feature/sitepermissions/src/main/java/mozilla/components/feature/sitepermissions/SitePermissionsRules.kt:21:5
        UndocumentedPublicClass - [Status] at components/feature/sitepermissions/src/main/java/mozilla/components/feature/sitepermissions/SitePermissions.kt:38:5
        UndocumentedPublicClass - [CREATOR] at components/feature/sitepermissions/src/main/java/mozilla/components/feature/sitepermissions/SitePermissions.kt:63:5
        UndocumentedPublicClass - [RegistrableDomain] at components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarFeature.kt:83:9
        UndocumentedPublicClass - [ColoredUrl] at components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarFeature.kt:84:9
        UndocumentedPublicClass - [UncoloredUrl] at components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarFeature.kt:85:9
        UndocumentedPublicClass - [Mode] at components/feature/awesomebar/src/main/java/mozilla/components/feature/awesomebar/provider/SearchSuggestionProvider.kt:146:5
        UndocumentedPublicClass - [CameraAndMicrophone] at components/feature/media/src/main/java/mozilla/components/feature/media/RecordingDevicesNotificationFeature.kt:131:5
        UndocumentedPublicClass - [Camera] at components/feature/media/src/main/java/mozilla/components/feature/media/RecordingDevicesNotificationFeature.kt:136:5
        UndocumentedPublicClass - [Microphone] at components/feature/media/src/main/java/mozilla/components/feature/media/RecordingDevicesNotificationFeature.kt:141:5
        UndocumentedPublicClass - [None] at components/feature/media/src/main/java/mozilla/components/feature/media/RecordingDevicesNotificationFeature.kt:146:5
        UndocumentedPublicClass - [ButtonType] at components/feature/prompts/src/main/java/mozilla/components/feature/prompts/MultiButtonDialogFragment.kt:125:5
        UndocumentedPublicClass - [SelectTabUseCase] at components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt:18:5
        UndocumentedPublicClass - [RemoveTabUseCase] at components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt:31:5
        UndocumentedPublicClass - [AddNewTabUseCase] at components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt:44:5
        UndocumentedPublicClass - [AddNewPrivateTabUseCase] at components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt:82:5
        UndocumentedPublicClass - [RemoveAllTabsUseCase] at components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt:120:5
        UndocumentedPublicClass - [RemoveAllTabsOfTypeUseCase] at components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt:128:5
        UndocumentedPublicClass - [Listener] at components/feature/readerview/src/main/java/mozilla/components/feature/readerview/view/ReaderViewControlsView.kt:50:5
        UndocumentedPublicClass - [FontType] at components/feature/readerview/src/main/java/mozilla/components/feature/readerview/ReaderViewFeature.kt:60:5
        UndocumentedPublicClass - [ColorScheme] at components/feature/readerview/src/main/java/mozilla/components/feature/readerview/ReaderViewFeature.kt:61:5
        UndocumentedPublicClass - [Config] at components/feature/readerview/src/main/java/mozilla/components/feature/readerview/ReaderViewFeature.kt:63:5
        UndocumentedPublicClass - [DefaultLoadUrlUseCase] at components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt:33:5
        UndocumentedPublicClass - [LoadDataUseCase] at components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt:63:5
        UndocumentedPublicClass - [ReloadUrlUseCase] at components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt:82:5
        UndocumentedPublicClass - [StopLoadingUseCase] at components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt:98:5
        UndocumentedPublicClass - [GoBackUseCase] at components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt:113:5
        UndocumentedPublicClass - [GoForwardUseCase] at components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt:126:5
        UndocumentedPublicClass - [RequestDesktopSiteUseCase] at components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt:139:5
        UndocumentedPublicClass - [ExitFullScreenUseCase] at components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt:152:5
        UndocumentedPublicClass - [ClearDataUseCase] at components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt:165:5
        UndocumentedPublicClass - [PageObservation] at components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt:122:1
        UndocumentedPublicClass - [TabReceived] at components/concept/sync/src/main/java/mozilla/components/concept/sync/DeviceEvents.kt:18:5
        UndocumentedPublicClass - [SendTab] at components/concept/sync/src/main/java/mozilla/components/concept/sync/DeviceEvents.kt:25:5
        UndocumentedPublicClass - [TabData] at components/concept/sync/src/main/java/mozilla/components/concept/sync/DeviceEvents.kt:28:1
        UndocumentedPublicClass - [Avatar] at components/concept/sync/src/main/java/mozilla/components/concept/sync/OAuthAccount.kt:115:1
        UndocumentedPublicClass - [Profile] at components/concept/sync/src/main/java/mozilla/components/concept/sync/OAuthAccount.kt:120:1
        UndocumentedPublicClass - [StoreSyncStatus] at components/concept/sync/src/main/java/mozilla/components/concept/sync/Sync.kt:102:1
        UndocumentedPublicClass - [SiteSecurity] at components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt:355:5
        UndocumentedPublicClass - [UnsupportedSetting] at components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt:194:1
        UndocumentedPublicClass - [Purpose] at components/concept/engine/src/main/java/mozilla/components/concept/engine/manifest/WebAppManifest.kt:103:9
        UndocumentedPublicClass - [Content] at components/concept/engine/src/main/java/mozilla/components/concept/engine/request/RequestInterceptor.kt:18:9
        UndocumentedPublicClass - [Url] at components/concept/engine/src/main/java/mozilla/components/concept/engine/request/RequestInterceptor.kt:24:9
        UndocumentedPublicClass - [CREATOR] at components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/Choice.kt:54:5
        UndocumentedPublicClass - [Type] at components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt:89:9
        UndocumentedPublicClass - [Level] at components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt:141:9
        UndocumentedPublicClass - [Method] at components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt:145:9
        UndocumentedPublicClass - [PlaybackState] at components/concept/engine/src/main/java/mozilla/components/concept/engine/media/Media.kt:61:5
        UndocumentedPublicClass - [ContentAudioCapture] at components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt:62:5
        UndocumentedPublicClass - [ContentAudioMicrophone] at components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt:63:5
        UndocumentedPublicClass - [ContentAudioOther] at components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt:64:5
        UndocumentedPublicClass - [ContentGeoLocation] at components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt:65:5
        UndocumentedPublicClass - [ContentNotification] at components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt:66:5
        UndocumentedPublicClass - [ContentProtectedMediaId] at components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt:67:5
        UndocumentedPublicClass - [ContentVideoCamera] at components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt:68:5
        UndocumentedPublicClass - [ContentVideoCapture] at components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt:69:5
        UndocumentedPublicClass - [ContentVideoScreen] at components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt:70:5
        UndocumentedPublicClass - [ContentVideoOther] at components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt:71:5
        UndocumentedPublicClass - [AppCamera] at components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt:73:5
        UndocumentedPublicClass - [AppAudio] at components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt:74:5
        UndocumentedPublicClass - [AppLocationCoarse] at components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt:75:5
        UndocumentedPublicClass - [AppLocationFine] at components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt:76:5
        UndocumentedPublicClass - [Generic] at components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt:78:5
        UndocumentedPublicClass - [ContentVideoApplication] at components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt:80:5
        UndocumentedPublicClass - [ContentVideoBrowser] at components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt:82:5
        UndocumentedPublicClass - [ContentVideoWindow] at components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt:83:5
        UndocumentedPublicClass - [Light] at components/concept/engine/src/main/java/mozilla/components/concept/engine/mediaquery/PreferredColorScheme.kt:10:5
        UndocumentedPublicClass - [Dark] at components/concept/engine/src/main/java/mozilla/components/concept/engine/mediaquery/PreferredColorScheme.kt:11:5
        UndocumentedPublicClass - [System] at components/concept/engine/src/main/java/mozilla/components/concept/engine/mediaquery/PreferredColorScheme.kt:12:5
        UndocumentedPublicClass - [Registration] at components/concept/push/src/main/java/mozilla/components/concept/push/PushProcessor.kt:96:5
        UndocumentedPublicClass - [Network] at components/concept/push/src/main/java/mozilla/components/concept/push/PushProcessor.kt:97:5
        UndocumentedPublicClass - [Rust] at components/concept/push/src/main/java/mozilla/components/concept/push/PushProcessor.kt:98:5
        UndocumentedPublicClass - [MalformedMessage] at components/concept/push/src/main/java/mozilla/components/concept/push/PushProcessor.kt:99:5
        UndocumentedPublicClass - [ServiceUnavailable] at components/concept/push/src/main/java/mozilla/components/concept/push/PushProcessor.kt:100:5
        UndocumentedPublicClass - [Redirect] at components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt:127:5
        UndocumentedPublicClass - [CookiePolicy] at components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt:139:5
        UndocumentedPublicClass - [Base64] at components/support/ktx/src/main/java/mozilla/components/support/ktx/android/util/Base64.kt:11:1
        UndocumentedPublicClass - [RustLog] at components/support/rustlog/src/main/java/mozilla/components/support/rustlog/RustLog.kt:11:1
        UndocumentedPublicClass - [LogSink] at components/support/base/src/main/java/mozilla/components/support/base/log/sink/LogSink.kt:9:1
        UndocumentedPublicClass - [DomainMatch] at components/support/utils/src/main/java/mozilla/components/support/utils/DomainMatcher.kt:13:1
        UndocumentedPublicClass - [ColorUtils] at components/support/utils/src/main/java/mozilla/components/support/utils/ColorUtils.kt:9:1
        UndocumentedPublicClass - [StorageUtils] at components/support/utils/src/main/java/mozilla/components/support/utils/StorageUtils.kt:7:1
        UndocumentedPublicClass - [ThreadUtils] at components/support/utils/src/main/java/mozilla/components/support/utils/ThreadUtils.kt:11:1
        UndocumentedPublicClass - [DrawableUtils] at components/support/utils/src/main/java/mozilla/components/support/utils/DrawableUtils.kt:13:1
        UndocumentedPublicClass - [DownloadUtils] at components/support/utils/src/main/java/mozilla/components/support/utils/DownloadUtils.kt:31:1
        UndocumentedPublicClass - [URLStringUtils] at components/support/utils/src/main/java/mozilla/components/support/utils/URLStringUtils.kt:10:1
        UndocumentedPublicClass - [StatusBarUtils] at components/support/utils/src/main/java/mozilla/components/support/utils/StatusBarUtils.kt:9:1
        UndocumentedPublicClass - [AutocompleteResult] at components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt:94:5
        UndocumentedPublicClass - [TabCounter] at components/ui/tabcounter/src/main/java/mozilla/components/ui/tabcounter/TabCounter.kt:22:1
        UndocumentedPublicClass - [ExperimentsDebugActivity] at components/service/experiments/src/main/java/mozilla/components/service/experiments/debug/ExperimentsDebugActivity.kt:19:1
        UndocumentedPublicClass - [Experiments] at components/service/experiments/src/main/java/mozilla/components/service/experiments/Experiments.kt:317:1
        UndocumentedPublicClass - [Matcher] at components/service/experiments/src/main/java/mozilla/components/service/experiments/Experiment.kt:74:5
        UndocumentedPublicClass - [ExperimentsMapMeasurement] at components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/ExperimentsMapMeasurement.kt:14:1
        UndocumentedPublicClass - [TelemetryClient] at components/service/telemetry/src/main/java/org/mozilla/telemetry/net/TelemetryClient.kt:20:1
        UndocumentedPublicClass - [SyncWorker] at components/service/fretboard/src/main/java/mozilla/components/service/fretboard/scheduler/workmanager/SyncWorker.kt:12:1
        UndocumentedPublicClass - [Matcher] at components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt:47:5
        UndocumentedPublicClass - [Bucket] at components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt:82:5
        UndocumentedPublicClass - [RecordedEventData] at components/service/glean/src/main/java/mozilla/components/service/glean/storages/EventsStorageEngine.kt:346:1
        UndocumentedPublicClass - [RecordedExperimentData] at components/service/glean/src/main/java/mozilla/components/service/glean/storages/ExperimentsStorageEngine.kt:138:1
        UndocumentedPublicClass - [GleanInternalAPI] at components/service/glean/src/main/java/mozilla/components/service/glean/Glean.kt:41:1
        UndocumentedPublicClass - [Glean] at components/service/glean/src/main/java/mozilla/components/service/glean/Glean.kt:532:1
        UndocumentedPublicClass - [ErrorRecording] at components/service/glean/src/main/java/mozilla/components/service/glean/error/ErrorRecording.kt:22:1
        UndocumentedPublicClass - [WaitableCoroutineScope] at components/service/glean/src/main/java/mozilla/components/service/glean/Dispatchers.kt:17:5
        UndocumentedPublicClass - [AccountStorage] at components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccountStorage.kt:14:1
        UndocumentedPublicClass - [SharedPrefAccountStorage] at components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccountStorage.kt:21:1
        UndocumentedPublicClass - [AuthErrorObserver] at components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/manager/FxaAccountManager.kt:61:1
        UndocumentedPublicClass - [PeriodicRefreshManager] at components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/manager/FxaDeviceManager.kt:119:1
        UndocumentedPublicClass - [AccountNotFound] at components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/manager/State.kt:32:5
        UndocumentedPublicClass - [AccountRestored] at components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/manager/State.kt:33:5
        UndocumentedPublicClass - [Authenticate] at components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/manager/State.kt:35:5
        UndocumentedPublicClass - [Authenticated] at components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/manager/State.kt:36:5
        UndocumentedPublicClass - [AuthenticationError] at components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/manager/State.kt:43:5
        UndocumentedPublicClass - [RecoveredFromAuthenticationProblem] at components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/manager/State.kt:48:5
        UndocumentedPublicClass - [FetchProfile] at components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/manager/State.kt:49:5
        UndocumentedPublicClass - [FetchedProfile] at components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/manager/State.kt:50:5
        UndocumentedPublicClass - [FailedToAuthenticate] at components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/manager/State.kt:52:5
        UndocumentedPublicClass - [FailedToFetchProfile] at components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/manager/State.kt:53:5
        UndocumentedPublicClass - [Logout] at components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/manager/State.kt:55:5
        UndocumentedPublicClass - [Pair] at components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/manager/State.kt:57:5
        UndocumentedPublicClass - [Prompt] at components/lib/crash/src/main/java/mozilla/components/lib/crash/CrashReporter.kt:149:5
        UndocumentedPublicClass - [Offset] at components/lib/publicsuffixlist/src/main/java/mozilla/components/lib/publicsuffixlist/PublicSuffixListData.kt:149:5
        UndocumentedPublicClass - [PublicSuffix] at components/lib/publicsuffixlist/src/main/java/mozilla/components/lib/publicsuffixlist/PublicSuffixListData.kt:150:5
        UndocumentedPublicClass - [PrevailingRule] at components/lib/publicsuffixlist/src/main/java/mozilla/components/lib/publicsuffixlist/PublicSuffixListData.kt:151:5
        UndocumentedPublicClass - [Type] at components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt:15:5
        UndocumentedPublicClass - [GrammarElement] at components/lib/jexl/src/main/java/mozilla/components/lib/jexl/grammar/Grammar.kt:138:1
        UndocumentedPublicClass - [Jexl] at components/lib/jexl/src/main/java/mozilla/components/lib/jexl/Jexl.kt:19:1
        UndocumentedPublicClass - [ParserException] at components/lib/jexl/src/main/java/mozilla/components/lib/jexl/parser/Parser.kt:143:1
        UndocumentedPublicClass - [AstType] at components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstType.kt:7:1
        UndocumentedPublicClass - [Config] at buildSrc/src/main/java/Config.kt:5:1
        UndocumentedPublicClass - [GVVersionVerifierPlugin] at buildSrc/src/main/java/GVVersionVerifierPlugin.kt:16:1
        UndocumentedPublicClass - [GitHubClient] at buildSrc/src/main/java/GitHubClient.kt:9:1
        UndocumentedPublicClass - [Versions] at buildSrc/src/main/java/Dependencies.kt:5:1
        UndocumentedPublicClass - [AndroidX] at buildSrc/src/main/java/Dependencies.kt:33:5
        UndocumentedPublicClass - [Firebase] at buildSrc/src/main/java/Dependencies.kt:53:5
        UndocumentedPublicClass - [Dependencies] at buildSrc/src/main/java/Dependencies.kt:59:1
        UndocumentedPublicClass - [Gecko] at buildSrc/src/main/java/Gecko.kt:22:1
        UndocumentedPublicClass - [PublicSuffixListData] at buildSrc/src/main/java/plugins/PublicSuffixListPlugin.kt:116:1
        UndocumentedPublicClass - [GitHubPlugin] at buildSrc/src/main/java/GitHubPlugin.kt:11:1
        UndocumentedPublicClass - [CrashActivity] at samples/crash/src/main/java/org/mozilla/samples/crash/CrashActivity.kt:20:1
        UndocumentedPublicClass - [CrashApplication] at samples/crash/src/main/java/org/mozilla/samples/crash/CrashApplication.kt:21:1
        UndocumentedPublicClass - [LoginFragment] at samples/sync/src/main/java/org/mozilla/samples/sync/LoginFragment.kt:20:1
        UndocumentedPublicClass - [OnLoginCompleteListener] at samples/sync/src/main/java/org/mozilla/samples/sync/LoginFragment.kt:91:5
        UndocumentedPublicClass - [MainActivity] at samples/sync/src/main/java/org/mozilla/samples/sync/MainActivity.kt:43:1
        UndocumentedPublicClass - [ViewHolder] at samples/sync/src/main/java/org/mozilla/samples/sync/DeviceRecyclerViewAdapter.kt:57:5
        UndocumentedPublicClass - [CustomTabActivity] at samples/browser/src/main/java/org/mozilla/samples/browser/CustomTabActivity.kt:7:1
        UndocumentedPublicClass - [CustomTabsService] at samples/browser/src/main/java/org/mozilla/samples/browser/customtabs/CustomTabsService.kt:11:1
        UndocumentedPublicClass - [ReaderViewIntegration] at samples/browser/src/main/java/org/mozilla/samples/browser/integration/ReaderViewIntegration.kt:21:1
        UndocumentedPublicClass - [FindInPageIntegration] at samples/browser/src/main/java/org/mozilla/samples/browser/integration/FindInPageIntegration.kt:15:1
        UndocumentedPublicClass - [SampleRequestInterceptor] at samples/browser/src/main/java/org/mozilla/samples/browser/request/SampleRequestInterceptor.kt:15:1
        UndocumentedPublicClass - [DefaultComponents] at samples/browser/src/main/java/org/mozilla/samples/browser/DefaultComponents.kt:39:1
        UndocumentedPublicClass - [IntentReceiverActivity] at samples/browser/src/main/java/org/mozilla/samples/browser/IntentReceiverActivity.kt:14:1
        UndocumentedPublicClass - [BrowserActivity] at samples/browser/src/main/java/org/mozilla/samples/browser/BrowserActivity.kt:21:1
        UndocumentedPublicClass - [BrowserFragment] at samples/browser/src/main/java/org/mozilla/samples/browser/BrowserFragment.kt:42:1
        UndocumentedPublicClass - [SampleApplication] at samples/browser/src/main/java/org/mozilla/samples/browser/SampleApplication.kt:13:1
        UndocumentedPublicClass - [ToolbarConfiguration] at samples/toolbar/src/main/java/org/mozilla/samples/toolbar/SampleToolbarHelpers.kt:21:1
        UndocumentedPublicClass - [ConfigurationAdapter] at samples/toolbar/src/main/java/org/mozilla/samples/toolbar/SampleToolbarHelpers.kt:30:1
        UndocumentedPublicClass - [ConfigurationViewHolder] at samples/toolbar/src/main/java/org/mozilla/samples/toolbar/SampleToolbarHelpers.kt:59:1
        UndocumentedPublicClass - [Extra] at samples/toolbar/src/main/java/org/mozilla/samples/toolbar/SampleToolbarHelpers.kt:73:1
        UndocumentedPublicClass - [LoginFragment] at samples/sync-logins/src/main/java/org/mozilla/samples/sync/logins/LoginFragment.kt:20:1
        UndocumentedPublicClass - [OnLoginCompleteListener] at samples/sync-logins/src/main/java/org/mozilla/samples/sync/logins/LoginFragment.kt:91:5
        UndocumentedPublicClass - [MainActivity] at samples/sync-logins/src/main/java/org/mozilla/samples/sync/logins/MainActivity.kt:40:1
        UndocumentedPublicClass - [GleanApplication] at samples/glean/src/main/java/org/mozilla/samples/glean/GleanApplication.kt:17:1
        UndocumentedPublicClass - [MainActivity] at samples/glean/src/main/java/org/mozilla/samples/glean/MainActivity.kt:15:1
        UndocumentedPublicClass - [LoginFragment] at samples/firefox-accounts/src/main/java/org/mozilla/samples/fxa/LoginFragment.kt:20:1
        UndocumentedPublicClass - [OnLoginCompleteListener] at samples/firefox-accounts/src/main/java/org/mozilla/samples/fxa/LoginFragment.kt:91:5
        UndocumentedPublicClass - [MainActivity] at samples/firefox-accounts/src/main/java/org/mozilla/samples/fxa/MainActivity.kt:30:1
        UndocumentedPublicClass - [MainActivity] at samples/dataprotect/src/main/java/org/mozilla/samples/dataprotect/MainActivity.kt:21:1
        UndocumentedPublicClass - [Constants] at samples/dataprotect/src/main/java/org/mozilla/samples/dataprotect/Constants.kt:9:1
        UndocumentedPublicClass - [ProtectedDataAdapter] at samples/dataprotect/src/main/java/org/mozilla/samples/dataprotect/ProtectedDataAdapter.kt:18:1
        UndocumentedPublicClass - [Holder] at samples/dataprotect/src/main/java/org/mozilla/samples/dataprotect/ProtectedDataAdapter.kt:52:5

@dector
Copy link
Contributor

dector commented Sep 22, 2019

@pocmo Can we enable this rule now and include tech dept into the baseline file?

@pocmo
Copy link
Contributor Author

pocmo commented Sep 23, 2019

OK 👍

dector added a commit to dector/android-components that referenced this issue Sep 23, 2019
@dector
For mozilla-mobile#76, mozilla-mobile#77. Enable `UndocumentedPublic*…
74d4364 
…` detekt rules.

Update detekt baseline.
@dector
Copy link
Contributor

dector commented Sep 23, 2019

Enabled rule and updated baseline file. I guess issue title can be updated.

dector added a commit to dector/android-components that referenced this issue Sep 24, 2019
@dector
For mozilla-mobile#76, mozilla-mobile#77. Enable `UndocumentedPublic*…
f184553 
…` detekt rules.

Update detekt baseline.
bors bot pushed a commit that referenced this issue Sep 24, 2019
@MozLando @dector
Merge #4509
a5515d0 
4509: For #76, #77. Enable `UndocumentedPublic*` detekt rules. r=pocmo a=dector



Co-authored-by: Denys M <dector9@gmail.com>
dector added a commit to dector/android-components that referenced this issue Sep 24, 2019
@dector
For mozilla-mobile#76, mozilla-mobile#77. Enable `UndocumentedPublic*…
f82a69d 
…` detekt rules.

Update detekt baseline.
bors bot pushed a commit that referenced this issue Sep 24, 2019
@MozLando @dector @MickeyMoz
Merge #4509 #4515 #4516
e43f5e8 
4509: For #76, #77. Enable `UndocumentedPublic*` detekt rules. r=pocmo a=dector



4515:  Public Suffix List update (20190924-141825) r=pocmo a=MickeyMoz



4516:  GeckoView update (nightly) (20190924-141822) r=pocmo a=MickeyMoz



Co-authored-by: Denys M <dector9@gmail.com>
Co-authored-by: MickeyMoz <sebastian@mozilla.com>
@pocmo pocmo added this to the 15.0.0 milestone Sep 26, 2019
@pocmo pocmo closed this as completed Sep 26, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
⌨️ code Technical debt, code clean up, small API change .. help wanted Extra attention is needed
Projects
None yet
Milestone
⛑ 15.0.0
Development

No branches or pull requests
2 participants
@pocmo @dector