diff options
| author | Manuel Bentele | 2021-04-30 12:11:32 +0200 |
|---|---|---|
| committer | Manuel Bentele | 2021-04-30 12:11:32 +0200 |
| commit | c5d35cf6b739444ba0d065203d8f21db86d0c8c1 (patch) | |
| tree | eddaec6e855af1af223d842efc33da226c916c0a /src/main/java/org/openslx/vm | |
| parent | Add unit tests for transformation logic (dozmod-server --> stateless client) (diff) | |
| download | master-sync-shared-c5d35cf6b739444ba0d065203d8f21db86d0c8c1.tar.gz master-sync-shared-c5d35cf6b739444ba0d065203d8f21db86d0c8c1.tar.xz master-sync-shared-c5d35cf6b739444ba0d065203d8f21db86d0c8c1.zip | |
Fix errors in Javadoc comments
Diffstat (limited to 'src/main/java/org/openslx/vm')
4 files changed, 9 insertions, 8 deletions
diff --git a/src/main/java/org/openslx/vm/disk/DiskImage.java b/src/main/java/org/openslx/vm/disk/DiskImage.java index 309ad77..d2cd71b 100644 --- a/src/main/java/org/openslx/vm/disk/DiskImage.java +++ b/src/main/java/org/openslx/vm/disk/DiskImage.java @@ -194,7 +194,7 @@ public abstract class DiskImage /** * Checks if the disk image format is supported by a virtualizer. * - * @param supportedImageTypes list of supported disk image formats of a virtualizer. + * @param supportedImageFormats list of supported disk image formats of a virtualizer. * @return <code>true</code> if image type is supported by the virtualizer; otherwise * <code>false</code>. */ diff --git a/src/main/java/org/openslx/vm/disk/DiskImageQcow2.java b/src/main/java/org/openslx/vm/disk/DiskImageQcow2.java index 04e61ea..657c144 100644 --- a/src/main/java/org/openslx/vm/disk/DiskImageQcow2.java +++ b/src/main/java/org/openslx/vm/disk/DiskImageQcow2.java @@ -51,7 +51,7 @@ public class DiskImageQcow2 extends DiskImage /** * Creates a new QCOW2 disk image from an existing QCOW2 image file. * - * @param diskImage file to a QCOW2 disk storing the image content. + * @param disk file to a QCOW2 disk storing the image content. * * @throws FileNotFoundException cannot find specified QCOW2 disk image file. * @throws IOException cannot access the content of the QCOW2 disk image file. @@ -64,7 +64,7 @@ public class DiskImageQcow2 extends DiskImage /** * Creates a new QCOW2 disk image from an existing QCOW2 image file. * - * @param diskImage file to a QCOW2 disk storing the image content. + * @param disk file to a QCOW2 disk storing the image content. */ public DiskImageQcow2( RandomAccessFile disk ) { diff --git a/src/main/java/org/openslx/vm/disk/DiskImageUtils.java b/src/main/java/org/openslx/vm/disk/DiskImageUtils.java index cc29721..ccb053f 100644 --- a/src/main/java/org/openslx/vm/disk/DiskImageUtils.java +++ b/src/main/java/org/openslx/vm/disk/DiskImageUtils.java @@ -114,12 +114,12 @@ public class DiskImageUtils } /** - * Reads two bytes ({@link Short}) at a given <code>offset</code> from the specified disk image - * file. + * Reads a variable number of bytes (<code>numBytes</code>) at a given <code>offset</code> from the specified disk image file. * * @param diskImage file to a disk storing the image content. - * @param offset offset in bytes for reading the two bytes. - * @return value of the two bytes from the disk image file as {@link Short}. + * @param offset offset in bytes for reading <code>numBytes</code> bytes. + * @param numBytes number of bytes to read at <code>offset</code>. + * @return read bytes from the disk image file as {@link String}. * * @throws DiskImageException unable to read two bytes from the disk image file. */ diff --git a/src/main/java/org/openslx/vm/disk/DiskImageVmdk.java b/src/main/java/org/openslx/vm/disk/DiskImageVmdk.java index 7f59bc3..b2f45a1 100644 --- a/src/main/java/org/openslx/vm/disk/DiskImageVmdk.java +++ b/src/main/java/org/openslx/vm/disk/DiskImageVmdk.java @@ -183,7 +183,8 @@ public class DiskImageVmdk extends DiskImage * * @return hardware version from the VMDK's embedded descriptor file. * - * @throws DiskImageException + * @throws DiskImageException unable to obtain the VMDK's hardware version of the disk image + * format. */ public Version getHwVersion() throws DiskImageException { |