From 60d3fa2ed86defdb5b8168a6fff6edbeaac806fe Mon Sep 17 00:00:00 2001
From: Paul Sandoz <psandoz@openjdk.org>
Date: Wed, 21 Oct 2020 22:27:42 +0000
Subject: [PATCH] 8255022: Documentation missing for Vector API zero methods

Reviewed-by: vlivanov, darcy
---
 .../share/classes/jdk/incubator/vector/ByteVector.java     | 7 ++++++-
 .../share/classes/jdk/incubator/vector/DoubleVector.java   | 7 ++++++-
 .../share/classes/jdk/incubator/vector/FloatVector.java    | 7 ++++++-
 .../share/classes/jdk/incubator/vector/IntVector.java      | 7 ++++++-
 .../share/classes/jdk/incubator/vector/LongVector.java     | 7 ++++++-
 .../share/classes/jdk/incubator/vector/ShortVector.java    | 7 ++++++-
 .../classes/jdk/incubator/vector/X-Vector.java.template    | 7 ++++++-
 7 files changed, 42 insertions(+), 7 deletions(-)

diff --git a/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/ByteVector.java b/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/ByteVector.java
index 32332342c72..c9236bd1f21 100644
--- a/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/ByteVector.java
+++ b/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/ByteVector.java
@@ -423,7 +423,12 @@ public abstract class ByteVector extends AbstractVector<Byte> {
     // comment <!--workaround--> for this.
 
     /**
-     * {@inheritDoc} <!--workaround-->
+     * Returns a vector of the given species
+     * where all lane elements are set to
+     * zero, the default primitive value.
+     *
+     * @param species species of the desired zero vector
+     * @return a zero vector
      */
     @ForceInline
     public static ByteVector zero(VectorSpecies<Byte> species) {
diff --git a/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/DoubleVector.java b/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/DoubleVector.java
index 1ec0f549472..637a7a284bf 100644
--- a/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/DoubleVector.java
+++ b/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/DoubleVector.java
@@ -423,7 +423,12 @@ public abstract class DoubleVector extends AbstractVector<Double> {
     // comment <!--workaround--> for this.
 
     /**
-     * {@inheritDoc} <!--workaround-->
+     * Returns a vector of the given species
+     * where all lane elements are set to
+     * zero, the default primitive value.
+     *
+     * @param species species of the desired zero vector
+     * @return a zero vector
      */
     @ForceInline
     public static DoubleVector zero(VectorSpecies<Double> species) {
diff --git a/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/FloatVector.java b/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/FloatVector.java
index 2eb950f3cc9..d85e3628d88 100644
--- a/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/FloatVector.java
+++ b/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/FloatVector.java
@@ -423,7 +423,12 @@ public abstract class FloatVector extends AbstractVector<Float> {
     // comment <!--workaround--> for this.
 
     /**
-     * {@inheritDoc} <!--workaround-->
+     * Returns a vector of the given species
+     * where all lane elements are set to
+     * zero, the default primitive value.
+     *
+     * @param species species of the desired zero vector
+     * @return a zero vector
      */
     @ForceInline
     public static FloatVector zero(VectorSpecies<Float> species) {
diff --git a/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/IntVector.java b/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/IntVector.java
index a0af5a41fe9..79318a0ff13 100644
--- a/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/IntVector.java
+++ b/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/IntVector.java
@@ -423,7 +423,12 @@ public abstract class IntVector extends AbstractVector<Integer> {
     // comment <!--workaround--> for this.
 
     /**
-     * {@inheritDoc} <!--workaround-->
+     * Returns a vector of the given species
+     * where all lane elements are set to
+     * zero, the default primitive value.
+     *
+     * @param species species of the desired zero vector
+     * @return a zero vector
      */
     @ForceInline
     public static IntVector zero(VectorSpecies<Integer> species) {
diff --git a/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/LongVector.java b/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/LongVector.java
index ca5168dc9ac..d0225ac4654 100644
--- a/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/LongVector.java
+++ b/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/LongVector.java
@@ -423,7 +423,12 @@ public abstract class LongVector extends AbstractVector<Long> {
     // comment <!--workaround--> for this.
 
     /**
-     * {@inheritDoc} <!--workaround-->
+     * Returns a vector of the given species
+     * where all lane elements are set to
+     * zero, the default primitive value.
+     *
+     * @param species species of the desired zero vector
+     * @return a zero vector
      */
     @ForceInline
     public static LongVector zero(VectorSpecies<Long> species) {
diff --git a/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/ShortVector.java b/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/ShortVector.java
index aaa6afc7199..712b0ab78e3 100644
--- a/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/ShortVector.java
+++ b/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/ShortVector.java
@@ -423,7 +423,12 @@ public abstract class ShortVector extends AbstractVector<Short> {
     // comment <!--workaround--> for this.
 
     /**
-     * {@inheritDoc} <!--workaround-->
+     * Returns a vector of the given species
+     * where all lane elements are set to
+     * zero, the default primitive value.
+     *
+     * @param species species of the desired zero vector
+     * @return a zero vector
      */
     @ForceInline
     public static ShortVector zero(VectorSpecies<Short> species) {
diff --git a/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/X-Vector.java.template b/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/X-Vector.java.template
index 9b110b16e33..15c32cb01c8 100644
--- a/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/X-Vector.java.template
+++ b/src/jdk.incubator.vector/share/classes/jdk/incubator/vector/X-Vector.java.template
@@ -427,7 +427,12 @@ public abstract class $abstractvectortype$ extends AbstractVector<$Boxtype$> {
     // comment <!--workaround--> for this.
 
     /**
-     * {@inheritDoc} <!--workaround-->
+     * Returns a vector of the given species
+     * where all lane elements are set to
+     * zero, the default primitive value.
+     *
+     * @param species species of the desired zero vector
+     * @return a zero vector
      */
     @ForceInline
     public static $abstractvectortype$ zero(VectorSpecies<$Boxtype$> species) {