From: Teemu Suo-Anttila Date: Mon, 11 Apr 2016 16:11:34 +0000 (+0300) Subject: Add fail tolerant javadoc compilation to release profile X-Git-Tag: 7.7.0.alpha1~34 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=1ad07dfa1e615cf37057ba368e92e284dd75671c;p=vaadin-framework.git Add fail tolerant javadoc compilation to release profile Change-Id: Ie01ced69a0b07afc336817d2c5c1e69e2b7e118f --- diff --git a/pom.xml b/pom.xml index 1ca0a5bcca..f4f76ced02 100644 --- a/pom.xml +++ b/pom.xml @@ -241,6 +241,21 @@ + + maven-javadoc-plugin + 2.10.3 + + + generate-javadoc + + jar + + + false + + + + diff --git a/server/src/main/javadoc/com/vaadin/annotations/package.html b/server/src/main/javadoc/com/vaadin/annotations/package.html new file mode 100644 index 0000000000..d789e9b5df --- /dev/null +++ b/server/src/main/javadoc/com/vaadin/annotations/package.html @@ -0,0 +1,12 @@ + + + + + + + +

Contains annotations used in Vaadin. Note that some annotations +are also found in other packages e.g., {@link com.vaadin.ui.ClientWidget}.

+ + + diff --git a/server/src/main/javadoc/com/vaadin/data/package.html b/server/src/main/javadoc/com/vaadin/data/package.html new file mode 100644 index 0000000000..a14ea1ac88 --- /dev/null +++ b/server/src/main/javadoc/com/vaadin/data/package.html @@ -0,0 +1,49 @@ + + + + + + + +

Contains interfaces for the data layer, mainly for binding typed +data and data collections to components, and for validating data.

+ +

Data binding

+ +

The package contains a three-tiered structure for typed data +objects and collections of them:

+ + + +

For more information on the data model, see the Data model +chapter in Book of Vaadin.

+ +

Buffering

+ +

A {@link com.vaadin.data.Buffered Buffered} implementor is able +to track and buffer changes and commit or discard them later.

+ +

Validation

+ +

{@link com.vaadin.data.Validator Validator} implementations are +used to validate data, typically the value of a {@link +com.vaadin.ui.Field Field}. One or more {@link com.vaadin.data.Validator +Validators} can be added to a {@link com.vaadin.data.Validatable +Validatable} implementor and then used to validate the value of the +Validatable.

+ + + + diff --git a/server/src/main/javadoc/com/vaadin/data/util/package.html b/server/src/main/javadoc/com/vaadin/data/util/package.html new file mode 100644 index 0000000000..07e3acde9e --- /dev/null +++ b/server/src/main/javadoc/com/vaadin/data/util/package.html @@ -0,0 +1,18 @@ + + + + + + + + +

Provides implementations of Property, Item and Container +interfaces, and utilities for the data layer.

+ +

Various Property, Item and Container implementations are provided +in this package. Each implementation can have its own sets of +constraints on the data it encapsulates and on how the implementation +can be used. See the class javadocs for more information.

+ + + diff --git a/server/src/main/javadoc/com/vaadin/data/validator/package.html b/server/src/main/javadoc/com/vaadin/data/validator/package.html new file mode 100644 index 0000000000..c991bfc82a --- /dev/null +++ b/server/src/main/javadoc/com/vaadin/data/validator/package.html @@ -0,0 +1,23 @@ + + + + + + + + + + +

Provides various {@link com.vaadin.data.Validator} +implementations.

+ +

{@link com.vaadin.data.validator.AbstractValidator +AbstractValidator} provides an abstract implementation of the {@link +com.vaadin.data.Validator} interface and can be extended for custom +validation needs. {@link +com.vaadin.data.validator.AbstractStringValidator +AbstractStringValidator} can also be extended if the value is a String.

+ + + + diff --git a/server/src/main/javadoc/com/vaadin/event/package.html b/server/src/main/javadoc/com/vaadin/event/package.html new file mode 100644 index 0000000000..2e7e17b892 --- /dev/null +++ b/server/src/main/javadoc/com/vaadin/event/package.html @@ -0,0 +1,58 @@ + + + + + + + + + +

Provides classes and interfaces for the inheritable event +model. The model supports inheritable events and a flexible way of +registering and unregistering event listeners. It's a fundamental building +block of Vaadin, and as it is included in +{@link com.vaadin.ui.AbstractComponent}, all UI components +automatically support it.

+ +

