From 0596c18fb96b0be263468d61a9e4b84933b31fc6 Mon Sep 17 00:00:00 2001
From: Steffen Schaefer <steffen.schaefer@sap.com>
Date: Mon, 20 Jun 2016 17:52:01 +0200
Subject: [PATCH] Added JavaDocs to SwitchingEntryPoint

---
 .../sailing/gwt/home/shared/SwitchingEntryPoint.java  | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/home/shared/SwitchingEntryPoint.java b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/home/shared/SwitchingEntryPoint.java
index 5de6daf8c97..f58518d477f 100644
--- a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/home/shared/SwitchingEntryPoint.java
+++ b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/home/shared/SwitchingEntryPoint.java
@@ -29,6 +29,17 @@ import com.sap.sailing.gwt.home.shared.app.ApplicationPlaceUpdater;
 import com.sap.sailing.gwt.home.shared.app.HasMobileVersion;
 import com.sap.sailing.gwt.home.shared.app.MobileSupport;
 
+/**
+ * Wrapper EntryPoint for the Home module that decides if the desktop or mobile page will be shown and internally starts
+ * the respective EntryPoint.
+ * 
+ * The decision is made on the following aspects:
+ * <ul>
+ *   <li>the type of device (desktop, phone, table)</li>
+ *   <li>the place to be shown and if the place is available for one or the other form factor</li>
+ *   <li>the user preference that is being triggered by the user clicking "desktop version" or "mobile version" links in the page footer</li>
+ * </ul>
+ */
 public class SwitchingEntryPoint implements EntryPoint {
     private static Logger LOG = Logger.getLogger(SwitchingEntryPoint.class.getName());
     private static final String SAPSAILING_MOBILE = "sapsailing_mobile";