[jspwiki] 10/23: added javadocs

[ju...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

juanpablo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jspwiki.git

commit 7a7d1d341a34f66b4b0c63780e0bfd150ef38d6b
Author: juanpablo <ju...@apache.org>
AuthorDate: Sat Nov 7 18:36:05 2020 +0100

    added javadocs
---
 .../java/org/apache/wiki/pages/haddock/LoginPage.java | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/LoginPage.java b/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/LoginPage.java
index c080dfd..f7d95da 100644
--- a/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/LoginPage.java
+++ b/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/LoginPage.java
@@ -22,12 +22,27 @@ import com.codeborne.selenide.Selenide;
 import org.apache.wiki.its.environment.Env;
 import org.openqa.selenium.By;
 
+/**
+ * Actions available on the Login page.
+ */
 public class LoginPage implements HaddockPage {
-    
+
+    /**
+     * Logs in using Janne username and password.
+     *
+     * @return {@link ReadWikiPage} instance, to allow chaining of actions.
+     */
     public ReadWikiPage performLogin() {
         return performLogin( Env.LOGIN_JANNE_USERNAME, Env.LOGIN_JANNE_PASSWORD );
     }
-    
+
+    /**
+     * Logs in using the supplied username and password.
+     *
+     * @param login user login.
+     * @param password user password.
+     * @return {@link ReadWikiPage} instance, to allow chaining of actions.
+     */
     public ReadWikiPage performLogin( final String login, final String password ) {
         Selenide.$( By.id( "j_username" ) ).val( login );
         Selenide.$( By.id( "j_password" ) ).val( password );