Package ghidra.app.cmd.comments
Class SetCommentCmd
- java.lang.Object
-
- ghidra.app.cmd.comments.SetCommentCmd
-
-
Constructor Summary
Constructors Constructor Description SetCommentCmd(Address addr, int commentType, java.lang.String comment)
Construct command
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
applyTo(DomainObject obj)
Applies the command to the given domain object.static void
createComment(Program program, Address addr, java.lang.String comment, int commentType)
Creates the specified comment of the specified type at address.java.lang.String
getName()
Returns the name of this command.java.lang.String
getStatusMsg()
Returns the status message indicating the status of the command.
-
-
-
Constructor Detail
-
SetCommentCmd
public SetCommentCmd(Address addr, int commentType, java.lang.String comment)
Construct command- Parameters:
addr
- address of code unit where comment will be placedcommentType
- valid comment type (see CodeUnit)comment
- comment for code unit
-
-
Method Detail
-
getName
public java.lang.String getName()
Description copied from interface:Command
Returns the name of this command.- Specified by:
getName
in interfaceCommand
- Returns:
- the name of this command
- See Also:
Command.getName()
-
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()
-
createComment
public static void createComment(Program program, Address addr, java.lang.String comment, int commentType)
Creates the specified comment of the specified type at address. The current comment of this commentType will be cleared.- Parameters:
program
- the program being analyzedaddr
- the address where data is createdcomment
- the comment about the datacommentType
- the type of comment (CodeUnit.PLATE_COMMENT
,CodeUnit.PRE_COMMENT
,CodeUnit.EOL_COMMENT
,CodeUnit.POST_COMMENT
,CodeUnit.REPEATABLE_COMMENT
)
-
-