Package ghidra.app.cmd.comments

# Class AppendCommentCmd

java.lang.Object
ghidra.app.cmd.comments.AppendCommentCmd

All Implemented Interfaces:
  `Command<Program>`

public class AppendCommentCmd extends Object implements Command<Program>
Command to append a specific type of comment on a code unit.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `AppendCommentCmd(Address addr, int commentType, String comment, String separator)`
  Deprecated, for removal: This API element is subject to removal in a future version.
  `AppendCommentCmd(Address addr, CommentType commentType, String comment, String separator)`
  Construct command

- ## 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

  - ### AppendCommentCmd

    @Deprecated(forRemoval=true, since="11.4") public AppendCommentCmd(Address addr, int commentType, String comment, String separator)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Construct command
    Parameters:
      `addr` - address of code unit where comment will be placed
      `commentType` - valid comment type (see `CodeUnit.EOL_COMMENT`, `CodeUnit.PLATE_COMMENT`, etc)
      `comment` - comment for code unit, should not be null
      `separator` - characters to separate the new comment from the previous comment when concatenating.

  - ### AppendCommentCmd

    public AppendCommentCmd(Address addr, CommentType commentType, String comment, String separator)
    Construct command
    Parameters:
      `addr` - address of code unit where comment will be placed
      `commentType` - comment type
      `comment` - comment for code unit, should not be null
      `separator` - characters to separate the new comment from the previous comment when concatenating.

- ## 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