yetangitu/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2025-10-03 17:59:46 +02:00
Code Issues Releases Wiki Activity

GP-5742 Corrected deprecation comments/annotations

Browse source
This commit is contained in:
ghidra1 2025-06-09 10:01:05 -04:00
parent e03fb9af76
commit cb3f884ef5
2 changed files with 23 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

21
Ghidra/Features/Base/src/main/java/ghidra/app/cmd/comments/SetCommentCmd.java
View file

@ -116,6 +116,26 @@ public class SetCommentCmd implements Command<Program> {
return message; return message;
} }
/**
* Creates the specified comment of the specified type at address. The current comment of
* this commentType will be cleared.
*
* @param program the program being analyzed
* @param addr the address where data is created
* @param comment the comment about the data
* @param commentType the type of comment ({@link CodeUnit#PLATE_COMMENT},
* {@link CodeUnit#PRE_COMMENT}, {@link CodeUnit#EOL_COMMENT}, {@link CodeUnit#POST_COMMENT},
* {@link CodeUnit#REPEATABLE_COMMENT})
* @deprecated Use {@link #createComment(Program, Address, String, CommentType)} instead
*/
@Deprecated(forRemoval = true, since = "11.4")
public static void createComment(Program program, Address addr, String comment,
int commentType) {
SetCommentCmd commentCmd =
new SetCommentCmd(addr, CommentType.valueOf(commentType), comment);
commentCmd.applyTo(program);
}
/** /**
* Creates the specified comment of the specified type at address. The current comment of * Creates the specified comment of the specified type at address. The current comment of
* this commentType will be cleared. * this commentType will be cleared.
@ -125,7 +145,6 @@ public class SetCommentCmd implements Command<Program> {
* @param comment the comment about the data * @param comment the comment about the data
* @param commentType the type of comment * @param commentType the type of comment
*/ */
public static void createComment(Program program, Address addr, String comment, public static void createComment(Program program, Address addr, String comment,
CommentType commentType) { CommentType commentType) {
SetCommentCmd commentCmd = new SetCommentCmd(addr, commentType, comment); SetCommentCmd commentCmd = new SetCommentCmd(addr, commentType, comment);

4
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/CodeUnit.java
View file

@ -195,7 +195,7 @@ public interface CodeUnit extends MemBuffer, PropertySet {
* three types of comments supported * three types of comments supported
* @deprecated use {@link #setComment(CommentType, String)} instead * @deprecated use {@link #setComment(CommentType, String)} instead
*/ */
@Deprecated @Deprecated(forRemoval = true, since = "11.4")
public default void setComment(int commentType, String comment) { public default void setComment(int commentType, String comment) {
setComment(CommentType.valueOf(commentType), comment); setComment(CommentType.valueOf(commentType), comment);
} }
@ -216,7 +216,9 @@ public interface CodeUnit extends MemBuffer, PropertySet {
* @param comment an array of strings where each string is a single line of the comment. * @param comment an array of strings where each string is a single line of the comment.
* @throws IllegalArgumentException if type is not one of the * @throws IllegalArgumentException if type is not one of the
* three types of comments supported * three types of comments supported
* @deprecated use {@link #setCommentAsArray(CommentType, String[])} instead
*/ */
@Deprecated(forRemoval = true, since = "11.4")
public default void setCommentAsArray(int commentType, String[] comment) { public default void setCommentAsArray(int commentType, String[] comment) {
setCommentAsArray(CommentType.valueOf(commentType), comment); setCommentAsArray(CommentType.valueOf(commentType), comment);
} }