Nixyri/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2025-02-16 15:40:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

GP-4329: Improving javadoc for Program.getExecutablePath()

Browse Source
This commit is contained in:
Ryan Kurtz 2024-06-10 08:09:04 -04:00
parent 195abea7e4
commit d1b0828af9
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Program.java
View File

@ -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, <code>C:\Temp\test.exe</code>.
* Gets the path to the program's executable file. For example, {@code /home/user/foo.exe}.
* This will allow plugins to execute the program.
*
* <p>
* 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, <code>C:\Temp\test.exe</code>.
* 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
*/