Skip to content

Commit 594ad62

Browse files
koentsjeyrodiere
authored andcommitted
HHH-19817: Add the JavaDoc Style documentation appropriate for Maven Plugins
Signed-off-by: Koen Aers <koen.aers@gmail.com>
1 parent 9637049 commit 594ad62

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

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

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,33 +33,57 @@ 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+
* @deprecated <a href="https://hibernate.atlassian.net/browse/HHH-15641">See HHH-15641</a>
64+
*/
4965
@Deprecated(
5066
forRemoval = true)
5167
@Parameter(
5268
defaultValue = "true",
5369
required = true)
5470
private boolean enableDirtyTracking;
5571

72+
/**
73+
* A boolean that indicates whether or not to add lazy initialization
74+
* @deprecated <a href="https://hibernate.atlassian.net/browse/HHH-15641">See HHH-15641</a>
75+
*/
5676
@Deprecated(
5777
forRemoval = true)
5878
@Parameter(
5979
defaultValue = "true",
6080
required = true)
6181
private boolean enableLazyInitialization;
6282

83+
/**
84+
* A boolean that indicates whether or not to add extended enhancement.
85+
* This setting will provide bytecode enhancement, even for non-entity classes
86+
*/
6387
@Parameter(
6488
defaultValue = "false",
6589
required = true)

0 commit comments

Comments
 (0)