diff --git a/CHANGELOG.md b/CHANGELOG.md index 7791b050..bd199fd5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -26,6 +26,9 @@ Dropping a requirement of a major version of a dependency is a new contract. ## [Unreleased] [Unreleased]: https://github.com/atlassian/infrastructure/compare/release-4.14.5...master +### Added +- `com.atlassian.performance.tools.infrastructure.api.browser.Browser` KDocs. + ## [4.14.5] - 2020-03-03 [4.14.5]: https://github.com/atlassian/infrastructure/compare/release-4.14.4...release-4.14.5 diff --git a/src/main/kotlin/com/atlassian/performance/tools/infrastructure/api/browser/Browser.kt b/src/main/kotlin/com/atlassian/performance/tools/infrastructure/api/browser/Browser.kt index 2fb0717d..5d42a0fa 100644 --- a/src/main/kotlin/com/atlassian/performance/tools/infrastructure/api/browser/Browser.kt +++ b/src/main/kotlin/com/atlassian/performance/tools/infrastructure/api/browser/Browser.kt @@ -2,6 +2,15 @@ package com.atlassian.performance.tools.infrastructure.api.browser import com.atlassian.performance.tools.ssh.api.SshConnection +/** + * Installs browser and WebDriver. See [Chrome] or [com.atlassian.performance.tools.infrastructure.api.browser.chromium.Chromium69]. + * Browser must provide public no-args constructor. + */ interface Browser { + /** + * Installs browser and WebDriver. + * + * @param ssh ssh connection to ubuntu based machine. + */ fun install(ssh: SshConnection) } \ No newline at end of file