Skip to content

Commit 55937ea

Browse files
committed
Add javadoc
1 parent 8c33ae3 commit 55937ea

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

src/main/java/com/assertthat/selenium_shutterbug/core/Snapshot.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,8 @@ public T withThumbnail(String path, String name, double scale) {
8585
* @param path to save thumbnail image to
8686
* @param name of the resulting image
8787
* @param scale to apply
88+
* @param cropWidth e.g. 0.2 will leave 20% of the initial width
89+
* @param cropHeight e.g. 0.1 will leave 10% of the initial width
8890
* @return instance of type Snapshot
8991
*/
9092
public T withCroppedThumbnail(String path, String name, double scale, double cropWidth, double cropHeight) {
@@ -102,6 +104,8 @@ public T withCroppedThumbnail(String path, String name, double scale, double cr
102104
* Will save different thumbnails depends on when it was called in the chain.
103105
*
104106
* @param scale to apply
107+
* @param cropWidth e.g. 0.2 will leave 20% of the initial width
108+
* @param cropHeight e.g. 0.1 will leave 10% of the initial width
105109
* @return instance of type Snapshot
106110
*/
107111
public T withCroppedThumbnail(double scale, double cropWidth, double cropHeight) {

src/main/java/com/assertthat/selenium_shutterbug/utils/web/Browser.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,9 @@ public BufferedImage takeScreenshot() {
9696

9797
/**Using different screenshot strategy dependently on driver:
9898
* for chrome - chrome command will be used
99-
* for others - their default screenshot methods*/
99+
* for others - their default screenshot methods
100+
* @return BufferedImage resulting image
101+
* */
100102
public BufferedImage takeScreenshotEntirePage() {
101103
if (driver instanceof EventFiringWebDriver) {
102104
driver = ((EventFiringWebDriver) this.driver).getWrappedDriver();

0 commit comments

Comments
 (0)