From da84609091876fbbb6775e0a9de1ea9f6afc3181 Mon Sep 17 00:00:00 2001 From: Oscar Vega-Gisbert Date: Thu, 14 Nov 2013 22:18:45 +0000 Subject: [PATCH] Update Javadoc This commit was SVN r29713. --- ompi/mpi/java/java/DoubleInt.java | 7 +++++-- ompi/mpi/java/java/FloatInt.java | 7 +++++-- ompi/mpi/java/java/Int2.java | 7 +++++-- ompi/mpi/java/java/LongInt.java | 7 +++++-- ompi/mpi/java/java/ShortInt.java | 7 +++++-- 5 files changed, 25 insertions(+), 10 deletions(-) diff --git a/ompi/mpi/java/java/DoubleInt.java b/ompi/mpi/java/java/DoubleInt.java index 0a95f1c00d..2bb1121f28 100644 --- a/ompi/mpi/java/java/DoubleInt.java +++ b/ompi/mpi/java/java/DoubleInt.java @@ -1,13 +1,16 @@ package mpi; /** - * Java binding of the MPI data type {@code MPI_DOUBLE_INT}. + * Struct class for {@link MPI#DOUBLE_INT} datatype. */ public final class DoubleInt extends Struct { private final int iOff, iSize; -/** The struct will be created only in MPI class. */ +/** + * The struct object will be created only in MPI class. + * @see MPI#doubleInt + */ protected DoubleInt(int intOff, int intSize) { int dOff = addDouble(); diff --git a/ompi/mpi/java/java/FloatInt.java b/ompi/mpi/java/java/FloatInt.java index 45fb343cc7..0fda199509 100644 --- a/ompi/mpi/java/java/FloatInt.java +++ b/ompi/mpi/java/java/FloatInt.java @@ -1,13 +1,16 @@ package mpi; /** - * Java binding of the MPI data type {@code MPI_FLOAT_INT}. + * Struct class for {@link MPI#FLOAT_INT} datatype. */ public final class FloatInt extends Struct { private final int iOff, iSize; -/** The struct will be created only in MPI class. */ +/** + * The struct object will be created only in MPI class. + * @see MPI#floatInt + */ protected FloatInt(int intOff, int intSize) { int fOff = addFloat(); diff --git a/ompi/mpi/java/java/Int2.java b/ompi/mpi/java/java/Int2.java index a8267c82d7..db2b6f84c8 100644 --- a/ompi/mpi/java/java/Int2.java +++ b/ompi/mpi/java/java/Int2.java @@ -1,13 +1,16 @@ package mpi; /** - * Java binding of the MPI data type {@code MPI_2INT}. + * Struct class for {@link MPI#INT2} datatype. */ public final class Int2 extends Struct { private final int iOff, iSize; -/** The struct will be created only in MPI class. */ +/** + * The struct object will be created only in MPI class. + * @see MPI#int2 + */ protected Int2(int intOff, int intSize) { iSize = intSize; diff --git a/ompi/mpi/java/java/LongInt.java b/ompi/mpi/java/java/LongInt.java index e960c25243..35316648ad 100644 --- a/ompi/mpi/java/java/LongInt.java +++ b/ompi/mpi/java/java/LongInt.java @@ -1,13 +1,16 @@ package mpi; /** - * Java binding of the MPI data type {@code MPI_LONG_INT}. + * Struct class for {@link MPI#LONG_INT} datatype. */ public final class LongInt extends Struct { private final int lSize, iOff, iSize; -/** The struct will be created only in MPI class. */ +/** + * The struct object will be created only in MPI class. + * @see MPI#longInt + */ protected LongInt(int longSize, int intOff, int intSize) { lSize = longSize; diff --git a/ompi/mpi/java/java/ShortInt.java b/ompi/mpi/java/java/ShortInt.java index 7f3eaf4c4d..98c6b19ca6 100644 --- a/ompi/mpi/java/java/ShortInt.java +++ b/ompi/mpi/java/java/ShortInt.java @@ -1,13 +1,16 @@ package mpi; /** - * Java binding of the MPI data type {@code MPI_SHORT_INT}. + * Struct class for {@link MPI#SHORT_INT} datatype. */ public final class ShortInt extends Struct { private final int sSize, iOff, iSize; -/** The struct will be created only in MPI class. */ +/** + * The struct object will be created only in MPI class. + * @see MPI#shortInt + */ protected ShortInt(int shortSize, int intOff, int intSize) { sSize = shortSize;