summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHenri Sara <hesara@vaadin.com>2014-07-02 09:39:09 +0300
committerLeif Åstrand <leif@vaadin.com>2014-07-03 06:50:15 +0000
commitff8efe1b94b077c24085962db733fbb26f213484 (patch)
tree3586dc6753441dd97e44a6ca1f9b62c82d84be64
parentb258e2b7dd6ae0948ab14c3a2776bc4a8429ea97 (diff)
downloadvaadin-framework-ff8efe1b94b077c24085962db733fbb26f213484.tar.gz
vaadin-framework-ff8efe1b94b077c24085962db733fbb26f213484.zip
Add missing @since 7.3 to javadoc
Change-Id: I62610ef647fbbb5a7cfae25ac5c7628f78f2c6ff
-rw-r--r--client-compiler/src/com/vaadin/tools/CvalAddonsChecker.java6
-rw-r--r--client-compiler/src/com/vaadin/tools/CvalChecker.java12
-rw-r--r--client/src/com/vaadin/client/AnimationUtil.java1
-rw-r--r--client/src/com/vaadin/client/ResourceLoader.java2
-rw-r--r--client/src/com/vaadin/client/communication/TranslatedURLReference.java4
-rw-r--r--client/src/com/vaadin/client/ui/VOverlay.java6
-rw-r--r--client/src/com/vaadin/client/ui/ui/UIConnector.java42
-rw-r--r--server/src/com/vaadin/server/DefaultDeploymentConfiguration.java2
-rw-r--r--server/src/com/vaadin/server/DeploymentConfiguration.java2
-rw-r--r--server/src/com/vaadin/server/VaadinPortletRequest.java4
-rw-r--r--server/src/com/vaadin/ui/UI.java2
-rw-r--r--server/src/com/vaadin/ui/themes/ValoTheme.java2
-rw-r--r--shared/src/com/vaadin/shared/ui/ui/UIState.java5
13 files changed, 56 insertions, 34 deletions
diff --git a/client-compiler/src/com/vaadin/tools/CvalAddonsChecker.java b/client-compiler/src/com/vaadin/tools/CvalAddonsChecker.java
index 6780b1bc75..aab7231258 100644
--- a/client-compiler/src/com/vaadin/tools/CvalAddonsChecker.java
+++ b/client-compiler/src/com/vaadin/tools/CvalAddonsChecker.java
@@ -50,6 +50,8 @@ import com.vaadin.tools.CvalChecker.UnreachableCvalServerException;
* </ul>
*
* The class also have a method to check just one product.
+ *
+ * @since 7.3
*/
public final class CvalAddonsChecker {
@@ -77,7 +79,7 @@ public final class CvalAddonsChecker {
/**
* Visit all MANIFEST.MF files in the classpath validating licenses.
- *
+ *
* Return a list of Cval licensed products in order to have enough info to
* generate nag messages in the UI.
*/
@@ -149,7 +151,7 @@ public final class CvalAddonsChecker {
/**
* Set the filter regexp of .jar names which we have to consider.
- *
+ *
* default is '.*touchkit.*'
*/
public CvalAddonsChecker setFilter(String regexp) {
diff --git a/client-compiler/src/com/vaadin/tools/CvalChecker.java b/client-compiler/src/com/vaadin/tools/CvalChecker.java
index 5ad44a70f8..2de7e10faa 100644
--- a/client-compiler/src/com/vaadin/tools/CvalChecker.java
+++ b/client-compiler/src/com/vaadin/tools/CvalChecker.java
@@ -36,19 +36,21 @@ import org.json.JSONObject;
/**
* This class is able to validate the vaadin CVAL license.
- *
+ *
* It reads the developer license file and asks the server to validate the
* licenseKey. If the license is invalid it throws an exception with the
* information about the problem and the server response.
+ *
+ * @since 7.3
*/
public final class CvalChecker {
/*
* Class used for binding the JSON gotten from server.
- *
+ *
* It is not in a separate f le, so as it is easier to copy into any product
* which does not depend on vaadin core.
- *
+ *
* We are using org.json in order not to use additional dependency like
* auto-beans, gson, etc.
*/
@@ -301,7 +303,7 @@ public final class CvalChecker {
/**
* Given a product name returns the name of the file with the license key.
- *
+ *
* Traditionally we have delivered license keys with a name like
* 'vaadin.touchkit.developer.license' but our database product name is
* 'vaadin-touchkit' so we have to replace '-' by '.' to maintain
@@ -342,7 +344,7 @@ public final class CvalChecker {
/**
* Validate whether there is a valid license key for a product.
- *
+ *
* @param productName
* for example vaadin-touchkit
* @param productVersion
diff --git a/client/src/com/vaadin/client/AnimationUtil.java b/client/src/com/vaadin/client/AnimationUtil.java
index 2077cee3c0..063a0a163e 100644
--- a/client/src/com/vaadin/client/AnimationUtil.java
+++ b/client/src/com/vaadin/client/AnimationUtil.java
@@ -24,6 +24,7 @@ import com.google.gwt.dom.client.Style;
* Utility methods for working with CSS transitions and animations.
*
* @author Vaadin Ltd
+ * @since 7.3
*/
public class AnimationUtil {
diff --git a/client/src/com/vaadin/client/ResourceLoader.java b/client/src/com/vaadin/client/ResourceLoader.java
index e97605a7c6..ceede263fc 100644
--- a/client/src/com/vaadin/client/ResourceLoader.java
+++ b/client/src/com/vaadin/client/ResourceLoader.java
@@ -380,7 +380,7 @@ public class ResourceLoader {
* script tag. The listener is called whenever loading is complete or an
* error occurred.
*
- * @since
+ * @since 7.3
* @param element
* the element to attach a listener to
* @param listener
diff --git a/client/src/com/vaadin/client/communication/TranslatedURLReference.java b/client/src/com/vaadin/client/communication/TranslatedURLReference.java
index c863b7b796..10cfc241cd 100644
--- a/client/src/com/vaadin/client/communication/TranslatedURLReference.java
+++ b/client/src/com/vaadin/client/communication/TranslatedURLReference.java
@@ -18,6 +18,10 @@ package com.vaadin.client.communication;
import com.vaadin.client.ApplicationConnection;
import com.vaadin.shared.communication.URLReference;
+/**
+ * @since 7.3
+ * @author Vaadin Ltd
+ */
public class TranslatedURLReference extends URLReference {
private ApplicationConnection connection;
diff --git a/client/src/com/vaadin/client/ui/VOverlay.java b/client/src/com/vaadin/client/ui/VOverlay.java
index a4f62775e1..ae2faee238 100644
--- a/client/src/com/vaadin/client/ui/VOverlay.java
+++ b/client/src/com/vaadin/client/ui/VOverlay.java
@@ -164,7 +164,13 @@ public class VOverlay extends PopupPanel implements CloseHandler<PopupPanel> {
*/
public static final String CLASSNAME_CONTAINER = "v-overlay-container";
+ /**
+ * @since 7.3
+ */
public static final String ADDITIONAL_CLASSNAME_ANIMATE_IN = "animate-in";
+ /**
+ * @since 7.3
+ */
public static final String ADDITIONAL_CLASSNAME_ANIMATE_OUT = "animate-out";
/**
diff --git a/client/src/com/vaadin/client/ui/ui/UIConnector.java b/client/src/com/vaadin/client/ui/ui/UIConnector.java
index 8997509da6..691b8b2f0b 100644
--- a/client/src/com/vaadin/client/ui/ui/UIConnector.java
+++ b/client/src/com/vaadin/client/ui/ui/UIConnector.java
@@ -403,7 +403,7 @@ public class UIConnector extends AbstractSingleComponentContainerConnector
/**
* Reads CSS strings and resources injected by {@link Styles#inject} from
* the UIDL stream.
- *
+ *
* @param uidl
* The uidl which contains "css-resource" and "css-string" tags
*/
@@ -439,8 +439,8 @@ public class UIConnector extends AbstractSingleComponentContainerConnector
/**
* Internal helper to get the <head> tag of the page
- *
- * @since
+ *
+ * @since 7.3
* @return the head element
*/
private HeadElement getHead() {
@@ -450,8 +450,8 @@ public class UIConnector extends AbstractSingleComponentContainerConnector
/**
* Internal helper for removing any stylesheet with the given URL
- *
- * @since
+ *
+ * @since 7.3
* @param url
* the url to match with existing stylesheets
*/
@@ -581,7 +581,7 @@ public class UIConnector extends AbstractSingleComponentContainerConnector
/**
* Checks if the given sub window is a child of this UI Connector
- *
+ *
* @deprecated Should be replaced by a more generic mechanism for getting
* non-ComponentConnector children
* @param wc
@@ -595,7 +595,7 @@ public class UIConnector extends AbstractSingleComponentContainerConnector
/**
* Return an iterator for current subwindows. This method is meant for
* testing purposes only.
- *
+ *
* @return
*/
public List<WindowConnector> getSubWindows() {
@@ -622,7 +622,7 @@ public class UIConnector extends AbstractSingleComponentContainerConnector
* public API instead of their state object directly. The page state might
* not be an independent state object but can be embedded in UI state.
* </p>
- *
+ *
* @since 7.1
* @return state object of the page
*/
@@ -686,10 +686,10 @@ public class UIConnector extends AbstractSingleComponentContainerConnector
/**
* Tries to scroll the viewport so that the given connector is in view.
- *
+ *
* @param componentConnector
* The connector which should be visible
- *
+ *
*/
public void scrollIntoView(final ComponentConnector componentConnector) {
if (componentConnector == null) {
@@ -783,7 +783,7 @@ public class UIConnector extends AbstractSingleComponentContainerConnector
/**
* Invokes the layout analyzer on the server
- *
+ *
* @since 7.1
*/
public void analyzeLayouts() {
@@ -794,7 +794,7 @@ public class UIConnector extends AbstractSingleComponentContainerConnector
* Sends a request to the server to print details to console that will help
* the developer to locate the corresponding server-side connector in the
* source code.
- *
+ *
* @since 7.1
* @param serverConnector
* the connector to locate
@@ -822,7 +822,7 @@ public class UIConnector extends AbstractSingleComponentContainerConnector
/**
* Loads the new theme and removes references to the old theme
- *
+ *
* @param oldTheme
* The name of the old theme
* @param newTheme
@@ -875,7 +875,7 @@ public class UIConnector extends AbstractSingleComponentContainerConnector
/**
* Loads the given theme and replaces the given link element with the new
* theme link element.
- *
+ *
* @param newTheme
* The name of the new theme
* @param newThemeUrl
@@ -924,7 +924,7 @@ public class UIConnector extends AbstractSingleComponentContainerConnector
/**
* Activates the new theme. Assumes the theme has been loaded and taken into
* use in the browser.
- *
+ *
* @since 7.3
* @param newTheme
*/
@@ -945,9 +945,9 @@ public class UIConnector extends AbstractSingleComponentContainerConnector
/**
* Force a full recursive recheck of every connector's state variables.
- *
+ *
* @see #forceStateChange()
- *
+ *
* @since 7.3
*/
protected static void forceStateChangeRecursively(
@@ -968,8 +968,8 @@ public class UIConnector extends AbstractSingleComponentContainerConnector
/**
* Internal helper to get the theme URL for a given theme
- *
- * @since
+ *
+ * @since 7.3
* @param theme
* the name of the theme
* @return The URL the theme can be loaded from
@@ -982,8 +982,8 @@ public class UIConnector extends AbstractSingleComponentContainerConnector
/**
* Returns the name of the theme currently in used by the UI
- *
- * @since
+ *
+ * @since 7.3
* @return the theme name used by this UI
*/
public String getActiveTheme() {
diff --git a/server/src/com/vaadin/server/DefaultDeploymentConfiguration.java b/server/src/com/vaadin/server/DefaultDeploymentConfiguration.java
index 97790e7c0c..fd14c3cd3f 100644
--- a/server/src/com/vaadin/server/DefaultDeploymentConfiguration.java
+++ b/server/src/com/vaadin/server/DefaultDeploymentConfiguration.java
@@ -53,6 +53,8 @@ public class DefaultDeploymentConfiguration implements DeploymentConfiguration {
/**
* Default value for {@link #isSyncIdCheckEnabled()} = {@value} .
+ *
+ * @since 7.3
*/
public static final boolean DEFAULT_SYNC_ID_CHECK = true;
diff --git a/server/src/com/vaadin/server/DeploymentConfiguration.java b/server/src/com/vaadin/server/DeploymentConfiguration.java
index 50d84812ea..fcfeecc31f 100644
--- a/server/src/com/vaadin/server/DeploymentConfiguration.java
+++ b/server/src/com/vaadin/server/DeploymentConfiguration.java
@@ -89,7 +89,7 @@ public interface DeploymentConfiguration extends Serializable {
* gracefully handle situations when the client sends a message to a
* connector that has recently been removed on the server.
*
- * @since
+ * @since 7.3
* @return <code>true</code> if sync id checking is enabled;
* <code>false</code> otherwise
*/
diff --git a/server/src/com/vaadin/server/VaadinPortletRequest.java b/server/src/com/vaadin/server/VaadinPortletRequest.java
index e1b521d57f..93e06d7f45 100644
--- a/server/src/com/vaadin/server/VaadinPortletRequest.java
+++ b/server/src/com/vaadin/server/VaadinPortletRequest.java
@@ -247,7 +247,7 @@ public class VaadinPortletRequest extends PortletRequestWrapper implements
*
* @return the current portlet request instance if available, otherwise
* <code>null</code>
- *
+ * @since 7.3
*/
public static PortletRequest getCurrentPortletRequest() {
return VaadinPortletService.getCurrentPortletRequest();
@@ -262,7 +262,7 @@ public class VaadinPortletRequest extends PortletRequestWrapper implements
*
* @return the current Vaadin portlet request instance if available,
* otherwise <code>null</code>
- *
+ * @since 7.3
*/
public static VaadinPortletRequest getCurrent() {
return VaadinPortletService.getCurrentRequest();
diff --git a/server/src/com/vaadin/ui/UI.java b/server/src/com/vaadin/ui/UI.java
index 4bde8a95b3..6f27a13826 100644
--- a/server/src/com/vaadin/ui/UI.java
+++ b/server/src/com/vaadin/ui/UI.java
@@ -1152,7 +1152,7 @@ public abstract class UI extends AbstractSingleComponentContainer implements
* CSS file will be removed even if there are other UIs on the page which
* are still using it.
*
- * @since
+ * @since 7.3
* @param theme
* The new theme name
*/
diff --git a/server/src/com/vaadin/ui/themes/ValoTheme.java b/server/src/com/vaadin/ui/themes/ValoTheme.java
index 51e2e283f2..63fa13dce4 100644
--- a/server/src/com/vaadin/ui/themes/ValoTheme.java
+++ b/server/src/com/vaadin/ui/themes/ValoTheme.java
@@ -38,7 +38,7 @@ import com.vaadin.ui.Table.ColumnHeaderMode;
*
* TODO link to Sass API documentation
*
- * @since 7.3.0
+ * @since 7.3
* @author Vaadin Ltd
*/
public class ValoTheme {
diff --git a/shared/src/com/vaadin/shared/ui/ui/UIState.java b/shared/src/com/vaadin/shared/ui/ui/UIState.java
index abdc105ba7..2f51fef6ee 100644
--- a/shared/src/com/vaadin/shared/ui/ui/UIState.java
+++ b/shared/src/com/vaadin/shared/ui/ui/UIState.java
@@ -62,6 +62,11 @@ public class UIState extends TabIndexState {
* Configuration for the push channel
*/
public PushConfigurationState pushConfiguration = new PushConfigurationState();
+ /**
+ * Currently used theme.
+ *
+ * @since 7.3
+ */
public String theme;
{
primaryStyleName = "v-ui";