Package Specification

+ +

The core of the event model is the inheritable event class +hierarchy, and the {@link com.vaadin.event.EventRouter EventRouter} +which provide a simple, ubiquitous mechanism to transport events to all +interested parties.

+ +

The power of the event inheritance arises from the possibility of +receiving not only the events of the registered type, but also the +ones which are inherited from it. For example, let's assume that there +are the events GeneralEvent and SpecializedEvent +so that the latter inherits the former. Furthermore we have an object +A which registers to receive GeneralEvent type +events from the object B. A would of course +receive all GeneralEvents generated by B, but in +addition to this, A would also receive all +SpecializedEvents generated by B. However, if +B generates some other events that do not have +GeneralEvent as an ancestor, A would not receive +them unless it registers to listen for them, too.

+ +

The interface to attaching and detaching listeners to and from an object +works with methods. One specifies the event that should trigger the listener, +the trigger method that should be called when a suitable event occurs and the +object owning the method. From these a new listener is constructed and added +to the event router of the specified component.

+ +

The interface is defined in +{@link com.vaadin.event.MethodEventSource MethodEventSource}, and a +straightforward implementation of it is defined in +{@link com.vaadin.event.EventRouter EventRouter} which also includes +a method to actually fire the events.

+ +

All fired events are passed to all registered listeners, which are of +type {@link com.vaadin.event.ListenerMethod ListenerMethod}. The +listener then checks if the event type matches with the specified event +type and calls the specified trigger method if it does.

+ + + + + diff --git a/server/src/main/javadoc/com/vaadin/package.html b/server/src/main/javadoc/com/vaadin/package.html new file mode 100644 index 0000000000..097fd94aca --- /dev/null +++ b/server/src/main/javadoc/com/vaadin/package.html @@ -0,0 +1,25 @@ + + + + + + + +

The Vaadin base package. Contains the Application class, the + starting point of any application that uses Vaadin.

+ +

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.server.ApplicationServlet} or {@link + com.vaadin.server.GAEApplicationServlet} (for Google App Engine).

+ +

Vaadin applications can also be deployed as portlets using + {@link com.vaadin.server.ApplicationPortlet2} (JSR-286).

+ +

All classes in Vaadin are serializable unless otherwise noted. + This allows Vaadin applications to run in cluster and cloud + environments.

+ + + + diff --git a/server/src/main/javadoc/com/vaadin/server/package.html b/server/src/main/javadoc/com/vaadin/server/package.html new file mode 100644 index 0000000000..83514a0de5 --- /dev/null +++ b/server/src/main/javadoc/com/vaadin/server/package.html @@ -0,0 +1,21 @@ + + + + + + + + + + +

Provides classes and interfaces that wrap the terminal-side functionalities +for the server-side application. (FIXME: This could be a little more descriptive and wordy.)

+ +

Package Specification

+ + + + + + + diff --git a/server/src/main/javadoc/com/vaadin/ui/package.html b/server/src/main/javadoc/com/vaadin/ui/package.html new file mode 100644 index 0000000000..6b19a28fe7 --- /dev/null +++ b/server/src/main/javadoc/com/vaadin/ui/package.html @@ -0,0 +1,76 @@ + + + + + + + + + + +

Provides interfaces and classes in Vaadin.

+ +

Package Specification

+ +

Interface hierarchy

+ +

The general interface hierarchy looks like this:

+ +

+ +

Note that the above picture includes only the main +interfaces. This package includes several other lesser sub-interfaces +which are not significant in this scope. The interfaces not appearing +here are documented with the classes that define them.

+ +

The {@link com.vaadin.ui.Component} interface is the top-level +interface which must be implemented by all user interface components in +Vaadin. It defines the common properties of the components and how the +framework will handle them. Most simple components, such as {@link +com.vaadin.ui.Button}, for example, do not need to implement the +lower-level interfaces described below. Notice that also the classes and +interfaces required by the component event framework are defined in +{@link com.vaadin.ui.Component}.

+ +

The next level in the component hierarchy are the classes +implementing the {@link com.vaadin.ui.ComponentContainer} interface. It +adds the capacity to contain other components to {@link +com.vaadin.ui.Component} with a simple API.

+ +

The third and last level is the {@link com.vaadin.ui.Layout}, +which adds the concept of location to the components contained in a +{@link com.vaadin.ui.ComponentContainer}. It can be used to create +containers which contents can be positioned.

+ +

Component class hierarchy

+ +

