Add example of how to use ComponentRenderer to JavaDoc

diff --git a/server/src/main/java/com/vaadin/ui/renderers/ComponentRenderer.java b/server/src/main/java/com/vaadin/ui/renderers/ComponentRenderer.java
index 1053907723343134c37d2f350bf7f73544e0759f..f5dd507cffa7f0549383c9e6a96f0f5d945bb3d0 100644 (file)
--- a/server/src/main/java/com/vaadin/ui/renderers/ComponentRenderer.java
+++ b/server/src/main/java/com/vaadin/ui/renderers/ComponentRenderer.java
@@ -17,6 +17,8 @@ package com.vaadin.ui.renderers;
 
 import com.vaadin.shared.ui.grid.renderers.ComponentRendererState;
 import com.vaadin.ui.Component;
+import com.vaadin.ui.Grid;
+import com.vaadin.ui.Label;
 
 import elemental.json.Json;
 import elemental.json.JsonValue;
@@ -34,10 +36,18 @@ import elemental.json.JsonValue;
  * runtime e.g. when selection changes. If your component has an internal state
  * that is not stored into the object, you should reuse the same component
  * instances.
+ * <p>
+ * Example of how to add a {@link Label} component to {@link Grid}:
+ * <pre>
+ * Grid<Person> grid;
+ * grid.addColumn(person -> new Label(person.getFullName()), 
+ *     new ComponentRenderer()).setCaption("Full Name");
+ * </pre>
  *
  * @author Vaadin Ltd
  * @since 8.1
  */
+@SuppressWarnings("serial")
 public class ComponentRenderer extends AbstractRenderer<Object, Component> {
 
     /**