From d3e889bac4be8ca332827f4d02a18409806783dc Mon Sep 17 00:00:00 2001 From: Adam Warski Date: Wed, 29 Jun 2011 18:27:35 +0200 Subject: [PATCH] HHH-5917: improving documentation --- .../src/main/java/org/hibernate/envers/Audited.java | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/hibernate-envers/src/main/java/org/hibernate/envers/Audited.java b/hibernate-envers/src/main/java/org/hibernate/envers/Audited.java index bd7fdcffba..4df903a6a4 100644 --- a/hibernate-envers/src/main/java/org/hibernate/envers/Audited.java +++ b/hibernate-envers/src/main/java/org/hibernate/envers/Audited.java @@ -48,10 +48,14 @@ public @interface Audited { RelationTargetAuditMode targetAuditMode() default RelationTargetAuditMode.AUDITED; /** - * @return Set of superclasses which properties shall be audited. The behavior of listed classes - * is the same as if they had {@link Audited} annotation applied on a type level. The scope of this functionality - * is limited to the context of actually mapped entity and its class hierarchy. If a parent type lists any of - * its parent types using this attribute, all fields encapsulated by marked classes are implicitly audited. + * @return Specifies the superclasses for which properties should be audited, even if the superclasses are not + * annotated with {@link Audited}. Causes all properties of the listed classes to be audited, just as if the + * classes had {@link Audited} annotation applied on the class level. + * + * The scope of this functionality is limited to the class hierarchy of the annotated entity. + * + * If a parent type lists any of its parent types using this attribute, all properties in the specified classes + * will also be audited. */ Class[] auditParents() default {}; }