From d1b0828af945cf0be1106f38482b29e29a557b82 Mon Sep 17 00:00:00 2001 From: Ryan Kurtz Date: Mon, 10 Jun 2024 08:09:04 -0400 Subject: [PATCH] GP-4329: Improving javadoc for Program.getExecutablePath() --- .../java/ghidra/program/model/listing/Program.java | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Program.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Program.java index 046fb22be3..0ddd9dc536 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Program.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Program.java @@ -202,17 +202,19 @@ public interface Program extends DataTypeManagerDomainObject, ProgramArchitectur public void setPreferredRootNamespaceCategoryPath(String categoryPath); /** - * Gets the path to the program's executable file. - * For example, C:\Temp\test.exe. + * Gets the path to the program's executable file. For example, {@code /home/user/foo.exe}. * This will allow plugins to execute the program. - * + *

+ * NOTE: The format of the path is not guaranteed to follow any standard naming conventions. + * If used for anything other than display purpose, callers of this method should take extra + * steps to ensure the path is in a form suitable for their needs. + * * @return String path to program's exe file */ public String getExecutablePath(); /** - * Sets the path to the program's executable file. - * For example, C:\Temp\test.exe. + * Sets the path to the program's executable file. For example, {@code /home/user/foo.exe}. * * @param path the path to the program's exe */