Package ghidra.app.cmd.function

Class SetVariableCommentCmd

java.lang.Object

ghidra.app.cmd.function.SetVariableCommentCmd

All Implemented Interfaces:

Command<Program>

public class SetVariableCommentCmd
extends Object
implements Command<Program>

Command to set the comment on a function varible.

Constructor Summary

Constructors

Constructor	Description
SetVariableCommentCmd(Variable var, String newComment)	Constructs a new command for setting the comment on a function variable.

Method Summary

Modifier and Type	Method	Description
boolean	applyTo(Program program)	Applies the command to the given domain object.
String	getName()	Returns the name of this command.
String	getStatusMsg()	Returns the status message indicating the status of the command.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SetVariableCommentCmd

public SetVariableCommentCmd(Variable var,
 String newComment)

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

public String getName()

Description copied from interface: Command

Returns the name of this command.

Specified by:

getName in interface Command<Program>

Returns:

the name of this command

applyTo

public boolean applyTo(Program program)

Description copied from interface: Command

Applies the command to the given domain object.

Specified by:

applyTo in interface Command<Program>

Parameters:

program - domain object that this command is to be applied.

Returns:

true if the command applied successfully

getStatusMsg

public String getStatusMsg()

Description copied from interface: Command

Returns the status message indicating the status of the command.

Specified by:

getStatusMsg in interface Command<Program>

Returns:

reason for failure, or null if the status of the command was successful