From: Artur Signell <artur@vaadin.com>
Date: Thu, 28 Jun 2012 07:24:48 +0000 (+0300)
Subject: Updated javadoc
X-Git-Tag: 7.0.0.alpha3~48
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=23bafe0cf09918bc2c80455de1607be0035ee250;p=vaadin-framework.git

Updated javadoc
---

diff --git a/src/com/vaadin/terminal/gwt/client/ui/label/ContentMode.java b/src/com/vaadin/terminal/gwt/client/ui/label/ContentMode.java
index 4892c7e6bd..5e621681c3 100644
--- a/src/com/vaadin/terminal/gwt/client/ui/label/ContentMode.java
+++ b/src/com/vaadin/terminal/gwt/client/ui/label/ContentMode.java
@@ -10,38 +10,36 @@ package com.vaadin.terminal.gwt.client.ui.label;
  */
 public enum ContentMode {
     /**
-     * Content mode, where the label contains only plain text. The getValue()
-     * result is coded to XML when painting.
+     * Content mode, where the label contains only plain text.
      */
     TEXT,
 
     /**
-     * Content mode, where the label contains preformatted text.
+     * Content mode, where the label contains pre formatted text. In this mode
+     * newlines are preserved when rendered on the screen.
      */
     PREFORMATTED,
 
     /**
-     * Content mode, where the label contains XHTML.
+     * Content mode, where the label contains XHTML. Care should be taken to
+     * ensure
      */
     XHTML,
 
     /**
      * Content mode, where the label contains well-formed or well-balanced XML.
-     * Each of the root elements must have their default namespace specified.
+     * This is handled in the same way as {@link #XHTML}.
      * 
-     * @deprecated Use {@link #XHTML}
+     * @deprecated Use {@link #XHTML} instead
      */
     @Deprecated
     XML,
 
     /**
-     * Content mode, where the label contains RAW output. Output is not required
-     * to comply to with XML. In Web Adapter output is inserted inside the
-     * resulting HTML document as-is. This is useful for some specific purposes
-     * where possibly broken HTML content needs to be shown, but in most cases
-     * XHTML mode should be preferred.
+     * Legacy content mode, where the label contains RAW output. This is handled
+     * in exactly the same way as {@link #XHTML}.
      * 
-     * @deprecated Use {@link #XHTML}, {@link #TEXT} or {@link #PREFORMATTED}.
+     * @deprecated Use {@link #XHTML} instead
      */
     @Deprecated
     RAW;
diff --git a/src/com/vaadin/ui/Label.java b/src/com/vaadin/ui/Label.java
index e1c64605d7..e98da384cf 100644
--- a/src/com/vaadin/ui/Label.java
+++ b/src/com/vaadin/ui/Label.java
@@ -142,10 +142,13 @@ public class Label extends AbstractComponent implements Property<String>,
     }
 
     /**
-     * Gets the value of the label. Value of the label is the XML contents of
-     * the label.
+     * Gets the value of the label.
+     * <p>
+     * The value of the label is the text that is shown to the end user.
+     * Depending on the {@link ContentMode} it is plain text or markup.
+     * </p>
      * 
-     * @return the Value of the label.
+     * @return the value of the label.
      */
     public String getValue() {
         if (getPropertyDataSource() == null) {
@@ -180,8 +183,7 @@ public class Label extends AbstractComponent implements Property<String>,
 
     /**
      * @see java.lang.Object#toString()
-     * @deprecated use the data source value or {@link #getStringValue()}
-     *             instead
+     * @deprecated Use {@link #getValue()} instead
      */
     @Deprecated
     @Override