From 3792e06859ea5ff7222bf0a9c4d3cb07e34df246 Mon Sep 17 00:00:00 2001 From: Robin Bygrave Date: Wed, 30 Sep 2015 17:26:05 +1300 Subject: [PATCH] Update javadoc --- .../com/avaje/ebean/dbmigration/package-info.java | 8 ++++++++ .../com/avaje/ebean/event/changelog/package-info.java | 11 ++++++++--- .../com/avaje/ebean/event/readaudit/package-info.java | 6 +++--- 3 files changed, 19 insertions(+), 6 deletions(-) diff --git a/src/main/java/com/avaje/ebean/dbmigration/package-info.java b/src/main/java/com/avaje/ebean/dbmigration/package-info.java index e69de29bb..b4fed1868 100644 --- a/src/main/java/com/avaje/ebean/dbmigration/package-info.java +++ b/src/main/java/com/avaje/ebean/dbmigration/package-info.java @@ -0,0 +1,8 @@ +/** + * Generation DDL migration scripts based on changes to the model. + *

+ * You can use DbMigration to compare the entity bean model to its prior state + * and generate DDL for the differences - adding tables, columns etc. + *

+ */ +package com.avaje.ebean.dbmigration; \ No newline at end of file diff --git a/src/main/java/com/avaje/ebean/event/changelog/package-info.java b/src/main/java/com/avaje/ebean/event/changelog/package-info.java index a8eeb49d5..60a06a908 100644 --- a/src/main/java/com/avaje/ebean/event/changelog/package-info.java +++ b/src/main/java/com/avaje/ebean/event/changelog/package-info.java @@ -1,8 +1,13 @@ /** - * Generation DDL migration scripts based on changes to the model. + * Provides a built in change log mechanism and can audit changes. *

- * You can use DbMigration to compare the entity bean model to its prior state - * and generate DDL for the differences - adding tables, columns etc. + * Although you can build something similar using existing event adapters such as BeanPersistController + * this is built for purpose to reduce the effort and provide optimal performance for auditing or logging changes. + *

+ *

+ * By default you can annotate beans with @ChangeLog and associated change events are logged by default + * in a JSON form with appropriate auditing attributes such as who made the changes and ip address of the user etc + * via implementation of ChangeLogPrepare *

*/ package com.avaje.ebean.event.changelog; \ No newline at end of file diff --git a/src/main/java/com/avaje/ebean/event/readaudit/package-info.java b/src/main/java/com/avaje/ebean/event/readaudit/package-info.java index cf47c883a..e0fc4e787 100644 --- a/src/main/java/com/avaje/ebean/event/readaudit/package-info.java +++ b/src/main/java/com/avaje/ebean/event/readaudit/package-info.java @@ -1,8 +1,8 @@ /** - * Generation DDL migration scripts based on changes to the model. + * Provides Auditing of read events including queries and L2 cache. *

- * You can use DbMigration to compare the entity bean model to its prior state - * and generate DDL for the differences - adding tables, columns etc. + * Provides a built support for supplied an audit of all the 'read events' for beans annotated + * with @ReadAudit *

*/ package com.avaje.ebean.event.readaudit; \ No newline at end of file