java.lang.Object | |
↳ | org.mybatis.generator.internal.DefaultCommentGenerator |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Adds a suitable comment to warn users that the element was generated, and
when it was generated.
| |||||||||||
Adds properties for this instance from any properties configured in the
CommentGenerator configuration.
| |||||||||||
This method should add a Javadoc comment to the specified field.
| |||||||||||
This method is called to add a file level comment to a generated java
file.
| |||||||||||
This method is called to add a comment as the first child of the root
element.
| |||||||||||
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
This method adds the custom javadoc tag for.
| |||||||||||
This method returns a formated date string to include in the Javadoc tag
and XML comments.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
Adds a suitable comment to warn users that the element was generated, and when it was generated.
Adds properties for this instance from any properties configured in the CommentGenerator configuration. This method will be called before any of the other methods.
properties | All properties from the configuration |
---|
This method should add a Javadoc comment to the specified field. The field is related to the specified table and is used to hold the value of the specified column.
Important: This method should add a the nonstandard JavaDoc tag "@mbggenerated" to the comment. Without this tag, the Eclipse based Java merge feature will fail.
This method is called to add a file level comment to a generated java file. This method could be used to add a general file comment (such as a copyright notice). However, note that the Java file merge function in Eclipse does not deal with this comment. If you run the generator repeatedly, you will only retain the comment from the initial run.
The default implementation does nothing.
This method is called to add a comment as the first child of the root element. This method could be used to add a general file comment (such as a copyright notice). However, note that the XML file merge function does not deal with this comment. If you run the generator repeatedly, you will only retain the comment from the initial run.
The default implementation does nothing.
This method adds the custom javadoc tag for. You may do nothing if you do not wish to include the Javadoc tag - however, if you do not include the Javadoc tag then the Java merge capability of the eclipse plugin will break.
javaElement | the java element |
---|
This method returns a formated date string to include in the Javadoc tag and XML comments. You may return null if you do not want the date in these documentation elements.