org.beangle.commons.entity.comment

Class Generator

java.lang.Object

org.beangle.commons.entity.comment.Generator

public class Generator
extends Object

Sql comments generator,It convert field's javadoc comment to sql comment.

Usage:

 <build>
   <plugins>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.9</version>
        <configuration>
          <charset>UTF-8</charset>
          <doclet>org.beangle.commons.entity.comment.CommentGenerator</doclet>
          <docletArtifact>
            <groupId>org.beangle.commons</groupId>
            <artifactId>beangle-commons-model</artifactId>
            <version>${beangle.version}</version>
          </docletArtifact>
          <locale>
          zh_CN
          </locale>
          <useStandardDocletOptions>false</useStandardDocletOptions>
        </configuration>
      </plugin>
    </plugins>
  </build>
 

Since:

3.2.0

Author:

chaostone

See Also:

https://github.com/beangle/library/wiki/Entity-Comment-Generator, http://docs.oracle.com/javase/1.4.2/docs/tooldocs/javadoc/overview.html, http://docs.oracle.com/javase/7/docs/jdk/api/javadoc/doclet/index.html

Constructor Summary

Constructors

Constructor and Description
Generator()

Method Summary

Modifier and Type	Method and Description
static int	optionLength(String option) Every option's args length(include themself)
static boolean	start(com.sun.javadoc.RootDoc root)
static boolean	validOptions(String[][] options, com.sun.javadoc.DocErrorReporter reporter) Validate option .

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Generator

public Generator()

Method Detail

start

public static boolean start(com.sun.javadoc.RootDoc root)
                     throws Exception

Throws:

Exception

optionLength

public static int optionLength(String option)

Every option's args length(include themself)

It will be invoke by javadoc

validOptions

public static boolean validOptions(String[][] options,
                                   com.sun.javadoc.DocErrorReporter reporter)

Validate option .

It will be invoke by javadoc