Package ghidra.app.cmd.comments
Class SetCommentsCmd
java.lang.Object
ghidra.app.cmd.comments.SetCommentsCmd
- All Implemented Interfaces:
Command
Command for editing and removing comments at an address.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
applyTo
(DomainObject obj) Applies the command to the given domain object.getName()
The name of the edit action.Returns the status message indicating the status of the command.
-
Constructor Details
-
SetCommentsCmd
public SetCommentsCmd(Address addr, String newPreComment, String newPostComment, String newEolComment, String newPlateComment, String newRepeatableComment) Construct command for setting all the different types of comments at an address.- Parameters:
addr
- address of code unit where comment will editednewPreComment
- new pre commentnewPostComment
- new post commentnewEolComment
- new eol commentnewPlateComment
- new plate commentnewRepeatableComment
- new repeatable comment
-
-
Method Details
-
getName
The name of the edit action. -
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:
-