The actual component classes form a hierarchy like this:

+ +
+
+ +
Underlined classes are abstract.
+ +

At the top level is {@link com.vaadin.ui.AbstractComponent} which +implements the {@link com.vaadin.ui.Component} interface. As the name +suggests it is abstract, but it does include a default implementation +for all methods defined in Component so that a component is +free to override only those functionalities it needs.

+ +

As seen in the picture, AbstractComponent serves as +the superclass for several "real" components, but it also has a some +abstract extensions. {@link com.vaadin.ui.AbstractComponentContainer} +serves as the root class for all components (for example, panels and +windows) who can contain other components. {@link +com.vaadin.ui.AbstractField}, on the other hand, implements several +interfaces to provide a base class for components that are used for data +display and manipulation.

+ + + + + + + + diff --git a/server/src/main/resources/com/vaadin/annotations/package.html b/server/src/main/resources/com/vaadin/annotations/package.html deleted file mode 100644 index d789e9b5df..0000000000 --- a/server/src/main/resources/com/vaadin/annotations/package.html +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - -

Contains annotations used in Vaadin. Note that some annotations -are also found in other packages e.g., {@link com.vaadin.ui.ClientWidget}.

- - - diff --git a/server/src/main/resources/com/vaadin/data/package.html b/server/src/main/resources/com/vaadin/data/package.html deleted file mode 100644 index a14ea1ac88..0000000000 --- a/server/src/main/resources/com/vaadin/data/package.html +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - -

Contains interfaces for the data layer, mainly for binding typed -data and data collections to components, and for validating data.

- -

Data binding

- -

The package contains a three-tiered structure for typed data -objects and collections of them:

- - - -

For more information on the data model, see the Data model -chapter in Book of Vaadin.

- -

Buffering

- -

A {@link com.vaadin.data.Buffered Buffered} implementor is able -to track and buffer changes and commit or discard them later.

- -

Validation

- -

{@link com.vaadin.data.Validator Validator} implementations are -used to validate data, typically the value of a {@link -com.vaadin.ui.Field Field}. One or more {@link com.vaadin.data.Validator -Validators} can be added to a {@link com.vaadin.data.Validatable -Validatable} implementor and then used to validate the value of the -Validatable.

- - - - diff --git a/server/src/main/resources/com/vaadin/data/util/package.html b/server/src/main/resources/com/vaadin/data/util/package.html deleted file mode 100644 index 07e3acde9e..0000000000 --- a/server/src/main/resources/com/vaadin/data/util/package.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - -

Provides implementations of Property, Item and Container -interfaces, and utilities for the data layer.

- -

Various Property, Item and Container implementations are provided -in this package. Each implementation can have its own sets of -constraints on the data it encapsulates and on how the implementation -can be used. See the class javadocs for more information.

- - - diff --git a/server/src/main/resources/com/vaadin/data/validator/package.html b/server/src/main/resources/com/vaadin/data/validator/package.html deleted file mode 100644 index c991bfc82a..0000000000 --- a/server/src/main/resources/com/vaadin/data/validator/package.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - - - - - - -

Provides various {@link com.vaadin.data.Validator} -implementations.

- -

{@link com.vaadin.data.validator.AbstractValidator -AbstractValidator} provides an abstract implementation of the {@link -com.vaadin.data.Validator} interface and can be extended for custom -validation needs. {@link -com.vaadin.data.validator.AbstractStringValidator -AbstractStringValidator} can also be extended if the value is a String.

- - - - diff --git a/server/src/main/resources/com/vaadin/event/package.html b/server/src/main/resources/com/vaadin/event/package.html deleted file mode 100644 index 2e7e17b892..0000000000 --- a/server/src/main/resources/com/vaadin/event/package.html +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - - -

Provides classes and interfaces for the inheritable event -model. The model supports inheritable events and a flexible way of -registering and unregistering event listeners. It's a fundamental building -block of Vaadin, and as it is included in -{@link com.vaadin.ui.AbstractComponent}, all UI components -automatically support it.

- -

Package Specification

- -

The core of the event model is the inheritable event class -hierarchy, and the {@link com.vaadin.event.EventRouter EventRouter} -which provide a simple, ubiquitous mechanism to transport events to all -interested parties.

- -

