Bug 4228: Added more JavaDocs

java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/common/authentication/FixedSailingLoginHintPopup.java

@@ -3,6 +3,9 @@ package com.sap.sailing.gwt.common.authentication;
 import com.sap.sse.security.ui.authentication.AuthenticationManager;
 import com.sap.sse.security.ui.authentication.generic.sapheader.FixedLoginHintPopup;
 
+/**
+ * Sailing specific version of {@link FixedLoginHintPopup}.
+ */
 public class FixedSailingLoginHintPopup extends FixedLoginHintPopup {
 
     public FixedSailingLoginHintPopup(AuthenticationManager authenticationManager) {

java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/home/desktop/app/DesktopLoginHintPopup.java

@@ -5,6 +5,9 @@ import com.sap.sse.security.ui.authentication.UserManagementResources;
 import com.sap.sse.security.ui.authentication.UserManagementResources.LocalCss;
 import com.sap.sse.security.ui.authentication.login.LoginHintPopup;
 
+/**
+ * Specific version of {@link LoginHintPopup} that meets the positioning of the page header in Home.html.
+ */
 public class DesktopLoginHintPopup extends LoginHintPopup {
     private static final LocalCss LOCAL_CSS = UserManagementResources.INSTANCE.css();
 

java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/home/desktop/places/morelogininformation/MoreLoginInformation.java

@@ -5,6 +5,9 @@ import com.google.gwt.uibinder.client.UiBinder;
 import com.google.gwt.user.client.ui.Composite;
 import com.google.gwt.user.client.ui.Widget;
 
+/**
+ * Desktop page that shows the benefits of logging in on sapsailing.com.
+ */
 public class MoreLoginInformation extends Composite {
 
     private static MoreLoginInformationUiBinder uiBinder = GWT.create(MoreLoginInformationUiBinder.class);

java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/home/mobile/places/morelogininformation/MoreLoginInformationMobile.java

@@ -5,6 +5,9 @@ import com.google.gwt.uibinder.client.UiBinder;
 import com.google.gwt.user.client.ui.Composite;
 import com.google.gwt.user.client.ui.Widget;
 
+/**
+ * Mobile page that shows the benefits of logging in on sapsailing.com.
+ */
 public class MoreLoginInformationMobile extends Composite {
 
     private static MoreLoginInformationUiBinder uiBinder = GWT.create(MoreLoginInformationUiBinder.class);

java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/home/shared/places/morelogininformation/MoreLoginInformationPlace.java

@@ -6,6 +6,9 @@ import com.google.gwt.place.shared.Prefix;
 import com.sap.sailing.gwt.home.shared.app.HasMobileVersion;
 import com.sap.sailing.gwt.home.shared.places.PlaceTokenPrefixes;
 
+/**
+ * Place that leads users to a page showing the benefits of logging in on sapsailing.com.
+ */
 public class MoreLoginInformationPlace extends Place implements HasMobileVersion {
     @Prefix(PlaceTokenPrefixes.AboutAccount)
     public static class Tokenizer implements PlaceTokenizer<MoreLoginInformationPlace> {

java/com.sap.sse.security.ui/src/main/java/com/sap/sse/security/ui/authentication/generic/sapheader/FixedLoginHintPopup.java

@@ -3,6 +3,10 @@ package com.sap.sse.security.ui.authentication.generic.sapheader;
 import com.sap.sse.security.ui.authentication.AuthenticationManager;
 import com.sap.sse.security.ui.authentication.generic.GenericAuthenticationLinkFactory;
 
+/**
+ * Specific version of {@link GenericLoginHintPopup} to be used on pages uses a fixed header that sticks on the top of
+ * the viewport.
+ */
 public class FixedLoginHintPopup extends GenericLoginHintPopup {
 
     public FixedLoginHintPopup(AuthenticationManager authenticationManager, GenericAuthenticationLinkFactory linkFactory) {

java/com.sap.sse.security.ui/src/main/java/com/sap/sse/security/ui/authentication/generic/sapheader/GenericLoginHintPopup.java

@@ -2,9 +2,13 @@ package com.sap.sse.security.ui.authentication.generic.sapheader;
 
 import com.google.gwt.user.client.Window;
 import com.sap.sse.security.ui.authentication.AuthenticationManager;
+import com.sap.sse.security.ui.authentication.generic.GenericAuthentication;
 import com.sap.sse.security.ui.authentication.generic.GenericAuthenticationLinkFactory;
 import com.sap.sse.security.ui.authentication.login.LoginHintPopup;
 
+/**
+ * Extended version of {@link LoginHintPopup} to be used with {@link GenericAuthentication}.
+ */
 public class GenericLoginHintPopup extends LoginHintPopup {
 
     public GenericLoginHintPopup(AuthenticationManager authenticationManager, GenericAuthenticationLinkFactory linkFactory) {

java/com.sap.sse.security.ui/src/main/java/com/sap/sse/security/ui/authentication/login/LoginHintContent.java

@@ -9,6 +9,16 @@ import com.google.gwt.user.client.ui.Anchor;
 import com.google.gwt.user.client.ui.Composite;
 import com.google.gwt.user.client.ui.Widget;
 
+/**
+ * Widget that shows a message to inform the user that it has benefits to log in. There are two links the user can
+ * press:
+ * <ul>
+ * <li>"Dismiss" to hide the message. This will typically make the message disappear for some time.</li>
+ * <li>"Show details" to show a page providing some information about the benefits of creating an account.</li>
+ * </ul>
+ * the concrete actions to be triggered when clicking the links need to be defined by the using context through the
+ * {@link Runnable Runnables} given to the constructor.
+ */
 public class LoginHintContent extends Composite{
 
     private static LoginPopupContentUiBinder uiBinder = GWT.create(LoginPopupContentUiBinder.class);

java/com.sap.sse.security.ui/src/main/java/com/sap/sse/security/ui/authentication/login/LoginHintPopup.java

@@ -6,6 +6,9 @@ import com.sap.sse.security.ui.authentication.AuthenticationManager;
 import com.sap.sse.security.ui.authentication.UserManagementResources;
 import com.sap.sse.security.ui.authentication.UserManagementResources.LocalCss;
 
+/**
+ * Popup that appears when an unauthenticated user visits the page to inform about the benefits of logging in.
+ */
 public class LoginHintPopup extends PopupPanel {
     private static final LocalCss LOCAL_CSS = UserManagementResources.INSTANCE.css();
     protected final LoginHintContent content;