Author: bryanduxbury
Date: Fri Mar 20 16:43:06 2009
New Revision: 756603
URL: http://svn.apache.org/viewvc?rev=756603&view=rev
Log:
THRIFT-262. java: Generate Javadocs for library classes
This patch adds a 'javadoc' Ant target, and installs the documentation to
${docdir}/thrift/java (/usr/local/share/doc/thrift/java with the default
invocation of configure). It also fixes a few Javadoc warnings in the source
code.
It also modifies the 'dist' target to include the Java sources in the jar file,
so that Eclipse may show the javadocs for Thrift classes automatically (this
increases the size of libthrift.jar from 90 Kb to 155 Kb).
Modified:
incubator/thrift/trunk/lib/java/Makefile.am
incubator/thrift/trunk/lib/java/build.xml
incubator/thrift/trunk/lib/java/src/org/apache/thrift/TDeserializer.java
incubator/thrift/trunk/lib/java/src/org/apache/thrift/server/THsHaServer.java
incubator/thrift/trunk/lib/java/src/org/apache/thrift/transport/TTransportFactory.java
Modified: incubator/thrift/trunk/lib/java/Makefile.am
URL:
http://svn.apache.org/viewvc/incubator/thrift/trunk/lib/java/Makefile.am?rev=756603&r1=756602&r2=756603&view=diff
==============================================================================
--- incubator/thrift/trunk/lib/java/Makefile.am (original)
+++ incubator/thrift/trunk/lib/java/Makefile.am Fri Mar 20 16:43:06 2009
@@ -4,7 +4,8 @@
$(ANT)
install-exec-hook:
- $(ANT) install -Dinstall.path=$(DESTDIR)$(JAVA_PREFIX)
+ $(ANT) install -Dinstall.path=$(DESTDIR)$(JAVA_PREFIX) \
+ -Dinstall.javadoc.path=$(DESTDIR)$(docdir)/java
# Make sure this doesn't fail if ant is not configured.
clean-local:
Modified: incubator/thrift/trunk/lib/java/build.xml
URL:
http://svn.apache.org/viewvc/incubator/thrift/trunk/lib/java/build.xml?rev=756603&r1=756602&r2=756603&view=diff
==============================================================================
--- incubator/thrift/trunk/lib/java/build.xml (original)
+++ incubator/thrift/trunk/lib/java/build.xml Fri Mar 20 16:43:06 2009
@@ -7,6 +7,7 @@
<property name="src" location="src" />
<property name="build" location="build" />
+ <property name="javadoc" location="${build}/javadoc" />
<property name="install.path" value="/usr/local/lib" />
<property name="src.test" location="test" />
<property name="build.test" location="${build}/test" />
@@ -26,20 +27,42 @@
<javac srcdir="${src}" destdir="${build}" source="1.5" debug="true"/>
</target>
+ <target name="javadoc" depends="init">
+ <javadoc sourcepath="${src}"
+ destdir="${javadoc}"
+ version="true"
+ windowtitle="Thrift Java API"
+ doctitle="Thrift Java API">
+ </javadoc>
+ </target>
+
<target name="dist" depends="compile">
- <jar jarfile="libthrift.jar" basedir="${build}"/>
+ <jar jarfile="libthrift.jar">
+ <fileset dir="${build}">
+ <include name="**/*.class" />
+ </fileset>
+ <fileset dir="src">
+ <include name="**/*.java" />
+ </fileset>
+ </jar>
</target>
- <target name="install" depends="dist">
+ <target name="install" depends="dist,javadoc">
<exec executable="install">
<arg line="libthrift.jar ${install.path}" />
</exec>
+ <copy todir="${install.javadoc.path}">
+ <fileset dir="${javadoc}">
+ <include name="**/*" />
+ </fileset>
+ </copy>
</target>
<target name="clean">
<delete dir="${build}" />
<delete dir="${gen}"/>
<delete dir="${genbean}"/>
+ <delete dir="${javadoc}"/>
<delete file="libthrift.jar" />
</target>
Modified:
incubator/thrift/trunk/lib/java/src/org/apache/thrift/TDeserializer.java
URL:
http://svn.apache.org/viewvc/incubator/thrift/trunk/lib/java/src/org/apache/thrift/TDeserializer.java?rev=756603&r1=756602&r2=756603&view=diff
==============================================================================
--- incubator/thrift/trunk/lib/java/src/org/apache/thrift/TDeserializer.java
(original)
+++ incubator/thrift/trunk/lib/java/src/org/apache/thrift/TDeserializer.java
Fri Mar 20 16:43:06 2009
@@ -68,12 +68,11 @@
}
/**
- * Deerialize the Thrift object from a Java string, using the default JVM
+ * Deserialize the Thrift object from a Java string, using the default JVM
* charset encoding.
*
* @param base The object to read into
* @param data The string to read from
- * @return Serialized object as a String
*/
public void toString(TBase base, String data) throws TException {
deserialize(base, data.getBytes());
Modified:
incubator/thrift/trunk/lib/java/src/org/apache/thrift/server/THsHaServer.java
URL:
http://svn.apache.org/viewvc/incubator/thrift/trunk/lib/java/src/org/apache/thrift/server/THsHaServer.java?rev=756603&r1=756602&r2=756603&view=diff
==============================================================================
---
incubator/thrift/trunk/lib/java/src/org/apache/thrift/server/THsHaServer.java
(original)
+++
incubator/thrift/trunk/lib/java/src/org/apache/thrift/server/THsHaServer.java
Fri Mar 20 16:43:06 2009
@@ -190,7 +190,7 @@
STOP_TIMEOUT_UNIT = options.stopTimeoutUnit;
}
- /** @inheritdoc */
+ /** @inheritDoc */
@Override
public void serve() {
if (!startInvokerPool()) {
Modified:
incubator/thrift/trunk/lib/java/src/org/apache/thrift/transport/TTransportFactory.java
URL:
http://svn.apache.org/viewvc/incubator/thrift/trunk/lib/java/src/org/apache/thrift/transport/TTransportFactory.java?rev=756603&r1=756602&r2=756603&view=diff
==============================================================================
---
incubator/thrift/trunk/lib/java/src/org/apache/thrift/transport/TTransportFactory.java
(original)
+++
incubator/thrift/trunk/lib/java/src/org/apache/thrift/transport/TTransportFactory.java
Fri Mar 20 16:43:06 2009
@@ -18,8 +18,8 @@
/**
* Return a wrapped instance of the base Transport.
*
- * @param in The base transport
- * @returns Wrapped Transport
+ * @param trans The base transport
+ * @return Wrapped Transport
*/
public TTransport getTransport(TTransport trans) {
return trans;
