GP-0: Certify and cleanup

Ghidra/Features/Base/src/main/java/ghidra/app/merge/listing/FunctionTagListingMerger.java

@@ -38,35 +38,35 @@ import ghidra.util.task.TaskMonitor;
 /**
  * Handles merging of function tags when they are added/removed from 
  * functions. 
- * 
+ * <p>
  * Most merging can be done automatically; the exception being when a
  * tag has been added to a function by one user, but deleted from the
  * program by another.
- * 
+ * <p
  * Note that there are other tag related conflict cases, but they are 
  * handled by the {@link FunctionTagMerger}, which handles all aspects of
  * creation/deletion/editing of tags independent of functions. 
- * 
+ * <p>
  * THIS CLASS ONLY DEALS WITH FUNCTION-RELATED ADDS/REMOVES.
- * 
+ * <p>
  * The specific cases handled by the class are described below:
- * 
- *  - X and Y are tags
- *  - ** indicates a conflict
- *  
- * 	User A	|Add X	Add Y	Delete X	Delete Y	
- * 		|
- * User B		|
+ * <ul>
+ * <li>X and Y are tags</li>
+ * <li>** indicates a conflict</li>
+ * </ul>
+ * <pre>
+ *      User A  |  Add X   Add Y  Delete X  Delete Y	
+ * 	            |
+ * User B       |
  * -------------------------------------------------------
- * Add X		|X		X,Y		**		X		
- * 		|
- * Add Y		|X,Y	Y		Y		**		
- * 		|
- * Delete X		|**		Y		-		-			
- * 		|
- * Delete Y		|X		**		-		-		
- * 
- * 
+ * Add X        |  X       X,Y      **        X		
+ *              |
+ * Add Y        |  X,Y     Y        Y         **		
+ *              |
+ * Delete X     |  **      Y        -         -			
+ *              |
+ * Delete Y     |  X       **       -         -		
+ * </pre>
  */
 public class FunctionTagListingMerger extends AbstractListingMerger {
 
@@ -238,20 +238,19 @@ public class FunctionTagListingMerger extends AbstractListingMerger {
 	 * 
 	 * @param diffType from {@link ProgramDiffFilter}
 	 * @param monitor task monitor
-	 * @throws ProgramConflictException
-	 * @throws CancelledException
-	 * @throws IOException
+	 * @throws CancelledException if the user cancelled the operation
+	 * @throws IOException if an IO-related error occurred
 	 */
 	private void autoMerge(int diffType, TaskMonitor monitor)
-			throws ProgramConflictException, CancelledException, IOException {
+			throws CancelledException, IOException {
 
 		// Get the address of all changes in Latest and My. These changes are guaranteed to ONLY be
 		// additions/removals of tags from the address; tag creations/deletions/edits will not be 
 		// in these change sets.
 		AddressSetView myChangedAddresses =
-				listingMergeMgr.diffOriginalMy.getDifferences(new ProgramDiffFilter(diffType), monitor);
+			listingMergeMgr.diffOriginalMy.getDifferences(new ProgramDiffFilter(diffType), monitor);
 		AddressSetView latestChangedAddresses = listingMergeMgr.diffOriginalLatest
-					.getDifferences(new ProgramDiffFilter(diffType), monitor);
+				.getDifferences(new ProgramDiffFilter(diffType), monitor);
 
 		// Get a list of all deleted tags in My and Latest.
 		Collection<? extends FunctionTag> myDeletedTags = getDeletedTags(myPgm, monitor);
@@ -276,7 +275,7 @@ public class FunctionTagListingMerger extends AbstractListingMerger {
 	 * @param changedAddresses list of addresses to inspect
 	 * @param deletedTags all tags deleted in the 'other' program
 	 * @param programAddedTo the program in which the adds reside
-	 * @throws IOException
+	 * @throws IOException if an IO-related error occurred
 	 */
 	private void processChangedAddresses(AddressSetView changedAddresses,
 			Collection<? extends FunctionTag> deletedTags, Program programAddedTo)
@@ -324,11 +323,10 @@ public class FunctionTagListingMerger extends AbstractListingMerger {
 	}
 
 	/**
-	 * Returns all tags that were added to the function at the given address.
+	 * {@return all tags that were added to the function at the given address}
 	 * 
 	 * @param program the program where the function resides
 	 * @param addr the function entry point
-	 * @return
 	 */
 	private Collection<FunctionTag> getTagsAddedToFunction(Program program, Address addr) {
 
@@ -363,7 +361,7 @@ public class FunctionTagListingMerger extends AbstractListingMerger {
 	 * indicate deletions.
 	 * 
 	 * @param program the program version 
-	 * @param monitor
+	 * @param monitor A {@link TaskMonitor}
 	 * @return database IDs from the FunctionTagAdapter table that were deleted
 	 */
 	private Collection<? extends FunctionTag> getDeletedTags(Program program, TaskMonitor monitor) {
@@ -391,9 +389,9 @@ public class FunctionTagListingMerger extends AbstractListingMerger {
 	 * resolving the conflict will appear at the bottom.
 	 * 
 	 * @param listingPanel the main panel
-	 * @param addr 
-	 * @param tagID
-	 * @param changeListener
+	 * @param addr The address
+	 * @param tagID The tag ID
+	 * @param changeListener The {@link ChangeListener}
 	 */
 	private void setupConflictsPanel(ListingMergePanel listingPanel, Address addr, Long tagID,
 			ChangeListener changeListener) {
@@ -438,12 +436,12 @@ public class FunctionTagListingMerger extends AbstractListingMerger {
 	}
 
 	/**
-	 * Returns a string containing the tag and the program version it's associated
-	 * with. This is used when displaying the conflict panel.
+	 * {@return a string containing the tag and the program version it's associated with}
+	 * <p>
+	 * This is used when displaying the conflict panel.
 	 * 
-	 * @param version
-	 * @param tags
-	 * @return
+	 * @param version The program version
+	 * @param tag The associated tag
 	 */
 	private String[] getFunctionTagInfo(int version, String tag) {
 		String[] info = new String[] { "Keep", "", tag };
@@ -471,8 +469,8 @@ public class FunctionTagListingMerger extends AbstractListingMerger {
 	 * 
 	 * @param addr the location of the conflict
 	 * @param chosenConflictOption KEEP_ORIGINAL, KEEP_LATEST, KEEP_MY
-	 * @param monitor
-	 * @throws CancelledException
+	 * @param monitor A {@link TaskMonitor}
+	 * @throws CancelledException if the user cancelled the operation
 	 */
 	private void mergeConflictingTag(Address addr, int chosenConflictOption, TaskMonitor monitor)
 			throws CancelledException {
@@ -629,7 +627,7 @@ public class FunctionTagListingMerger extends AbstractListingMerger {
 	 * @param id the tag ID
 	 * @param program the program version
 	 * @return null if tag not found for the given id
-	 * @throws IOException
+	 * @throws IOException if an IO-related error occurred
 	 */
 	private FunctionTag getTag(Long id, Program program) throws IOException {
 		FunctionManagerDB functionManagerDB = (FunctionManagerDB) program.getFunctionManager();