diff options
author | Artur Signell <artur.signell@itmill.com> | 2010-05-10 14:58:27 +0000 |
---|---|---|
committer | Artur Signell <artur.signell@itmill.com> | 2010-05-10 14:58:27 +0000 |
commit | 39f7583a4937f921b762fbd78effe7ded96534ed (patch) | |
tree | b909d6ebceb66898e47172a30ea09aa53e96e373 /src/com/vaadin/package.html | |
parent | 5b5b4970584df91f136ef5c198ba2d42113deee3 (diff) | |
download | vaadin-framework-39f7583a4937f921b762fbd78effe7ded96534ed.tar.gz vaadin-framework-39f7583a4937f921b762fbd78effe7ded96534ed.zip |
Updated package javadoc for #4248
svn changeset:13122/svn branch:6.4
Diffstat (limited to 'src/com/vaadin/package.html')
-rw-r--r-- | src/com/vaadin/package.html | 39 |
1 files changed, 14 insertions, 25 deletions
diff --git a/src/com/vaadin/package.html b/src/com/vaadin/package.html index 5a2defa80b..6142fcb8de 100644 --- a/src/com/vaadin/package.html +++ b/src/com/vaadin/package.html @@ -5,34 +5,23 @@ <body bgcolor="white"> -<p>This package is the base of Vaadin. The base package -contains the Application class, the starting point of any aplication that uses Vaadin. -The sub-packages from this point contain application components and utilities. -</p> +<p>The Vaadin base package. Contains the Application class, the +starting point of any application that uses Vaadin.</p> -<h2>Package Specification</h2> +<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> - <b>Vaadin is composed of the following packages:</b> - <dl> - <dt>com.vaadin.data</dt> - <dd>A library of interfaces for transparently binding UI components to datasources.</dd> - <dt>com.vaadin.data.util</dt> - <dd>Basic implementations of data-intfaces and utidtties for working with data-bound components.</dd> - <dt>com.vaadin.data.validator</dt> - <dd>Classes providing data-validation for Properties.</dd> - <dt>com.vaadin.event</dt> - <dd>Interfaces defining how to send and recieve events.</dd> - <dt>com.vaadin.service</dt> - <dd>Classes provding miscelaneous utidtty services.</dd> - <dt>com.vaadin.terminal</dt> - <dd>Classes and interfaces for implementing the terminal specific adapters.</dd> - <dt>com.vaadin.terminal.web</dt> - <dd>Classes that implement support both for AJAX-based and more limited web browsers.</dd> - <dt>com.vaadin.ui</dt> - <dd>UI components.</dd> - </dl> +<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> -<!-- Put @see and @since tags down here. --> </body> </html> |