Skip to content

Ghidra is a software reverse engineering (SRE) framework

GP-0: Javadoc and windows path test fix

Ryan Kurtz060722d8917c
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/VariableAnnotatedStringHandler.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/VariableAnnotatedStringHandler.java
index 4abaa0f430..3a43dc2afe 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/VariableAnnotatedStringHandler.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/VariableAnnotatedStringHandler.java
@@ -36,17 +36,17 @@ import ghidra.util.Msg;
* This allows users to reference function variables in comments without having to change the
* comment text when the variable is renamed. Users can enter the annotation using the variable's
* name:
- * <pre>
+ * <pre>{@code
* {@variable local_8}
*
* or
*
* {@variable coolVariable SomeFunction}
- * </pre>
+ * }</pre>
* The user annotation will be converted to use address information:
- * <pre>
+ * <pre>{@code
* {@variable Stack[0xa] FUN_1234eaea}
- * </pre>
+ * }</pre>
*/
public class VariableAnnotatedStringHandler implements AnnotatedStringHandler {
diff --git a/Ghidra/Features/Base/src/test.slow/java/ghidra/app/plugin/core/datamgr/DataTypeArchiveIDTest.java b/Ghidra/Features/Base/src/test.slow/java/ghidra/app/plugin/core/datamgr/DataTypeArchiveIDTest.java
index 71390fceb2..715282f9e6 100644
--- a/Ghidra/Features/Base/src/test.slow/java/ghidra/app/plugin/core/datamgr/DataTypeArchiveIDTest.java
+++ b/Ghidra/Features/Base/src/test.slow/java/ghidra/app/plugin/core/datamgr/DataTypeArchiveIDTest.java
@@ -60,7 +60,7 @@ public class DataTypeArchiveIDTest extends AbstractGenericTest {
private Map<ResourceFile, String> getCurrentGdts() {
return Application.findFilesByExtensionInApplication(".gdt")
.stream()
- .filter(f -> f.getAbsolutePath().contains("/data/typeinfo/"))
+ .filter(f -> f.getAbsolutePath().replace('\\', '/').contains("/data/typeinfo/"))
.collect(Collectors.toMap(Function.identity(), f -> getGdtUniversalId(f)));
}
@@ -80,7 +80,7 @@ public class DataTypeArchiveIDTest extends AbstractGenericTest {
}
private String getGdtRelativePath(ResourceFile gdtFile) {
- String path = gdtFile.getAbsolutePath();
+ String path = gdtFile.getAbsolutePath().replace('\\', '/');
int ix = path.indexOf("/typeinfo/");
path = path.substring(ix + 1);
return path;
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/Plugin.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/Plugin.java
index cae9b0166d..214202c2ba 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/Plugin.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/Plugin.java
@@ -143,7 +143,7 @@ import ghidra.util.classfinder.ExtensionPoint;
* <p>
* Your Plugin can either directly implement the interface in your Plugin class:
* <pre>
- * public class MyPlugin extends Plugin <b>implements MyService</b> {....}</code>
+ * public class MyPlugin extends Plugin <b>implements MyService</b> {....}
* </pre>
* <p>
* or it may delegate the handling of the service interface to another object during its
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/DbCache.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/DbCache.java
index 88f5231f35..0e1f5105d6 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/DbCache.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/DbCache.java
@@ -139,7 +139,7 @@ public class DbCache<T extends DbObject> {
* This form should be used in conjunction with record iterators to avoid unnecessary
* record query during a possible object refresh. To benefit from the record the cached
* object must implement the {@link DbObject#refresh(DBRecord)} method which by default
- * ignores the record and simply calls {@link DbObject#refresh()}.
+ * ignores the record and simply calls {@link DbObject#refresh(DBRecord)}.
* <P>
* This method is similar to the get() method in that it can be called without the database
* lock. It will first check if the object is in the cache and definitely valid before
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/DbObject.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/DbObject.java
index 5883edd597..1798159d34 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/DbObject.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/DbObject.java
@@ -124,8 +124,8 @@ public abstract class DbObject {
* additional checks that might require a database lock. The idea is that if the cache
* modification hasn't changed, then we know the object is valid. If the modification count
* has changed then we may or may not be valid and stronger checks are needed which will require
- * a lock. Subclasses should override {@link #refreshIfNeeded()}, {@link #refresh()} to do
- * the more robust validation checking.
+ * a lock. Subclasses should override {@link #refreshIfNeeded()},
+ * {@link #refresh(DBRecord)} to do the more robust validation checking.
*
* @return true if this object is invalid and must be re-validated, else false if object state
* is currently valid which may include a deleted state.