mirror/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2026-09-25 17:00:36 -09:00
Code Issues Packages Projects Releases Wiki Activity

Fix some Javadocs warnings

Browse Source 
> 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)
           ^
This commit is contained in:
Johannes Obermayr
2023-01-28 10:04:57 +01:00
parent da4bfdae97
commit 2a9986135e
3 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Ghidra/Features/Base/src/main/java/ghidra/program/database/ProgramBuilder.java
View File

@@ -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)

3
Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/IndexedLocalFileSystem.java
View File

@@ -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
*/

3
Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/IndexedV1LocalFileSystem.java
View File

@@ -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
*/