Package ghidra.app.cmd.function

Class SetVariableCommentCmd

java.lang.Object

ghidra.app.cmd.function.SetVariableCommentCmd

All Implemented Interfaces:

Command

public class SetVariableCommentCmd
extends java.lang.Object
implements Command

Command to set the comment on a function varible.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	applyTo(DomainObject obj)	Applies the command to the given domain object.
java.lang.String	getName()	Returns the name of this command.
java.lang.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 Detail

SetVariableCommentCmd

public SetVariableCommentCmd(Variable var,
                             java.lang.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 Detail

getName

public java.lang.String getName()

Description copied from interface: Command

Returns the name of this command.

Specified by:

getName in interface Command

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 interface Command

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 interface Command

Returns:

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

See Also:

Command.getStatusMsg()