GP-0: Fixing some javadoc warnings

This commit is contained in:
Ryan Kurtz 2023-09-05 11:43:00 -04:00
parent d7d6b44e29
commit 20645a4eed
2 changed files with 8 additions and 8 deletions

View file

@ -2995,12 +2995,12 @@ public abstract class GhidraScript extends FlatProgramAPI {
* only be used in headed mode. * only be used in headed mode.
* <p> * <p>
* In the GUI environment, this method displays a password popup dialog that prompts the user * In the GUI environment, this method displays a password popup dialog that prompts the user
* for a secret, usually a password or other credential. There is no pre-population of the * for a password. There is no pre-population of the input. If the user cancels the dialog, it
* input. If the user cancels the dialog, it is immediately disposed, and any input to that * is immediately disposed, and any input to that dialog is cleared from memory. If the user
* dialog is cleared from memory. If the user completes the dialog, then the secret is returned * completes the dialog, then the password is returned in a wrapped buffer. The buffer can be
* in a wrapped buffer. The buffer can be cleared by calling {@link Secret#close()}; however, it * cleared by calling {@link Password#close()}; however, it is meant to be used in a
* is meant to be used in a {@code try-with-resources} block. The pattern does not guarantee * {@code try-with-resources} block. The pattern does not guarantee protection of the password,
* protection of the secret, but it will help you avoid some typical pitfalls: * but it will help you avoid some typical pitfalls:
* *
* <pre> * <pre>
* String user = askString("Login", "Username:"); * String user = askString("Login", "Username:");

View file

@ -18,8 +18,8 @@ package ghidra.program.model.symbol;
/** /**
* Replace illegal characters in the given name with '_'. The transformer treats the name as a * Replace illegal characters in the given name with '_'. The transformer treats the name as a
* C++ symbol. Letters and digits are generally legal. '~' is allowed at the start of the symbol. * C++ symbol. Letters and digits are generally legal. '~' is allowed at the start of the symbol.
* Template parameters, surrounded by '<' and '>', allow additional special characters. Certain * Template parameters, surrounded by '&lt;' and '&gt;', allow additional special characters.
* special characters are allowed after the keyword "operator". * Certain special characters are allowed after the keyword "operator".
*/ */
public class IllegalCharCppTransformer implements NameTransformer { public class IllegalCharCppTransformer implements NameTransformer {