Build javadocs.

Author: asfernandes

src/etc/bin/create-package.sh

@@ -25,10 +25,14 @@ make TARGET=$CONFIG clean all
 cd $BASE_DIR/src
 mvn clean package dependency:copy-dependencies
 
+cd fbjava
+mvn javadoc:javadoc
+
 mkdir -p \
 	$TARGET_DIR/bin \
 	$TARGET_DIR/conf \
 	$TARGET_DIR/jar \
+	$TARGET_DIR/docs \
 	$TARGET_DIR/lib \
 	$TARGET_DIR/scripts
 
@@ -37,6 +41,7 @@ cp $BASE_DIR/src/etc/bin/fbjava-deployer.$SHELL_EXT $TARGET_DIR/bin
 cp $BASE_DIR/src/fbjava/target/*.jar $TARGET_DIR/jar
 cp $BASE_DIR/src/fbjava-impl/target/*.jar $TARGET_DIR/jar
 cp $BASE_DIR/src/fbjava-impl/target/dependency/*.jar $TARGET_DIR/jar
+cp -r $BASE_DIR/src/fbjava/target/site/apidocs $TARGET_DIR/docs
 cp $BASE_DIR/output/$CONFIG/lib/libfbjava.$SHRLIB_EXT $TARGET_DIR/lib
 cp $BASE_DIR/src/fbjava-impl/src/main/resources/org/firebirdsql/fbjava/*.sql $TARGET_DIR/scripts
 cp $BASE_DIR/src/etc/conf/fbjava.conf $TARGET_DIR/conf

src/fbjava/pom.xml

@@ -14,4 +14,14 @@
 	<artifactId>fbjava</artifactId>
 	<name>fbjava</name>
 	<packaging>jar</packaging>
+
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-javadoc-plugin</artifactId>
+				<version>${maven-javadoc-plugin.version}</version>
+			</plugin>
+		</plugins>
+	</build>
 </project>

src/fbjava/src/main/java/org/firebirdsql/fbjava/ExternalResultSet.java

@@ -19,8 +19,22 @@
 package org.firebirdsql.fbjava;
 
 
+/**
+ * This interface represents a Firebird Externa ResultSet for a selectable stored procedure.
+ *
+ * @author <a href="mailto:adrianosf@gmail.com">Adriano dos Santos Fernandes</a>
+ */
 public interface ExternalResultSet
 {
+	/**
+	 * Called by Firebird to get records from the ExternalResultSet.
+	 * @return	false to stop and true to continue.
+	 * @throws Exception
+	 */
 	public boolean fetch() throws Exception;
+
+	/**
+	 * Called by Firebird after fetched all rows from the ExternalResultSet.
+	 */
 	public void close();
 }

src/fbjava/src/main/java/org/firebirdsql/fbjava/TriggerContext.java

@@ -26,13 +26,19 @@
  */
 public interface TriggerContext extends Context
 {
+	/**
+	 * Trigger Type.
+	 */
 	public static enum Type
 	{
 		BEFORE,
 		AFTER,
 		DATABASE
 	}
 
+	/**
+	 * Trigger Action.
+	 */
 	public static enum Action
 	{
 		INSERT,

src/pom.xml

@@ -14,6 +14,8 @@
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<java.version>1.8</java.version>
 
+		<maven-javadoc-plugin.version>2.10.3</maven-javadoc-plugin.version>
+
 		<jaybird.version>3.0.0-SNAPSHOT</jaybird.version>
 		<jna.version>4.2.1</jna.version>
 	</properties>