Package ghidra.app.cmd.function
Class SetVariableCommentCmd
java.lang.Object
ghidra.app.cmd.function.SetVariableCommentCmd
- All Implemented Interfaces:
Command
Command to set the comment on a function varible.
-
Constructor Summary
ConstructorsConstructorDescriptionSetVariableCommentCmd
(Variable var, String newComment) Constructs a new command for setting the comment on a function variable. -
Method Summary
Modifier and TypeMethodDescriptionboolean
applyTo
(DomainObject obj) Applies the command to the given domain object.getName()
Returns the name of this command.Returns the status message indicating the status of the command.
-
Constructor Details
-
SetVariableCommentCmd
Constructs a new command for setting the comment on a function variable.- Parameters:
var
- the variable on which to set the comment.newComment
- the comment string to set on the specified variable.
-
-
Method Details
-
getName
Description copied from interface:Command
Returns the name of this command. -
applyTo
Description copied from interface:Command
Applies the command to the given domain object. -
getStatusMsg
Description copied from interface:Command
Returns the status message indicating the status of the command.- Specified by:
getStatusMsg
in interfaceCommand
- Returns:
- reason for failure, or null if the status of the command was successful
- See Also:
-