Author: cutting
Date: Thu Jan 9 23:13:32 2014
New Revision: 1556980
URL: http://svn.apache.org/r1556980
Log:
AVRO-1432. Java: Reduce javadoc warnings.
Modified:
avro/trunk/CHANGES.txt
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/Schema.java
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/SchemaBuilder.java
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/generic/GenericData.java
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/generic/GenericDatumReader.java
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/generic/GenericRecordBuilder.java
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/io/Encoder.java
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/io/parsing/Symbol.java
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/reflect/package.html
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/specific/SpecificData.java
avro/trunk/lang/java/compiler/src/main/velocity/org/apache/avro/compiler/specific/templates/java/classic/record.vm
avro/trunk/lang/java/ipc/src/main/java/org/apache/avro/ipc/Callback.java
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/file/HadoopCodecFactory.java
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroDeserializer.java
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroKeyDeserializer.java
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroSerializer.java
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroValueDeserializer.java
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/mapred/AvroMultipleOutputs.java
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/mapred/tether/TetherJob.java
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroMultipleOutputs.java
avro/trunk/lang/java/pom.xml
avro/trunk/lang/java/tools/src/test/compiler/output-string/avro/examples/baseball/Player.java
avro/trunk/lang/java/tools/src/test/compiler/output/Player.java
avro/trunk/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/AvroTrevniInputFormat.java
avro/trunk/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/mapreduce/AvroTrevniKeyInputFormat.java
avro/trunk/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/mapreduce/AvroTrevniKeyValueInputFormat.java
Modified: avro/trunk/CHANGES.txt
URL:
http://svn.apache.org/viewvc/avro/trunk/CHANGES.txt?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
--- avro/trunk/CHANGES.txt (original)
+++ avro/trunk/CHANGES.txt Thu Jan 9 23:13:32 2014
@@ -82,6 +82,8 @@ Trunk (not yet released)
AVRO-1427. Java: Improve ResolvingDecoder tests. (Rob Turner via cutting)
+ AVRO-1432. Java: Reduce javadoc warnings. (cutting)
+
BUG FIXES
AVRO-1368. Fix SpecificDatumWriter to, when writing a string
Modified: avro/trunk/lang/java/avro/src/main/java/org/apache/avro/Schema.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/avro/src/main/java/org/apache/avro/Schema.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
--- avro/trunk/lang/java/avro/src/main/java/org/apache/avro/Schema.java
(original)
+++ avro/trunk/lang/java/avro/src/main/java/org/apache/avro/Schema.java Thu Jan
9 23:13:32 2014
@@ -1213,7 +1213,6 @@ public abstract class Schema extends Jso
* @param container Container where to find key.
* @param key Key to look for in container.
* @param error String to prepend to the SchemaParseException.
- * @return
*/
private static String getRequiredText(JsonNode container, String key,
String error) {
Modified:
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/SchemaBuilder.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/avro/src/main/java/org/apache/avro/SchemaBuilder.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
--- avro/trunk/lang/java/avro/src/main/java/org/apache/avro/SchemaBuilder.java
(original)
+++ avro/trunk/lang/java/avro/src/main/java/org/apache/avro/SchemaBuilder.java
Thu Jan 9 23:13:32 2014
@@ -965,7 +965,7 @@ public class SchemaBuilder {
* defined named types to be referenced from {@link #type(String)}</li>
* <li>A completion context representing the scope that the builder was
* created in. A builder created in a nested context (for example,
- * {@link #MapBuilder.values()} will have a completion context assigned by
the
+ * {@link MapBuilder#values()} will have a completion context assigned by the
* {@link MapBuilder}</li>
**/
public static class BaseTypeBuilder<R> {
@@ -2133,10 +2133,11 @@ public class SchemaBuilder {
}
}
- private static abstract class FieldDefault<R, S extends FieldDefault<R, S>>
extends Completion<S> {
+ /** Abstract base class for field defaults. **/
+ public static abstract class FieldDefault<R, S extends FieldDefault<R, S>>
extends Completion<S> {
private final FieldBuilder<R> field;
private Schema schema;
- protected FieldDefault(FieldBuilder<R> field) {
+ FieldDefault(FieldBuilder<R> field) {
this.field = field;
}
@@ -2150,12 +2151,12 @@ public class SchemaBuilder {
}
@Override
- protected final S complete(Schema schema) {
+ final S complete(Schema schema) {
this.schema = schema;
return self();
}
- protected abstract S self();
+ abstract S self();
}
/** Choose whether to use a default value for the field or not. **/
@@ -2170,7 +2171,7 @@ public class SchemaBuilder {
}
@Override
- protected final BooleanDefault<R> self() {
+ final BooleanDefault<R> self() {
return this;
}
}
@@ -2187,7 +2188,7 @@ public class SchemaBuilder {
}
@Override
- protected final IntDefault<R> self() {
+ final IntDefault<R> self() {
return this;
}
}
@@ -2204,7 +2205,7 @@ public class SchemaBuilder {
}
@Override
- protected final LongDefault<R> self() {
+ final LongDefault<R> self() {
return this;
}
}
@@ -2221,7 +2222,7 @@ public class SchemaBuilder {
}
@Override
- protected final FloatDefault<R> self() {
+ final FloatDefault<R> self() {
return this;
}
}
@@ -2238,7 +2239,7 @@ public class SchemaBuilder {
}
@Override
- protected final DoubleDefault<R> self() {
+ final DoubleDefault<R> self() {
return this;
}
}
@@ -2255,7 +2256,7 @@ public class SchemaBuilder {
}
@Override
- protected final StringDefault<R> self() {
+ final StringDefault<R> self() {
return this;
}
}
@@ -2284,7 +2285,7 @@ public class SchemaBuilder {
}
@Override
- protected final BytesDefault<R> self() {
+ final BytesDefault<R> self() {
return this;
}
}
@@ -2301,7 +2302,7 @@ public class SchemaBuilder {
}
@Override
- protected final NullDefault<R> self() {
+ final NullDefault<R> self() {
return this;
}
}
@@ -2318,7 +2319,7 @@ public class SchemaBuilder {
}
@Override
- protected final MapDefault<R> self() {
+ final MapDefault<R> self() {
return this;
}
}
@@ -2335,7 +2336,7 @@ public class SchemaBuilder {
}
@Override
- protected final ArrayDefault<R> self() {
+ final ArrayDefault<R> self() {
return this;
}
}
@@ -2364,7 +2365,7 @@ public class SchemaBuilder {
}
@Override
- protected final FixedDefault<R> self() {
+ final FixedDefault<R> self() {
return this;
}
}
@@ -2381,7 +2382,7 @@ public class SchemaBuilder {
}
@Override
- protected final EnumDefault<R> self() {
+ final EnumDefault<R> self() {
return this;
}
}
@@ -2398,7 +2399,7 @@ public class SchemaBuilder {
}
@Override
- protected final RecordDefault<R> self() {
+ final RecordDefault<R> self() {
return this;
}
}
@@ -2429,7 +2430,7 @@ public class SchemaBuilder {
* Completion is an object that takes a Schema and returns some result.
*/
private abstract static class Completion<R> {
- protected abstract R complete(Schema schema);
+ abstract R complete(Schema schema);
}
private static class SchemaCompletion extends Completion<Schema> {
Modified:
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/generic/GenericData.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/avro/src/main/java/org/apache/avro/generic/GenericData.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
---
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/generic/GenericData.java
(original)
+++
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/generic/GenericData.java
Thu Jan 9 23:13:32 2014
@@ -592,7 +592,7 @@ public class GenericData {
}
/** Return the index for a datum within a union. Implemented with {@link
- * Schema#getIndexNamed(String)} and {@link #getSchemaName(Schema,Object)}.*/
+ * Schema#getIndexNamed(String)} and {@link #getSchemaName(Object)}.*/
public int resolveUnion(Schema union, Object datum) {
Integer i = union.getIndexNamed(getSchemaName(datum));
if (i != null)
Modified:
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/generic/GenericDatumReader.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/avro/src/main/java/org/apache/avro/generic/GenericDatumReader.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
---
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/generic/GenericDatumReader.java
(original)
+++
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/generic/GenericDatumReader.java
Thu Jan 9 23:13:32 2014
@@ -369,8 +369,9 @@ public class GenericDatumReader<D> imple
protected Object createString(String value) { return new Utf8(value); }
/** Determines the class to used to represent a string Schema. By default
- * uses {@link #STRING_PROP} to determine whether {@link Utf8} or {@link
- * String} is used. Subclasses may override for alternate representations.
+ * uses {@link GenericData#STRING_PROP} to determine whether {@link Utf8} or
+ * {@link String} is used. Subclasses may override for alternate
+ * representations.
*/
protected Class findStringClass(Schema schema) {
String name = schema.getProp(GenericData.STRING_PROP);
Modified:
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/generic/GenericRecordBuilder.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/avro/src/main/java/org/apache/avro/generic/GenericRecordBuilder.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
---
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/generic/GenericRecordBuilder.java
(original)
+++
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/generic/GenericRecordBuilder.java
Thu Jan 9 23:13:32 2014
@@ -116,7 +116,7 @@ public class GenericRecordBuilder extend
/**
* Sets the value of a field.
- * @param field the field to set.
+ * @param pos the field to set.
* @param value the value to set.
* @return a reference to the RecordBuilder.
*/
Modified:
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/io/Encoder.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/avro/src/main/java/org/apache/avro/io/Encoder.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
--- avro/trunk/lang/java/avro/src/main/java/org/apache/avro/io/Encoder.java
(original)
+++ avro/trunk/lang/java/avro/src/main/java/org/apache/avro/io/Encoder.java Thu
Jan 9 23:13:32 2014
@@ -166,7 +166,7 @@ public abstract class Encoder implements
writeFixed(bytes, 0, bytes.length);
}
- /** A version of {@link writeFixed} for ByteBuffers. */
+ /** Writes a fixed from a ByteBuffer. */
public void writeFixed(ByteBuffer bytes) throws IOException {
int pos = bytes.position();
int len = bytes.limit() - pos;
Modified:
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/io/parsing/Symbol.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/avro/src/main/java/org/apache/avro/io/parsing/Symbol.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
---
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/io/parsing/Symbol.java
(original)
+++
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/io/parsing/Symbol.java
Thu Jan 9 23:13:32 2014
@@ -116,7 +116,6 @@ public abstract class Symbol {
/**
* A convenience method to construct an ErrorAction.
* @param e
- * @return
*/
static Symbol error(String e) {
return new ErrorAction(e);
Modified:
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/reflect/package.html
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/avro/src/main/java/org/apache/avro/reflect/package.html?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
---
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/reflect/package.html
(original)
+++
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/reflect/package.html
Thu Jan 9 23:13:32 2014
@@ -80,7 +80,7 @@ toString} method.
<p>Fields annotated with {@link org.apache.avro.reflect.AvroIgnore AvroIgnore}
will not be written or read to.
-<p> The {@link org.apache.avro.reflect.Avroname AvroName} annotation renames
+<p> The {@link org.apache.avro.reflect.AvroName AvroName} annotation renames
the field in the schema to the given name. The reflect datum reader will look
for a schema field with the given name, when trying to read into such an
annotated java field.
@@ -88,6 +88,9 @@ annotated java field.
<p>The {@link org.apache.avro.reflect.AvroMeta AvroMeta} annotation adds an
arbitrary key:value pair in the schema at the node of the java field.
+<p>The {@link org.apache.avro.reflect.AvroSchema AvroSchema} annotation forces
+the use of an custom schema.
+
<p>The {@link org.apache.avro.reflect.AvroEncode AvroEncode} annotation forces
the use of an custom encoder. This annotation overrides
{@link org.apache.avro.reflect.Stringable Stringable} and
Modified:
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/specific/SpecificData.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/avro/src/main/java/org/apache/avro/specific/SpecificData.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
---
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/specific/SpecificData.java
(original)
+++
avro/trunk/lang/java/avro/src/main/java/org/apache/avro/specific/SpecificData.java
Thu Jan 9 23:13:32 2014
@@ -334,7 +334,7 @@ public class SpecificData extends Generi
/** Tag interface that indicates that a class has a one-argument constructor
* that accepts a Schema.
- * @see SpecificDatumReader#newInstance
+ * @see #newInstance
*/
public interface SchemaConstructable {}
Modified:
avro/trunk/lang/java/compiler/src/main/velocity/org/apache/avro/compiler/specific/templates/java/classic/record.vm
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/compiler/src/main/velocity/org/apache/avro/compiler/specific/templates/java/classic/record.vm?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
---
avro/trunk/lang/java/compiler/src/main/velocity/org/apache/avro/compiler/specific/templates/java/classic/record.vm
(original)
+++
avro/trunk/lang/java/compiler/src/main/velocity/org/apache/avro/compiler/specific/templates/java/classic/record.vm
Thu Jan 9 23:13:32 2014
@@ -62,7 +62,7 @@ public class ${this.mangle($schema.getNa
/**
* Default constructor. Note that this does not initialize fields
* to their default values from the schema. If that is desired then
- * one should use {@link \#newBuilder()}.
+ * one should use <code>newBuilder()</code>.
*/
public ${this.mangle($schema.getName())}() {}
Modified:
avro/trunk/lang/java/ipc/src/main/java/org/apache/avro/ipc/Callback.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/ipc/src/main/java/org/apache/avro/ipc/Callback.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
--- avro/trunk/lang/java/ipc/src/main/java/org/apache/avro/ipc/Callback.java
(original)
+++ avro/trunk/lang/java/ipc/src/main/java/org/apache/avro/ipc/Callback.java
Thu Jan 9 23:13:32 2014
@@ -21,7 +21,7 @@ package org.apache.avro.ipc;
/**
* Interface for receiving asynchronous callbacks.
* For each request with an asynchronous callback,
- * either {@link #handleResult(Object)} or {@link #handleError(Exception)}
+ * either {@link #handleResult(Object)} or {@link #handleError(Throwable)}
* will be invoked.
*/
public interface Callback<T> {
Modified:
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/file/HadoopCodecFactory.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/file/HadoopCodecFactory.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
---
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/file/HadoopCodecFactory.java
(original)
+++
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/file/HadoopCodecFactory.java
Thu Jan 9 23:13:32 2014
@@ -35,9 +35,6 @@ import org.apache.avro.file.CodecFactory
* <li>{@code org.apache.hadoop.io.compress.BZip2Codec} will map to {@code
zbip2}</li>
* <li>{@code org.apache.hadoop.io.compress.GZipCodec} will map to {@code
deflate}</li>
* </ul>
- *
- * New and custom codecs can be registered using {@link #addCodec(String,
- * CodecFactory)}.
*/
public class HadoopCodecFactory {
Modified:
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroDeserializer.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroDeserializer.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
---
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroDeserializer.java
(original)
+++
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroDeserializer.java
Thu Jan 9 23:13:32 2014
@@ -39,7 +39,7 @@ import org.apache.hadoop.io.serializer.D
* by this class.</p>
*
* <p>MapReduce jobs that use AvroWrapper objects as keys or values need to be
- * configured with {@link org.apache.avro.io.AvroSerialization}. Use {@link
+ * configured with {@link AvroSerialization}. Use {@link
* org.apache.avro.mapreduce.AvroJob} to help with Job configuration.</p>
*
* @param <T> The type of Avro wrapper.
Modified:
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroKeyDeserializer.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroKeyDeserializer.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
---
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroKeyDeserializer.java
(original)
+++
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroKeyDeserializer.java
Thu Jan 9 23:13:32 2014
@@ -28,7 +28,7 @@ import org.apache.avro.mapred.AvroWrappe
*
* @param <D> The java type of the avro data to deserialize.
*
- * @see org.apache.avro.io.AvroDeserializer
+ * @see AvroDeserializer
*/
public class AvroKeyDeserializer<D> extends AvroDeserializer<AvroWrapper<D>,
D> {
/**
Modified:
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroSerializer.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroSerializer.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
---
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroSerializer.java
(original)
+++
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroSerializer.java
Thu Jan 9 23:13:32 2014
@@ -38,7 +38,7 @@ import org.apache.hadoop.io.serializer.S
* class.</p>
*
* <p>MapReduce jobs that use AvroWrapper objects as keys or values need to be
configured
- * with {@link org.apache.avro.io.AvroSerialization}. Use {@link
+ * with {@link AvroSerialization}. Use {@link
* org.apache.avro.mapreduce.AvroJob} to help with Job configuration.</p>
*
* @param <T> The Java type of the Avro data.
Modified:
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroValueDeserializer.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroValueDeserializer.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
---
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroValueDeserializer.java
(original)
+++
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroValueDeserializer.java
Thu Jan 9 23:13:32 2014
@@ -28,7 +28,7 @@ import org.apache.avro.mapred.AvroWrappe
*
* @param <D> The java type of the avro data to deserialize.
*
- * @see org.apache.avro.io.AvroDeserializer
+ * @see AvroDeserializer
*/
public class AvroValueDeserializer<D> extends AvroDeserializer<AvroWrapper<D>,
D> {
/**
Modified:
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/mapred/AvroMultipleOutputs.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/mapred/AvroMultipleOutputs.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
---
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/mapred/AvroMultipleOutputs.java
(original)
+++
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/mapred/AvroMultipleOutputs.java
Thu Jan 9 23:13:32 2014
@@ -325,7 +325,7 @@ public class AvroMultipleOutputs {
* By default these counters are disabled.
* <p/>
* MultipleOutputs supports counters, by default the are disabled.
- * The counters group is the {@link MultipleOutputs} class name.
+ * The counters group is the {@link AvroMultipleOutputs} class name.
* </p>
* The names of the counters are the same as the named outputs. For multi
* named outputs the name of the counter is the concatenation of the named
@@ -344,7 +344,7 @@ public class AvroMultipleOutputs {
* By default these counters are disabled.
* <p/>
* MultipleOutputs supports counters, by default the are disabled.
- * The counters group is the {@link MultipleOutputs} class name.
+ * The counters group is the {@link AvroMultipleOutputs} class name.
* </p>
* The names of the counters are the same as the named outputs. For multi
* named outputs the name of the counter is the concatenation of the named
@@ -452,7 +452,6 @@ public class AvroMultipleOutputs {
* @param namedOutput the named output name
* @param reporter the reporter
* @param datum output data
- * @return void
* @throws IOException thrown if output collector could not be created
*/
public void collect(String namedOutput, Reporter reporter,Object datum)
throws IOException{
@@ -467,7 +466,6 @@ public class AvroMultipleOutputs {
* @param reporter the reporter
* @param datum output data
* @param schema schema to use for this output
- * @return void
* @throws IOException thrown if output collector could not be created
*/
public void collect(String namedOutput, Reporter reporter, Schema
schema,Object datum) throws IOException{
@@ -483,7 +481,6 @@ public class AvroMultipleOutputs {
* @param baseOutputPath outputfile name to use.
* @param datum output data
* @param schema schema to use for this output
- * @return void
* @throws IOException thrown if output collector could not be created
*/
public void collect(String namedOutput,Reporter reporter,Schema
schema,Object datum,String baseOutputPath) throws IOException{
@@ -498,7 +495,7 @@ public class AvroMultipleOutputs {
* @param reporter the reporter
* @return the output collector for the given named output
* @throws IOException thrown if output collector could not be created
- * @deprecated Use {@link collect} method for collecting output
+ * @deprecated Use {@link #collect} method for collecting output
*/
@SuppressWarnings({"unchecked", "rawtypes"})
public AvroCollector getCollector(String namedOutput, Reporter reporter)
Modified:
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/mapred/tether/TetherJob.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/mapred/tether/TetherJob.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
---
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/mapred/tether/TetherJob.java
(original)
+++
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/mapred/tether/TetherJob.java
Thu Jan 9 23:13:32 2014
@@ -61,7 +61,7 @@ public class TetherJob extends Configure
* and provides the mapper/reducer).
* @param job - Job
* @param executable - The URI of the executable
- * @param argstr - A string of additional arguments
+ * @param args - A string of additional arguments
* @param cached - If true, the executable URI is cached using
DistributedCache
* - if false its not cached. I.e if the file is already
stored on each local file system
* or if its on a NFS share
Modified:
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroMultipleOutputs.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroMultipleOutputs.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
---
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroMultipleOutputs.java
(original)
+++
avro/trunk/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroMultipleOutputs.java
Thu Jan 9 23:13:32 2014
@@ -271,7 +271,7 @@ public class AvroMultipleOutputs{
/**
* Enables or disables counters for the named outputs.
*
- * The counters group is the {@link MultipleOutputs} class name.
+ * The counters group is the {@link AvroMultipleOutputs} class name.
* The names of the counters are the same as the named outputs. These
* counters count the number records written to each output name.
* By default these counters are disabled.
Modified: avro/trunk/lang/java/pom.xml
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/pom.xml?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
--- avro/trunk/lang/java/pom.xml (original)
+++ avro/trunk/lang/java/pom.xml Thu Jan 9 23:13:32 2014
@@ -72,6 +72,7 @@
<jar-plugin.version>2.3.2</jar-plugin.version>
<javacc-plugin.version>2.6</javacc-plugin.version>
<javadoc-plugin.version>2.8</javadoc-plugin.version>
+ <plugin-tools-javadoc.version>3.2</plugin-tools-javadoc.version>
<maven-site-plugin.version>3.1</maven-site-plugin.version>
<plugin-plugin.version>2.9</plugin-plugin.version>
<source-plugin.version>2.1.2</source-plugin.version>
@@ -236,10 +237,17 @@
<version>${javadoc-plugin.version}</version>
<configuration>
<links>
-
<link>http://jackson.codehaus.org/${jackson.version}/javadoc/</link>
+ <link>http://jackson.codehaus.org/1.9.4/javadoc/</link>
<link>http://java.sun.com/products/servlet/2.3/javadoc/</link>
-
<link>http://hadoop.apache.org/common/docs/r${hadoop1.version}/api/</link>
+ <link>http://hadoop.apache.org/common/docs/current/api/</link>
</links>
+ <tagletArtifacts>
+ <tagletArtifact>
+ <groupId>org.apache.maven.plugin-tools</groupId>
+ <artifactId>maven-plugin-tools-javadoc</artifactId>
+ <version>${plugin-tools-javadoc.version}</version>
+ </tagletArtifact>
+ </tagletArtifacts>
</configuration>
</plugin>
<plugin>
Modified:
avro/trunk/lang/java/tools/src/test/compiler/output-string/avro/examples/baseball/Player.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/tools/src/test/compiler/output-string/avro/examples/baseball/Player.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
---
avro/trunk/lang/java/tools/src/test/compiler/output-string/avro/examples/baseball/Player.java
(original)
+++
avro/trunk/lang/java/tools/src/test/compiler/output-string/avro/examples/baseball/Player.java
Thu Jan 9 23:13:32 2014
@@ -17,7 +17,7 @@ public class Player extends org.apache.a
/**
* Default constructor. Note that this does not initialize fields
* to their default values from the schema. If that is desired then
- * one should use {@link \#newBuilder()}.
+ * one should use <code>newBuilder()</code>.
*/
public Player() {}
Modified: avro/trunk/lang/java/tools/src/test/compiler/output/Player.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/tools/src/test/compiler/output/Player.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
--- avro/trunk/lang/java/tools/src/test/compiler/output/Player.java (original)
+++ avro/trunk/lang/java/tools/src/test/compiler/output/Player.java Thu Jan 9
23:13:32 2014
@@ -17,7 +17,7 @@ public class Player extends org.apache.a
/**
* Default constructor. Note that this does not initialize fields
* to their default values from the schema. If that is desired then
- * one should use {@link \#newBuilder()}.
+ * one should use <code>newBuilder()</code>.
*/
public Player() {}
Modified:
avro/trunk/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/AvroTrevniInputFormat.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/AvroTrevniInputFormat.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
---
avro/trunk/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/AvroTrevniInputFormat.java
(original)
+++
avro/trunk/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/AvroTrevniInputFormat.java
Thu Jan 9 23:13:32 2014
@@ -40,7 +40,7 @@ import org.apache.avro.mapred.AvroWrappe
/** An {@link org.apache.hadoop.mapred.InputFormat} for Trevni files.
*
* <p>A subset schema to be read may be specified with {@link
- * AvroJob#setInputSchema(Schema)}.
+ * AvroJob#setInputSchema(JobConf,Schema)}.
*/
public class AvroTrevniInputFormat<T>
extends FileInputFormat<AvroWrapper<T>, NullWritable> {
Modified:
avro/trunk/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/mapreduce/AvroTrevniKeyInputFormat.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/mapreduce/AvroTrevniKeyInputFormat.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
---
avro/trunk/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/mapreduce/AvroTrevniKeyInputFormat.java
(original)
+++
avro/trunk/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/mapreduce/AvroTrevniKeyInputFormat.java
Thu Jan 9 23:13:32 2014
@@ -42,7 +42,7 @@ import org.apache.hadoop.mapreduce.lib.i
*
* <p>
* A subset schema to be read may be specified with
- * {@link AvroJob#setInputKeySchema(Schema)}.
+ * {@link org.apache.avro.mapreduce.AvroJob#setInputKeySchema}.
*/
public class AvroTrevniKeyInputFormat<T> extends FileInputFormat<AvroKey<T>,
NullWritable> {
Modified:
avro/trunk/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/mapreduce/AvroTrevniKeyValueInputFormat.java
URL:
http://svn.apache.org/viewvc/avro/trunk/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/mapreduce/AvroTrevniKeyValueInputFormat.java?rev=1556980&r1=1556979&r2=1556980&view=diff
==============================================================================
---
avro/trunk/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/mapreduce/AvroTrevniKeyValueInputFormat.java
(original)
+++
avro/trunk/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/mapreduce/AvroTrevniKeyValueInputFormat.java
Thu Jan 9 23:13:32 2014
@@ -46,8 +46,8 @@ import org.apache.hadoop.mapreduce.lib.i
*
* <p>
* A subset schema to be read may be specified with
- * {@link AvroJob#setInputKeySchema(Schema)} and
- * {@link AvroJob#setInputValueSchema(Schema)}..
+ * {@link org.apache.avro.mapreduce.AvroJob#setInputKeySchema} and
+ * {@link org.apache.avro.mapreduce.AvroJob#setInputValueSchema}.
*/
public class AvroTrevniKeyValueInputFormat<K, V> extends
FileInputFormat<AvroKey<K>, AvroValue<V>> {
