Skip to content

Commit e186a98

Browse files
committed
HHH-19817: Add the JavaDoc Style documentation appropriate for Maven Plugins
Signed-off-by: Koen Aers <[email protected]>
1 parent 247e7ab commit e186a98

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

tooling/hibernate-maven-plugin/src/main/java/org/hibernate/orm/tooling/maven/HibernateEnhancerMojo.java

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,29 +33,51 @@ public class HibernateEnhancerMojo extends AbstractMojo {
3333
final private List<File> sourceSet = new ArrayList<File>();
3434
private Enhancer enhancer;
3535

36+
/**
37+
* A list of FileSets in which to look for classes to enhance.
38+
* This parameter is optional but if it is specified, the 'classesDirectory' parameter is ignored.
39+
*/
3640
@Parameter
3741
private FileSet[] fileSets;
3842

43+
/**
44+
* The folder in which to look for classes to enhance.
45+
* This parameter is required but if the 'fileSets' parameter is specified, it will be ignored.
46+
*/
3947
@Parameter(
4048
defaultValue = "${project.build.directory}/classes",
4149
required = true)
4250
private File classesDirectory;
4351

52+
/**
53+
* A boolean that indicates whether or not to add association management to automatically
54+
* synchronize a bidirectional association when only one side is changed
55+
*/
4456
@Parameter(
4557
defaultValue = "false",
4658
required = true)
4759
private boolean enableAssociationManagement;
4860

61+
/**
62+
* A boolean that indicates whether or not to add dirty tracking
63+
*/
4964
@Parameter(
5065
defaultValue = "false",
5166
required = true)
5267
private boolean enableDirtyTracking;
5368

69+
/**
70+
* A boolean that indicates whether or not to add lazy initialization
71+
*/
5472
@Parameter(
5573
defaultValue = "false",
5674
required = true)
5775
private boolean enableLazyInitialization;
5876

77+
/**
78+
* A boolean that indicates whether or not to add extended enhancement.
79+
* This setting will provide bytecode enhancement, even for non-entity classes
80+
*/
5981
@Parameter(
6082
defaultValue = "false",
6183
required = true)

0 commit comments

Comments
 (0)