Package ghidra.app.cmd.comments
Class SetCommentsCmd
- java.lang.Object
-
- ghidra.app.cmd.comments.SetCommentsCmd
-
-
Constructor Summary
Constructors Constructor Description SetCommentsCmd(Address addr, java.lang.String newPreComment, java.lang.String newPostComment, java.lang.String newEolComment, java.lang.String newPlateComment, java.lang.String newRepeatableComment)
Construct command for setting all the different types of comments at an address.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
applyTo(DomainObject obj)
Applies the command to the given domain object.java.lang.String
getName()
The name of the edit action.java.lang.String
getStatusMsg()
Returns the status message indicating the status of the command.
-
-
-
Constructor Detail
-
SetCommentsCmd
public SetCommentsCmd(Address addr, java.lang.String newPreComment, java.lang.String newPostComment, java.lang.String newEolComment, java.lang.String newPlateComment, java.lang.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 Detail
-
getName
public java.lang.String getName()
The name of the edit action.
-
applyTo
public boolean applyTo(DomainObject obj)
Description copied from interface:Command
Applies the command to the given domain object.- Specified by:
applyTo
in interfaceCommand
- Parameters:
obj
- domain object that this command is to be applied.- Returns:
- true if the command applied successfully
- See Also:
Command.applyTo(ghidra.framework.model.DomainObject)
-
getStatusMsg
public java.lang.String 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:
Command.getStatusMsg()
-
-