yetangitu/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2025-10-04 02:09:44 +02:00
Code Issues Releases Wiki Activity

javadoc html5

Browse source
This commit is contained in:
astrelsky 2019-12-12 22:47:09 -05:00
parent 3eb130123b
commit 3bdf049d44
No known key found for this signature in database
GPG key ID: FA88FA97D6877C37
136 changed files with 428 additions and 425 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Ghidra/Framework/Utility/src/main/java/utility/function/Callback.java
View file

@ -23,7 +23,7 @@ package utility.function;
public interface Callback {
/**
* Creates a dummy callback function. This is useful to avoid using <tt>null</tt>.
* Creates a dummy callback function. This is useful to avoid using <code>null</code>.
* @return a dummy callback function
*/
public static Callback dummy() {
@ -33,10 +33,10 @@ public interface Callback {
}
/**
* Returns the given callback object if it is not <tt>null</tt>. Otherwise, a {@link #dummy()}
* callback is returned. This is useful to avoid using <tt>null</tt>.
* Returns the given callback object if it is not <code>null</code>. Otherwise, a {@link #dummy()}
* callback is returned. This is useful to avoid using <code>null</code>.
*
* @param c the callback function to check for <tt>null</tt>
* @param c the callback function to check for <code>null</code>
* @return a non-null callback function
*/
public static Callback dummyIfNull(Callback c) {

34
Ghidra/Framework/Utility/src/main/java/utility/module/ModuleUtilities.java
View file

@ -206,18 +206,18 @@ public class ModuleUtilities {
/**
* Returns true if the given path is parented by a module root directory.
* <p>
* For example, given a module path of <tt>/some/dir/features/cool_module/</tt>, then this
* For example, given a module path of <code>/some/dir/features/cool_module/</code>, then this
* method will return true for these paths:
* <br>
* <br>
* <tt>/some/dir/features/cool_module</tt><br>
* <tt>/some/dir/features/cool_module/some/child/dir</tt>
* <code>/some/dir/features/cool_module</code><br>
* <code>/some/dir/features/cool_module/some/child/dir</code>
* <br>
* <br>and false for these paths:
* <br>
* <br>
* <tt>/some/random/path</tt><br>
* <tt>/some/dir/features/</tt>
* <code>/some/random/path</code><br>
* <code>/some/dir/features/</code>
*
* @param pathName the path name to check
* @return true if the given path is parented by a module root directory.
@ -231,18 +231,18 @@ public class ModuleUtilities {
* Returns the path of the module containing the given path string, if it is parented by a
* module root directory.
* <p>
* For example, given a module path of <tt>/some/dir/features/cool_module/</tt>, then this
* For example, given a module path of <code>/some/dir/features/cool_module/</code>, then this
* method will return that module path, given these paths:
* <br>
* <br>
* <tt>/some/dir/features/cool_module</tt><br>
* <tt>/some/dir/features/cool_module/some/child/dir</tt>
* <code>/some/dir/features/cool_module</code><br>
* <code>/some/dir/features/cool_module/some/child/dir</code>
* <br>
* <br>and null for these paths:
* <br>
* <br>
* <tt>/some/random/path</tt><br>
* <tt>/some/dir/features/</tt>
* <code>/some/random/path</code><br>
* <code>/some/dir/features/</code>
*
* @param pathName the path name to check
* @return the module root directory; null if the path is not in a module
@ -274,13 +274,13 @@ public class ModuleUtilities {
* here means a folder that contains a repository folder. As an example, given a repo
* structure of:
*
* <p><tt>/userdir/repoRoot/repoDir/.git</tt><br>
* <p><code>/userdir/repoRoot/repoDir/.git</code><br>
*
* <p>then this method, given will produce the following results (input -&gt; output):<br>
*
* <p><tt>/userdir/repoRoot/repoDir/.git -&gt; /userdir/repoRoot</tt>
* <br><tt>/userdir/repoRoot/repoDir -&gt; /userdir/repoRoot</tt>
* <br><tt>/userdir/repoRoot -&gt; /userdir/repoRoot</tt>
* <p><code>/userdir/repoRoot/repoDir/.git -&gt; /userdir/repoRoot</code>
* <br><code>/userdir/repoRoot/repoDir -&gt; /userdir/repoRoot</code>
* <br><code>/userdir/repoRoot -&gt; /userdir/repoRoot</code>
*
*
* @param f the child file of the desired repo
@ -314,12 +314,12 @@ public class ModuleUtilities {
* Returns a file that is the repository folder containing the given file. As an example,
* given a repo structure of:
*
* <p><tt>/userdir/repoRoot/repoDir/.git</tt><br>
* <p><code>/userdir/repoRoot/repoDir/.git</code><br>
*
* <p>then this method, given will produce the following results (input -&gt; output):<br>
*
* <p><tt>/userdir/repoRoot/repoDir/.git -&gt; /userdir/repoRoot/repoDir</tt>
* <br><tt>/userdir/repoRoot/repoDir -&gt; /userdir/repoRoot/repoDir</tt>
* <p><code>/userdir/repoRoot/repoDir/.git -&gt; /userdir/repoRoot/repoDir</code>
* <br><code>/userdir/repoRoot/repoDir -&gt; /userdir/repoRoot/repoDir</code>
*
* @param f the child file of the desired repo
* @return a file that is the repo folder of the repository containing the given file; null