Enable the bundle.
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/swift/SwiftUtils.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/swift/SwiftUtils.java
index d7af019d79..6bb4ad673d 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/swift/SwiftUtils.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/swift/SwiftUtils.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -60,10 +60,10 @@ public class SwiftUtils {
}
/**
- * Checks if the given {@List} of section names contains a Swift section name
+ * Checks if the given {@link List} of section names contains a Swift section name
*
* @param sectionNames The {@link List} of section names to check
- * @return True if the given {@List} of section names contains a Swift section name; otherwise,
+ * @return True if the given {@link List} of section names contains a Swift section name; otherwise,
* false
*/
public static boolean isSwift(List
* @implNote Clients should avoid frequent calls to this method. Even though it can be
* implemented easily in log time, an invocation for every pixel or line of pixels
* painted could still be unnecessarily expensive. It should only be necessary to call
diff --git a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/android/art/ArtImageSectionsFactory.java b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/android/art/ArtImageSectionsFactory.java
index 710fa6fa2d..8e9e9086bb 100644
--- a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/android/art/ArtImageSectionsFactory.java
+++ b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/android/art/ArtImageSectionsFactory.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -27,7 +27,7 @@ public final class ArtImageSectionsFactory {
* this method will return the appropriate section one.
* @param reader the binary reader for the ART file
* @param artHeader the ART Header containing the sections
- * @returns the ImageSections for the specified ART version
+ * @return the ImageSections for the specified ART version
*/
public static ArtImageSections getArtImageSections(BinaryReader reader, ArtHeader artHeader)
throws IOException {
diff --git a/Ghidra/Framework/DB/src/main/java/db/BTreeNode.java b/Ghidra/Framework/DB/src/main/java/db/BTreeNode.java
index 171007cc8b..1c843c4550 100644
--- a/Ghidra/Framework/DB/src/main/java/db/BTreeNode.java
+++ b/Ghidra/Framework/DB/src/main/java/db/BTreeNode.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -91,9 +91,8 @@ interface BTreeNode {
* @return true if consistency check passed, else false
* @param tableName name of table containing this node
* @param monitor task monitor
- * @throws IOException if IO error occured
+ * @throws IOException if IO error occurred
* @throws CancelledException if task cancelled
- * @{@link ThrowsTag} CancelledException
*/
public boolean isConsistent(String tableName, TaskMonitor monitor)
throws IOException, CancelledException;
diff --git a/Ghidra/Framework/DB/src/main/java/db/FixedKeyVarRecNode.java b/Ghidra/Framework/DB/src/main/java/db/FixedKeyVarRecNode.java
index 3aae93e498..5f6569b2d4 100644
--- a/Ghidra/Framework/DB/src/main/java/db/FixedKeyVarRecNode.java
+++ b/Ghidra/Framework/DB/src/main/java/db/FixedKeyVarRecNode.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -224,7 +224,7 @@ class FixedKeyVarRecNode extends FixedKeyRecordNode {
/**
* Find the index which represents the halfway point within the record data.
- * @returns key index.
+ * @return key index.
*/
private int getSplitIndex() {
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/EmptyTextField.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/EmptyTextField.java
index a0d7006016..8f578c46dd 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/EmptyTextField.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/EmptyTextField.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -56,7 +56,7 @@ public class EmptyTextField implements Field {
/**
* Returns true if the cursor is allowed past the last character. This
* field always returns false since there is no text.
- * @returns true if the cursor is allowed past the last character
+ * @return true if the cursor is allowed past the last character
*/
public boolean isAllowCursorAtEnd() {
return false;
diff --git a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/SleighInstructionDecoder.java b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/SleighInstructionDecoder.java
index c494c90121..2271de0860 100644
--- a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/SleighInstructionDecoder.java
+++ b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/SleighInstructionDecoder.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -56,10 +56,10 @@ public class SleighInstructionDecoder implements InstructionDecoder {
/**
* Construct a Sleigh instruction decoder
*
- * @see {@link DefaultPcodeThread#createInstructionDecoder(PcodeExecutorState)}
* @param language the language to decoder
* @param state the state containing the target program, probably the shared state of the p-code
* machine. It must be possible to obtain concrete buffers on this state.
+ * @see DefaultPcodeThread#createInstructionDecoder(PcodeExecutorState)
*/
public SleighInstructionDecoder(Language language, PcodeExecutorState> state) {
this.language = language;
diff --git a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/ThreadPcodeExecutorState.java b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/ThreadPcodeExecutorState.java
index 75b6be335c..de88b6acfb 100644
--- a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/ThreadPcodeExecutorState.java
+++ b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/ThreadPcodeExecutorState.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -40,9 +40,9 @@ public class ThreadPcodeExecutorState
* Note: directory may or may not exist.
* @return project location directory
*/
@@ -176,29 +177,28 @@ public class ProjectLocator {
}
/**
- * @returns the project directory
+ * {@return the project directory}
*/
public File getProjectDir() {
return new File(location, name + PROJECT_DIR_SUFFIX);
}
/**
- * @returns the file that indicates a Ghidra project.
+ * {@return the file that indicates a Ghidra project.}
*/
public File getMarkerFile() {
return new File(location, name + PROJECT_FILE_SUFFIX);
}
/**
- * @returns project lock file to prevent multiple accesses to the
- * same project at once.
+ * {@return project lock file to prevent multiple accesses to the same project at once.}
*/
public File getProjectLockFile() {
return new File(location, name + LOCK_FILE_SUFFIX);
}
/**
- * @returns the project directory file extension.
+ * {@return the project directory file extension.}
*/
public static String getProjectDirExtension() {
return PROJECT_DIR_SUFFIX;
@@ -230,23 +230,22 @@ public class ProjectLocator {
}
/**
- * @returns the file extension suitable for creating file filters for the file chooser.
+ * {@return the file extension suitable for creating file filters for the file chooser}
*/
public static String getProjectExtension() {
return PROJECT_FILE_SUFFIX;
}
/**
- * Returns whether the given file is a project directory.
+ * {@return whether the given file is a project directory.}
* @param file file to check
- * @return true if the file is a project directory
*/
public static boolean isProjectDir(File file) {
return file.isDirectory() && file.getName().endsWith(PROJECT_DIR_SUFFIX);
}
/**
- * @returns true if project storage exists
+ * {@return true if project storage exists}
*/
public boolean exists() {
return getMarkerFile().isFile() && getProjectDir().isDirectory();
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/pcode/AbstractPcodeFormatter.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/pcode/AbstractPcodeFormatter.java
index b09254dccf..33380a2ebe 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/pcode/AbstractPcodeFormatter.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/pcode/AbstractPcodeFormatter.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -31,10 +31,9 @@ import ghidra.util.Msg;
* {@link #formatOpTemplate(Appender, OpTpl)}. Otherwise, most formatting logic is implemented by
* the appender.
*
- * @see {@link StringPcodeFormatter} for an example
- * @see {@link AbstractAppender}
* @param