summaryrefslogtreecommitdiffstats
path: root/server/src/com/vaadin/package.html
diff options
context:
space:
mode:
Diffstat (limited to 'server/src/com/vaadin/package.html')
-rw-r--r--server/src/com/vaadin/package.html27
1 files changed, 27 insertions, 0 deletions
diff --git a/server/src/com/vaadin/package.html b/server/src/com/vaadin/package.html
new file mode 100644
index 0000000000..f771019709
--- /dev/null
+++ b/server/src/com/vaadin/package.html
@@ -0,0 +1,27 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+</head>
+
+<body bgcolor="white">
+
+<p>The Vaadin base package. Contains the Application class, the
+starting point of any application that uses Vaadin.</p>
+
+<p>Contains all Vaadin core classes. A Vaadin application is based
+on the {@link com.vaadin.Application} class and deployed as a servlet
+using {@link com.vaadin.terminal.gwt.server.ApplicationServlet} or
+{@link com.vaadin.terminal.gwt.server.GAEApplicationServlet} (for Google
+App Engine).</p>
+
+<p>Vaadin applications can also be deployed as portlets using {@link
+com.vaadin.terminal.gwt.server.ApplicationPortlet} (JSR-168) or {@link
+com.vaadin.terminal.gwt.server.ApplicationPortlet2} (JSR-286).</p>
+
+<p>All classes in Vaadin are serializable unless otherwise noted.
+This allows Vaadin applications to run in cluster and cloud
+environments.</p>
+
+
+</body>
+</html>