From 41ac815c4219b5790a8bc6fb67b9bbb5430519cf Mon Sep 17 00:00:00 2001 From: Rob Greene Date: Fri, 9 Mar 2018 22:49:40 -0600 Subject: [PATCH] Cleaning up Javadoc warnings and errors; removed "createDirectory()" method that maybe was part of the interface but no longer is (was replaced by createDirectory(name) which remains). --- .../com/webcodepro/applecommander/storage/Disk.java | 2 +- .../applecommander/storage/os/cpm/CpmFormatDisk.java | 10 +--------- .../applecommander/storage/os/dos33/DosFormatDisk.java | 10 +--------- .../storage/os/gutenberg/GutenbergFormatDisk.java | 10 +--------- .../storage/os/nakedos/NakedosFormatDisk.java | 10 +--------- .../storage/os/pascal/PascalFormatDisk.java | 10 +--------- .../storage/os/prodos/ProdosDirectoryEntry.java | 2 +- .../storage/os/prodos/ProdosFormatDisk.java | 3 +-- .../applecommander/storage/os/rdos/RdosFormatDisk.java | 10 +--------- .../webcodepro/applecommander/util/AppleSingle.java | 2 +- .../applecommander/util/ShrinkItUtilities.java | 3 +-- 11 files changed, 11 insertions(+), 61 deletions(-) diff --git a/src/main/java/com/webcodepro/applecommander/storage/Disk.java b/src/main/java/com/webcodepro/applecommander/storage/Disk.java index 9d9883d..c7a8355 100644 --- a/src/main/java/com/webcodepro/applecommander/storage/Disk.java +++ b/src/main/java/com/webcodepro/applecommander/storage/Disk.java @@ -880,7 +880,7 @@ public class Disk { /** * Find the standard sized disk that will fit the requested number of bytes. - * @returns int size of the disk if it will satisfy the request, -1 otherwise + * @return int size of the disk if it will satisfy the request, -1 otherwise */ public static int sizeToFit(long bytes) { if (bytes < APPLE_140KB_DISK) { diff --git a/src/main/java/com/webcodepro/applecommander/storage/os/cpm/CpmFormatDisk.java b/src/main/java/com/webcodepro/applecommander/storage/os/cpm/CpmFormatDisk.java index ac58216..3332f3b 100644 --- a/src/main/java/com/webcodepro/applecommander/storage/os/cpm/CpmFormatDisk.java +++ b/src/main/java/com/webcodepro/applecommander/storage/os/cpm/CpmFormatDisk.java @@ -531,18 +531,10 @@ public class CpmFormatDisk extends FormattedDisk { public void setFileData(FileEntry fileEntry, byte[] fileData) throws DiskFullException { // TODO implement setFileData } - - /** - * Create a new DirectoryEntry. - * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() - */ - public DirectoryEntry createDirectory() throws DiskFullException { - throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$ - } /** * Create a new DirectoryEntry. - * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() + * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory(String) */ public DirectoryEntry createDirectory(String name) throws DiskFullException { throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$ diff --git a/src/main/java/com/webcodepro/applecommander/storage/os/dos33/DosFormatDisk.java b/src/main/java/com/webcodepro/applecommander/storage/os/dos33/DosFormatDisk.java index 5448a33..a388271 100644 --- a/src/main/java/com/webcodepro/applecommander/storage/os/dos33/DosFormatDisk.java +++ b/src/main/java/com/webcodepro/applecommander/storage/os/dos33/DosFormatDisk.java @@ -758,15 +758,7 @@ public class DosFormatDisk extends FormattedDisk { /** * Create a new DirectoryEntry. - * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() - */ - public DirectoryEntry createDirectory() throws DiskFullException { - throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$ - } - - /** - * Create a new DirectoryEntry. - * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() + * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory(String) */ public DirectoryEntry createDirectory(String name) throws DiskFullException { throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$ diff --git a/src/main/java/com/webcodepro/applecommander/storage/os/gutenberg/GutenbergFormatDisk.java b/src/main/java/com/webcodepro/applecommander/storage/os/gutenberg/GutenbergFormatDisk.java index 2cb8cbb..75387ca 100644 --- a/src/main/java/com/webcodepro/applecommander/storage/os/gutenberg/GutenbergFormatDisk.java +++ b/src/main/java/com/webcodepro/applecommander/storage/os/gutenberg/GutenbergFormatDisk.java @@ -713,15 +713,7 @@ public class GutenbergFormatDisk extends FormattedDisk { /** * Create a new DirectoryEntry. - * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() - */ - public DirectoryEntry createDirectory() throws DiskFullException { - throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$ - } - - /** - * Create a new DirectoryEntry. - * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() + * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory(String) */ public DirectoryEntry createDirectory(String name) throws DiskFullException { throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$ diff --git a/src/main/java/com/webcodepro/applecommander/storage/os/nakedos/NakedosFormatDisk.java b/src/main/java/com/webcodepro/applecommander/storage/os/nakedos/NakedosFormatDisk.java index e15169e..c6f126f 100644 --- a/src/main/java/com/webcodepro/applecommander/storage/os/nakedos/NakedosFormatDisk.java +++ b/src/main/java/com/webcodepro/applecommander/storage/os/nakedos/NakedosFormatDisk.java @@ -527,15 +527,7 @@ public class NakedosFormatDisk extends FormattedDisk { /** * Create a new DirectoryEntry. - * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() - */ - public DirectoryEntry createDirectory() throws DiskFullException { - throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$ - } - - /** - * Create a new DirectoryEntry. - * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() + * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory(String) */ public DirectoryEntry createDirectory(String name) throws DiskFullException { throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$ diff --git a/src/main/java/com/webcodepro/applecommander/storage/os/pascal/PascalFormatDisk.java b/src/main/java/com/webcodepro/applecommander/storage/os/pascal/PascalFormatDisk.java index 82fab46..e3f2030 100644 --- a/src/main/java/com/webcodepro/applecommander/storage/os/pascal/PascalFormatDisk.java +++ b/src/main/java/com/webcodepro/applecommander/storage/os/pascal/PascalFormatDisk.java @@ -661,15 +661,7 @@ public class PascalFormatDisk extends FormattedDisk { /** * Create a new DirectoryEntry. - * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() - */ - public DirectoryEntry createDirectory() throws DiskFullException { - throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$ - } - - /** - * Create a new DirectoryEntry. - * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() + * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory(String) */ public DirectoryEntry createDirectory(String name) throws DiskFullException { throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$ diff --git a/src/main/java/com/webcodepro/applecommander/storage/os/prodos/ProdosDirectoryEntry.java b/src/main/java/com/webcodepro/applecommander/storage/os/prodos/ProdosDirectoryEntry.java index bee6f14..f23928a 100644 --- a/src/main/java/com/webcodepro/applecommander/storage/os/prodos/ProdosDirectoryEntry.java +++ b/src/main/java/com/webcodepro/applecommander/storage/os/prodos/ProdosDirectoryEntry.java @@ -98,7 +98,7 @@ public class ProdosDirectoryEntry extends ProdosFileEntry implements DirectoryEn /** * Create a new DirectoryEntry. - * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() + * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory(String) */ public DirectoryEntry createDirectory(String name) throws DiskFullException { return getDisk().createDirectory(getSubdirectoryHeader(), name); diff --git a/src/main/java/com/webcodepro/applecommander/storage/os/prodos/ProdosFormatDisk.java b/src/main/java/com/webcodepro/applecommander/storage/os/prodos/ProdosFormatDisk.java index 03cbbb6..4bfc218 100644 --- a/src/main/java/com/webcodepro/applecommander/storage/os/prodos/ProdosFormatDisk.java +++ b/src/main/java/com/webcodepro/applecommander/storage/os/prodos/ProdosFormatDisk.java @@ -1343,7 +1343,7 @@ public class ProdosFormatDisk extends FormattedDisk { /** * Create a new DirectoryEntry. - * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() + * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory(String) */ public DirectoryEntry createDirectory(String name) throws DiskFullException { return createDirectory(getVolumeHeader(), name); @@ -1351,7 +1351,6 @@ public class ProdosFormatDisk extends FormattedDisk { /** * Create a new DirectoryEntry. - * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() */ public DirectoryEntry createDirectory(ProdosCommonDirectoryHeader directory, String name) throws DiskFullException { int blockNumber = directory.getFileEntryBlock(); diff --git a/src/main/java/com/webcodepro/applecommander/storage/os/rdos/RdosFormatDisk.java b/src/main/java/com/webcodepro/applecommander/storage/os/rdos/RdosFormatDisk.java index ef1eeb4..a445342 100644 --- a/src/main/java/com/webcodepro/applecommander/storage/os/rdos/RdosFormatDisk.java +++ b/src/main/java/com/webcodepro/applecommander/storage/os/rdos/RdosFormatDisk.java @@ -504,15 +504,7 @@ public class RdosFormatDisk extends FormattedDisk { /** * Create a new DirectoryEntry. - * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() - */ - public DirectoryEntry createDirectory() throws DiskFullException { - throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$ - } - - /** - * Create a new DirectoryEntry. - * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() + * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory(String) */ public DirectoryEntry createDirectory(String name) throws DiskFullException { throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$ diff --git a/src/main/java/com/webcodepro/applecommander/util/AppleSingle.java b/src/main/java/com/webcodepro/applecommander/util/AppleSingle.java index 3246ca8..edc4acb 100644 --- a/src/main/java/com/webcodepro/applecommander/util/AppleSingle.java +++ b/src/main/java/com/webcodepro/applecommander/util/AppleSingle.java @@ -12,7 +12,7 @@ import java.nio.file.Paths; * Support reading of data from and AppleSingle source. * Does not implement all components at this time, extend as required. * - * @see https://github.com/AppleCommander/AppleCommander/issues/20 + * @see AppleCommander issue #20 */ public class AppleSingle { public static final int MAGIC_NUMBER = 0x0051600; diff --git a/src/main/java/com/webcodepro/applecommander/util/ShrinkItUtilities.java b/src/main/java/com/webcodepro/applecommander/util/ShrinkItUtilities.java index 6fc04dc..1052470 100644 --- a/src/main/java/com/webcodepro/applecommander/util/ShrinkItUtilities.java +++ b/src/main/java/com/webcodepro/applecommander/util/ShrinkItUtilities.java @@ -25,7 +25,6 @@ import java.io.IOException; import java.io.InputStream; import com.webcodepro.applecommander.storage.Disk; -import com.webcodepro.applecommander.storage.FileEntry; import com.webcodepro.applecommander.storage.FormattedDisk; import com.webcodepro.applecommander.storage.StorageBundle; import com.webcodepro.applecommander.storage.os.prodos.ProdosFileEntry; @@ -184,7 +183,7 @@ public class ShrinkItUtilities * * Reads the data from a thread * - * @returns byte[] buffer, possibly null + * @return byte[] buffer, possibly null */ public static byte[] readThread(ThreadRecord thread) throws IOException {