Skip to content

Commit

Permalink
Merge pull request protocolbuffers#1803 from xfxyjwf/javadoc
Browse files Browse the repository at this point in the history
Include javadoc/source in Java release packages.
  • Loading branch information
xfxyjwf authored Jul 19, 2016
2 parents 2078f61 + fa52702 commit 24ac9c0
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -490,7 +490,7 @@ public String toString() {

/**
* Used to support nested builders and called to mark this builder as clean.
* Clean builders will propagate the {@link BuildParent#markDirty()} event
* Clean builders will propagate the {@link BuilderParent#markDirty()} event
* to their parent builders, while dirty builders will not, as their parents
* should be dirty already.
*
Expand Down
4 changes: 2 additions & 2 deletions java/core/src/main/java/com/google/protobuf/ByteOutput.java
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@
* An output target for raw bytes. This interface provides semantics that support two types of
* writing:
*
* <p/><b>Traditional write operations:</b>
* <p><b>Traditional write operations:</b>
* (as defined by {@link java.io.OutputStream}) where the target method is responsible for either
* copying the data or completing the write before returning from the method call.
*
* <p/><b>Lazy write operations:</b> where the caller guarantees that it will never modify the
* <p><b>Lazy write operations:</b> where the caller guarantees that it will never modify the
* provided buffer and it can therefore be considered immutable. The target method is free to
* maintain a reference to the buffer beyond the scope of the method call (e.g. until the write
* operation completes).
Expand Down
20 changes: 10 additions & 10 deletions java/core/src/main/java/com/google/protobuf/Internal.java
Original file line number Diff line number Diff line change
Expand Up @@ -611,12 +611,12 @@ public static interface IntList extends ProtobufList<Integer> {
int getInt(int index);

/**
* Like {@link #add(Integer)} but more efficient in that it doesn't box the element.
* Like {@link #add(Object)} but more efficient in that it doesn't box the element.
*/
void addInt(int element);

/**
* Like {@link #set(int, Integer)} but more efficient in that it doesn't box the element.
* Like {@link #set(int, Object)} but more efficient in that it doesn't box the element.
*/
int setInt(int index, int element);

Expand All @@ -639,12 +639,12 @@ public static interface BooleanList extends ProtobufList<Boolean> {
boolean getBoolean(int index);

/**
* Like {@link #add(Boolean)} but more efficient in that it doesn't box the element.
* Like {@link #add(Object)} but more efficient in that it doesn't box the element.
*/
void addBoolean(boolean element);

/**
* Like {@link #set(int, Boolean)} but more efficient in that it doesn't box the element.
* Like {@link #set(int, Object)} but more efficient in that it doesn't box the element.
*/
boolean setBoolean(int index, boolean element);

Expand All @@ -667,12 +667,12 @@ public static interface LongList extends ProtobufList<Long> {
long getLong(int index);

/**
* Like {@link #add(Long)} but more efficient in that it doesn't box the element.
* Like {@link #add(Object)} but more efficient in that it doesn't box the element.
*/
void addLong(long element);

/**
* Like {@link #set(int, Long)} but more efficient in that it doesn't box the element.
* Like {@link #set(int, Object)} but more efficient in that it doesn't box the element.
*/
long setLong(int index, long element);

Expand All @@ -695,12 +695,12 @@ public static interface DoubleList extends ProtobufList<Double> {
double getDouble(int index);

/**
* Like {@link #add(Double)} but more efficient in that it doesn't box the element.
* Like {@link #add(Object)} but more efficient in that it doesn't box the element.
*/
void addDouble(double element);

/**
* Like {@link #set(int, Double)} but more efficient in that it doesn't box the element.
* Like {@link #set(int, Object)} but more efficient in that it doesn't box the element.
*/
double setDouble(int index, double element);

Expand All @@ -723,12 +723,12 @@ public static interface FloatList extends ProtobufList<Float> {
float getFloat(int index);

/**
* Like {@link #add(Float)} but more efficient in that it doesn't box the element.
* Like {@link #add(Object)} but more efficient in that it doesn't box the element.
*/
void addFloat(float element);

/**
* Like {@link #set(int, Float)} but more efficient in that it doesn't box the element.
* Like {@link #set(int, Object)} but more efficient in that it doesn't box the element.
*/
float setFloat(int index, float element);

Expand Down
2 changes: 1 addition & 1 deletion java/core/src/main/java/com/google/protobuf/Parser.java
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
*
* <p>All methods may throw {@link InvalidProtocolBufferException}. In the event of invalid data,
* like an encoding error, the cause of the thrown exception will be {@code null}. However, if an
* I/O problem occurs, an exception is thrown with an {@link IOException} cause.
* I/O problem occurs, an exception is thrown with an {@link java.io.IOException} cause.
*
* @author [email protected] (Pherl Liu)
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
*
* <p>The locations of primary fields values are retrieved by {@code getLocation} or
* {@code getLocations}. The locations of sub message values are within nested
* {@code TextFormatParseInfoTree}s and are retrieve by {@getNestedTree} or {code @getNestedTrees}.
* {@code TextFormatParseInfoTree}s and are retrieve by {@code getNestedTree} or {@code getNestedTrees}.
*
* <p>The {@code TextFormatParseInfoTree} is created by a Builder.
*/
Expand Down Expand Up @@ -197,7 +197,7 @@ public Builder setLocation(
* Set for a sub message.
*
* <p>A new builder is created for a sub message. The builder that is returned is a new builder.
* The return is <emph>not</emph> the invoked {@code builder.getBuilderForSubMessageField}.
* The return is <em>not</em> the invoked {@code builder.getBuilderForSubMessageField}.
*
* @param fieldDescriptor the field whose value is the submessage
* @return a new Builder for the sub message
Expand Down
26 changes: 26 additions & 0 deletions java/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,32 @@
<id>release</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>2.2.1</version>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9.1</version>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-gpg-plugin</artifactId>
<version>1.6</version>
Expand Down

0 comments on commit 24ac9c0

Please sign in to comment.