documenting

diff --git a/src/main/java/eu/etaxonomy/vaadin/event/EntityEditorActionEvent.java b/src/main/java/eu/etaxonomy/vaadin/event/EntityEditorActionEvent.java
index 2a1de017cb636e313381cac6a1d5bc0de0886911..255c1a489f185d364fc56b17daf71181f75606a5 100644 (file)
--- a/src/main/java/eu/etaxonomy/vaadin/event/EntityEditorActionEvent.java
+++ b/src/main/java/eu/etaxonomy/vaadin/event/EntityEditorActionEvent.java
@@ -13,8 +13,7 @@ import java.util.EnumSet;
 import com.vaadin.ui.AbstractField;
 
 /**
- * An Event
- * which represents the request to start an editor to enable the
+ * An Event which represents the request to start an editor to enable the
  * user to perform the <code>action</code> transported with this event.
  *
  * @author a.kohlbecker

diff --git a/src/main/java/eu/etaxonomy/vaadin/mvp/AbstractEditorPresenter.java b/src/main/java/eu/etaxonomy/vaadin/mvp/AbstractEditorPresenter.java
index 1d02e7c247349f67175d2674e7f16974300fb041..ff5f6d9b9764edc03b0acd39798c10c012961696 100644 (file)
--- a/src/main/java/eu/etaxonomy/vaadin/mvp/AbstractEditorPresenter.java
+++ b/src/main/java/eu/etaxonomy/vaadin/mvp/AbstractEditorPresenter.java
@@ -18,6 +18,11 @@ import eu.etaxonomy.vaadin.mvp.event.EditorSaveEvent;
 import eu.etaxonomy.vaadin.mvp.event.EditorViewEvent;
 
 /**
+ * Presenters of this type are usually be used in conjunction with a  {@link AbstractPopupEditor}.
+ * The presenter automatically handles save and delete operations. The methods {@link #saveBean(Object)} and
+ * {@link AbstractEditorPresenter#deleteBean(Object)} are executed internally in turn of an
+ * {@link EditorSaveEvent} or {@link EditorDeleteEvent} which are send by the {@link AbstractPopupEditor#save()}
+ * or {@link AbstractPopupEditor#delete()} method.
  *
  * @author a.kohlbecker
  * @since Apr 5, 2017