From 2a9986135ea0b9c7d8a6b0f404440e9bbf9e54f7 Mon Sep 17 00:00:00 2001 From: Johannes Obermayr Date: Sat, 28 Jan 2023 10:04:57 +0100 Subject: [PATCH] Fix some Javadocs warnings > Task :createJavadocs /tmp/ghidra/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/IndexedV1LocalFileSystem.java:40: warning: @param argument "file" is not a parameter name. * @param file path path for root directory. ^ /tmp/ghidra/Ghidra/Features/Base/src/main/java/ghidra/program/database/ProgramBuilder.java:147: warning: @param argument "compilerSpecID" is not a parameter name. * @param compilerSpecID compiler specification ID (if null default spec will be used) ^ /tmp/ghidra/Ghidra/Features/Base/src/main/java/ghidra/program/database/ProgramBuilder.java:148: warning: @param argument "consumer" is not a parameter name. * @param consumer program consumer (if null this builder will be used as consumer and must be disposed to release program) ^ --- .../src/main/java/ghidra/program/database/ProgramBuilder.java | 2 -- .../ghidra/framework/store/local/IndexedLocalFileSystem.java | 3 ++- .../ghidra/framework/store/local/IndexedV1LocalFileSystem.java | 3 ++- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/database/ProgramBuilder.java b/Ghidra/Features/Base/src/main/java/ghidra/program/database/ProgramBuilder.java index 9186bc7367..65ff5f153f 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/program/database/ProgramBuilder.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/program/database/ProgramBuilder.java @@ -144,8 +144,6 @@ public class ProgramBuilder { * Construct program builder using a full language object rather than a language id string * @param name program name * @param language Language object - * @param compilerSpecID compiler specification ID (if null default spec will be used) - * @param consumer program consumer (if null this builder will be used as consumer and must be disposed to release program) * @throws Exception if there is an exception creating the program */ public ProgramBuilder(String name, Language language) diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/IndexedLocalFileSystem.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/IndexedLocalFileSystem.java index 0222a5011c..b51ea98ee5 100644 --- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/IndexedLocalFileSystem.java +++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/IndexedLocalFileSystem.java @@ -81,12 +81,13 @@ public class IndexedLocalFileSystem extends LocalFileSystem { /** * Constructor. - * @param rootPath path path for root directory. + * @param rootPath path for root directory. * @param isVersioned if true item versioning will be enabled. * @param readOnly if true modifications within this file-system will not be allowed * and result in an ReadOnlyException * @param enableAsyncronousDispatching if true a separate dispatch thread will be used * to notify listeners. If false, blocking notification will be performed. + * @param create if true a new folder will be created. * @throws FileNotFoundException if specified rootPath does not exist * @throws IOException if error occurs while reading/writing index files */ diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/IndexedV1LocalFileSystem.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/IndexedV1LocalFileSystem.java index 6c8cc9a542..2d8f1a5134 100644 --- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/IndexedV1LocalFileSystem.java +++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/IndexedV1LocalFileSystem.java @@ -37,12 +37,13 @@ public class IndexedV1LocalFileSystem extends IndexedLocalFileSystem { /** * Constructor. - * @param file path path for root directory. + * @param rootPath path for root directory. * @param isVersioned if true item versioning will be enabled. * @param readOnly if true modifications within this file-system will not be allowed * and result in an ReadOnlyException * @param enableAsyncronousDispatching if true a separate dispatch thread will be used * to notify listeners. If false, blocking notification will be performed. + * @param create if true a new folder will be created. * @throws FileNotFoundException if specified rootPath does not exist * @throws IOException if error occurs while reading/writing index files */