The power of the event inheritance arises from the possibility of -receiving not only the events of the registered type, but also the -ones which are inherited from it. For example, let's assume that there -are the events GeneralEvent and SpecializedEvent -so that the latter inherits the former. Furthermore we have an object -A which registers to receive GeneralEvent type -events from the object B. A would of course -receive all GeneralEvents generated by B, but in -addition to this, A would also receive all -SpecializedEvents generated by B. However, if -B generates some other events that do not have -GeneralEvent as an ancestor, A would not receive -them unless it registers to listen for them, too.

- -

The interface to attaching and detaching listeners to and from an object -works with methods. One specifies the event that should trigger the listener, -the trigger method that should be called when a suitable event occurs and the -object owning the method. From these a new listener is constructed and added -to the event router of the specified component.

- -

The interface is defined in -{@link com.vaadin.event.MethodEventSource MethodEventSource}, and a -straightforward implementation of it is defined in -{@link com.vaadin.event.EventRouter EventRouter} which also includes -a method to actually fire the events.

- -

All fired events are passed to all registered listeners, which are of -type {@link com.vaadin.event.ListenerMethod ListenerMethod}. The -listener then checks if the event type matches with the specified event -type and calls the specified trigger method if it does.

- - - - - diff --git a/server/src/main/resources/com/vaadin/package.html b/server/src/main/resources/com/vaadin/package.html deleted file mode 100644 index 097fd94aca..0000000000 --- a/server/src/main/resources/com/vaadin/package.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - - -

The Vaadin base package. Contains the Application class, the - starting point of any application that uses Vaadin.

- -

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.server.ApplicationServlet} or {@link - com.vaadin.server.GAEApplicationServlet} (for Google App Engine).

- -

Vaadin applications can also be deployed as portlets using - {@link com.vaadin.server.ApplicationPortlet2} (JSR-286).

- -

All classes in Vaadin are serializable unless otherwise noted. - This allows Vaadin applications to run in cluster and cloud - environments.

- - - - diff --git a/server/src/main/resources/com/vaadin/server/package.html b/server/src/main/resources/com/vaadin/server/package.html deleted file mode 100644 index 83514a0de5..0000000000 --- a/server/src/main/resources/com/vaadin/server/package.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - - - - - -

Provides classes and interfaces that wrap the terminal-side functionalities -for the server-side application. (FIXME: This could be a little more descriptive and wordy.)

- -

Package Specification

- - - - - - - diff --git a/server/src/main/resources/com/vaadin/ui/package.html b/server/src/main/resources/com/vaadin/ui/package.html deleted file mode 100644 index 6b19a28fe7..0000000000 --- a/server/src/main/resources/com/vaadin/ui/package.html +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - - - -

Provides interfaces and classes in Vaadin.

- -

Package Specification

- -

Interface hierarchy

- -

The general interface hierarchy looks like this:

- -

- -

Note that the above picture includes only the main -interfaces. This package includes several other lesser sub-interfaces -which are not significant in this scope. The interfaces not appearing -here are documented with the classes that define them.

- -

The {@link com.vaadin.ui.Component} interface is the top-level -interface which must be implemented by all user interface components in -Vaadin. It defines the common properties of the components and how the -framework will handle them. Most simple components, such as {@link -com.vaadin.ui.Button}, for example, do not need to implement the -lower-level interfaces described below. Notice that also the classes and -interfaces required by the component event framework are defined in -{@link com.vaadin.ui.Component}.

- -

The next level in the component hierarchy are the classes -implementing the {@link com.vaadin.ui.ComponentContainer} interface. It -adds the capacity to contain other components to {@link -com.vaadin.ui.Component} with a simple API.

- -

The third and last level is the {@link com.vaadin.ui.Layout}, -which adds the concept of location to the components contained in a -{@link com.vaadin.ui.ComponentContainer}. It can be used to create -containers which contents can be positioned.

- -

Component class hierarchy

- -

The actual component classes form a hierarchy like this:

- -
-
- -
Underlined classes are abstract.
- -

At the top level is {@link com.vaadin.ui.AbstractComponent} which -implements the {@link com.vaadin.ui.Component} interface. As the name -suggests it is abstract, but it does include a default implementation -for all methods defined in Component so that a component is -free to override only those functionalities it needs.

- -

As seen in the picture, AbstractComponent serves as -the superclass for several "real" components, but it also has a some -abstract extensions. {@link com.vaadin.ui.AbstractComponentContainer} -serves as the root class for all components (for example, panels and -windows) who can contain other components. {@link -com.vaadin.ui.AbstractField}, on the other hand, implements several -interfaces to provide a base class for components that are used for data -display and manipulation.

- - - - - - - -