From: Leif Åstrand <leif@vaadin.com>
Date: Mon, 25 Jun 2012 13:34:38 +0000 (+0300)
Subject: Add some missing Javadoc to Page (#8907)
X-Git-Tag: 7.0.0.alpha3~63
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=70860295139996966bb077f7df694102083da131;p=vaadin-framework.git

Add some missing Javadoc to Page (#8907)
---

diff --git a/src/com/vaadin/terminal/Page.java b/src/com/vaadin/terminal/Page.java
index e6d06a837a..8ccb243a1e 100644
--- a/src/com/vaadin/terminal/Page.java
+++ b/src/com/vaadin/terminal/Page.java
@@ -614,6 +614,16 @@ public class Page implements Serializable {
         addNotification(notification);
     }
 
+    /**
+     * Gets the Page to which the current root belongs. This is automatically
+     * defined when processing requests to the server. In other cases, (e.g.
+     * from background threads), the current root is not automatically defined.
+     * 
+     * @see Root#getCurrent()
+     * 
+     * @return the current page instance if available, otherwise
+     *         <code>null</code>
+     */
     public static Page getCurrent() {
         Root currentRoot = Root.getCurrent();
         if (currentRoot == null) {
@@ -622,6 +632,13 @@ public class Page implements Serializable {
         return currentRoot.getPage();
     }
 
+    /**
+     * Sets the page title. The page title is displayed by the browser e.g. as
+     * the title of the browser window or as the title of the tab.
+     * 
+     * @param title
+     *            the new page title to set
+     */
     public void setTitle(String title) {
         root.getRpcProxy(PageClientRpc.class).setTitle(title);
     }