You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@avro.apache.org by cu...@apache.org on 2009/08/12 18:39:20 UTC
svn commit: r803592 - in /hadoop/avro/trunk: ./
src/java/org/apache/avro/file/ src/java/org/apache/avro/reflect/
src/java/org/apache/avro/specific/
Author: cutting
Date: Wed Aug 12 16:39:20 2009
New Revision: 803592
URL: http://svn.apache.org/viewvc?rev=803592&view=rev
Log:
AVRO-87. Fix broken links in javadoc introduced by AVRO-82.
Modified:
hadoop/avro/trunk/CHANGES.txt
hadoop/avro/trunk/build.xml
hadoop/avro/trunk/src/java/org/apache/avro/file/SeekableInput.java
hadoop/avro/trunk/src/java/org/apache/avro/reflect/FixedSize.java
hadoop/avro/trunk/src/java/org/apache/avro/reflect/ReflectDatumReader.java
hadoop/avro/trunk/src/java/org/apache/avro/reflect/ReflectDatumWriter.java
hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificDatumReader.java
hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificDatumWriter.java
hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificRequestor.java
hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificResponder.java
Modified: hadoop/avro/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/hadoop/avro/trunk/CHANGES.txt?rev=803592&r1=803591&r2=803592&view=diff
==============================================================================
--- hadoop/avro/trunk/CHANGES.txt (original)
+++ hadoop/avro/trunk/CHANGES.txt Wed Aug 12 16:39:20 2009
@@ -39,6 +39,10 @@
AVRO-79. Specify format for default fixed values, and implement
correctly in Java. (Thiruvalluvan M. G. via cutting)
+ AVRO-87. Fix broken links in javadoc introduced by AVRO-82. Also
+ change test-java build target to fail on javadoc warnings.
+ (Thiruvalluvan M. G. and cutting)
+
Avro 1.0.0 -- 9 July 2009
INCOMPATIBLE CHANGES
Modified: hadoop/avro/trunk/build.xml
URL: http://svn.apache.org/viewvc/hadoop/avro/trunk/build.xml?rev=803592&r1=803591&r2=803592&view=diff
==============================================================================
--- hadoop/avro/trunk/build.xml (original)
+++ hadoop/avro/trunk/build.xml Wed Aug 12 16:39:20 2009
@@ -43,6 +43,7 @@
<property name="build.classes" value="${build.dir}/classes"/>
<property name="build.doc" value="${build.dir}/doc"/>
<property name="build.javadoc" value="${build.doc}/api/java"/>
+ <property name="build.javadoc.log" value="${build.dir}/javadoc.log"/>
<property name="build.cdoc" value="${build.doc}/api/c"/>
<exec executable="sed" inputstring="${os.name}" outputproperty="nonspace.os">
@@ -284,7 +285,7 @@
</sequential>
</macrodef>
- <target name="test-java" depends="compile-test-java,checkstyle-java"
+ <target name="test-java" depends="compile-test-java,checkstyle-java,javadoc"
description="Run java unit tests">
<test-runner files.location="${test.java.src.dir}" tests.pattern="**/${test.java.include}.java"/>
</target>
@@ -440,8 +441,9 @@
<fail message="'java5.home' is not defined. Forrest requires Java 5. Please pass -Djava5.home=<base of Java 5 distribution> to Ant on the command-line." />
</target>
- <target name="javadoc" depends="compile" description="Generate javadoc">
+ <target name="javadoc" depends="compile-java" description="Generate javadoc">
<mkdir dir="${build.javadoc}"/>
+ <record name="${build.javadoc.log}" action="start"/>
<javadoc
overview="${java.src.dir}/overview.html"
packagenames="org.${org}.${name}.*"
@@ -463,7 +465,14 @@
</classpath>
</javadoc>
- </target>
+ <record name="${build.javadoc.log}" action="stop"/>
+ <condition property="javadoc.warnings">
+ <isfileselected file="${build.javadoc.log}">
+ <contains text=": warning - "/>
+ </isfileselected>
+ </condition>
+ <fail if="javadoc.warnings">Javadoc warnings!</fail>
+ </target>
<target name="package" depends="jar, doc, package-c"
description="Build distribution">
Modified: hadoop/avro/trunk/src/java/org/apache/avro/file/SeekableInput.java
URL: http://svn.apache.org/viewvc/hadoop/avro/trunk/src/java/org/apache/avro/file/SeekableInput.java?rev=803592&r1=803591&r2=803592&view=diff
==============================================================================
--- hadoop/avro/trunk/src/java/org/apache/avro/file/SeekableInput.java (original)
+++ hadoop/avro/trunk/src/java/org/apache/avro/file/SeekableInput.java Wed Aug 12 16:39:20 2009
@@ -22,16 +22,16 @@
/** An InputStream that supports seek and tell. */
public interface SeekableInput {
- /** Set the position for the next {@link #read(byte[],int,int) read()}. */
+ /** Set the position for the next {@link java.io.InputStream#read(byte[],int,int) read()}. */
void seek(long p) throws IOException;
- /** Return the position of the next {@link #read(byte[],int,int) read()}. */
+ /** Return the position of the next {@link java.io.InputStream#read(byte[],int,int) read()}. */
long tell() throws IOException;
/** Return the length of the file. */
long length() throws IOException;
- /** Equivalent to {@link InputStream#read(byte[],int,int)}. */
+ /** Equivalent to {@link java.io.InputStream#read(byte[],int,int)}. */
int read(byte[] b, int off, int len) throws IOException;
}
Modified: hadoop/avro/trunk/src/java/org/apache/avro/reflect/FixedSize.java
URL: http://svn.apache.org/viewvc/hadoop/avro/trunk/src/java/org/apache/avro/reflect/FixedSize.java?rev=803592&r1=803591&r2=803592&view=diff
==============================================================================
--- hadoop/avro/trunk/src/java/org/apache/avro/reflect/FixedSize.java (original)
+++ hadoop/avro/trunk/src/java/org/apache/avro/reflect/FixedSize.java Wed Aug 12 16:39:20 2009
@@ -23,7 +23,10 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-/** Declares the size of implementations of {@link GenericFixed}. */
+/**
+ * Declares the size of implementations of
+ * {@link org.apache.avro.generic.GenericFixed GenericFixed}.
+ */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Documented
Modified: hadoop/avro/trunk/src/java/org/apache/avro/reflect/ReflectDatumReader.java
URL: http://svn.apache.org/viewvc/hadoop/avro/trunk/src/java/org/apache/avro/reflect/ReflectDatumReader.java?rev=803592&r1=803591&r2=803592&view=diff
==============================================================================
--- hadoop/avro/trunk/src/java/org/apache/avro/reflect/ReflectDatumReader.java (original)
+++ hadoop/avro/trunk/src/java/org/apache/avro/reflect/ReflectDatumReader.java Wed Aug 12 16:39:20 2009
@@ -25,7 +25,10 @@
import org.apache.avro.Schema;
import org.apache.avro.generic.GenericDatumReader;
-/** {@link DatumReader} for existing classes via Java reflection. */
+/**
+ * {@link org.apache.avro.io.DatumReader DatumReader} for existing classes via
+ * Java reflection.
+ */
public class ReflectDatumReader extends GenericDatumReader<Object> {
protected String packageName;
Modified: hadoop/avro/trunk/src/java/org/apache/avro/reflect/ReflectDatumWriter.java
URL: http://svn.apache.org/viewvc/hadoop/avro/trunk/src/java/org/apache/avro/reflect/ReflectDatumWriter.java?rev=803592&r1=803591&r2=803592&view=diff
==============================================================================
--- hadoop/avro/trunk/src/java/org/apache/avro/reflect/ReflectDatumWriter.java (original)
+++ hadoop/avro/trunk/src/java/org/apache/avro/reflect/ReflectDatumWriter.java Wed Aug 12 16:39:20 2009
@@ -25,7 +25,10 @@
import org.apache.avro.generic.GenericDatumWriter;
import org.apache.avro.io.Encoder;
-/** {@link DatumWriter} for existing classes via Java reflection. */
+/**
+ * {@link org.apache.avro.io.DatumWriter DatumWriter} for existing classes
+ * via Java reflection.
+ */
public class ReflectDatumWriter extends GenericDatumWriter<Object> {
public ReflectDatumWriter() {}
Modified: hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificDatumReader.java
URL: http://svn.apache.org/viewvc/hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificDatumReader.java?rev=803592&r1=803591&r2=803592&view=diff
==============================================================================
--- hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificDatumReader.java (original)
+++ hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificDatumReader.java Wed Aug 12 16:39:20 2009
@@ -20,7 +20,7 @@
import org.apache.avro.Schema;
import org.apache.avro.reflect.ReflectDatumReader;
-/** {@link DatumReader} for generated Java classes. */
+/** {@link org.apache.avro.io.DatumReader DatumReader} for generated Java classes. */
public class SpecificDatumReader extends ReflectDatumReader {
public SpecificDatumReader(String packageName) {
super(packageName);
Modified: hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificDatumWriter.java
URL: http://svn.apache.org/viewvc/hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificDatumWriter.java?rev=803592&r1=803591&r2=803592&view=diff
==============================================================================
--- hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificDatumWriter.java (original)
+++ hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificDatumWriter.java Wed Aug 12 16:39:20 2009
@@ -20,7 +20,7 @@
import org.apache.avro.Schema;
import org.apache.avro.reflect.ReflectDatumWriter;
-/** {@link DatumWriter} for generated Java classes. */
+/** {@link org.apache.avro.io.DatumWriter DatumWriter} for generated Java classes. */
public class SpecificDatumWriter extends ReflectDatumWriter {
public SpecificDatumWriter() {}
Modified: hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificRequestor.java
URL: http://svn.apache.org/viewvc/hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificRequestor.java?rev=803592&r1=803591&r2=803592&view=diff
==============================================================================
--- hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificRequestor.java (original)
+++ hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificRequestor.java Wed Aug 12 16:39:20 2009
@@ -29,7 +29,7 @@
import org.apache.avro.reflect.ReflectData;
import org.apache.avro.reflect.ReflectRequestor;
-/** {@link Requestor} for generated interfaces. */
+/** {@link org.apache.avro.ipc.Requestor Requestor} for generated interfaces. */
public class SpecificRequestor extends ReflectRequestor {
public SpecificRequestor(Class<?> iface, Transceiver transceiver)
Modified: hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificResponder.java
URL: http://svn.apache.org/viewvc/hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificResponder.java?rev=803592&r1=803591&r2=803592&view=diff
==============================================================================
--- hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificResponder.java (original)
+++ hadoop/avro/trunk/src/java/org/apache/avro/specific/SpecificResponder.java Wed Aug 12 16:39:20 2009
@@ -23,7 +23,7 @@
import org.apache.avro.io.DatumWriter;
import org.apache.avro.reflect.ReflectResponder;
-/** {@link Responder} for generated interfaces.*/
+/** {@link org.apache.avro.ipc.Responder Responder} for generated interfaces.*/
public class SpecificResponder extends ReflectResponder {
public SpecificResponder(Class iface, Object impl) {
super(iface, impl);