Merge remote-tracking branch 'origin/GP-0_Isabella3412_Help_file_cleanup--SQUASHED'

This commit is contained in:
Ryan Kurtz 2024-02-23 13:23:37 -05:00
commit a5de0b728d
7 changed files with 53 additions and 9 deletions

View file

@ -494,7 +494,13 @@
<H4><A name="Dual_Decompiler_Toggle_Orientation"></A>Show Decompilers Side-by-Side</H4>
<BLOCKQUOTE>
<P>This toggles the decompiler panels between a vertical split and a horizontal split. </P>
<P> This toggles the decompiler panels between a vertical split and a horizontal split. </P>
</BLOCKQUOTE>
<H4><A name="Toggle_Exact_Constant_Matching"></A>Toggle Exact Constant Matching</H4>
<BLOCKQUOTE>
<P> This toggles whether or not constants must be exactly the same value to be a match in
the Decompiler Diff View. </P>
</BLOCKQUOTE>
</BLOCKQUOTE>

View file

@ -20,17 +20,25 @@ import java.util.List;
import javax.swing.Icon;
import docking.ActionContext;
import docking.action.*;
import docking.widgets.fieldpanel.internal.FieldPanelCoordinator;
import docking.action.DockingAction;
import docking.action.ToggleDockingAction;
import docking.action.ToolBarData;
import generic.theme.GIcon;
import ghidra.app.decompiler.component.*;
import ghidra.app.decompiler.component.DecompileData;
import ghidra.app.decompiler.component.DecompilerCodeComparisonPanel;
import ghidra.app.decompiler.component.DualDecompileResultsListener;
import ghidra.app.decompiler.component.DualDecompilerActionContext;
import ghidra.codecompare.graphanalysis.TokenBin;
import ghidra.framework.options.OptionsChangeListener;
import ghidra.framework.options.ToolOptions;
import ghidra.framework.plugintool.PluginTool;
import ghidra.util.HTMLUtilities;
import ghidra.util.HelpLocation;
import ghidra.util.exception.CancelledException;
import ghidra.util.task.*;
import ghidra.util.task.Task;
import ghidra.util.task.TaskBuilder;
import ghidra.util.task.TaskLauncher;
import ghidra.util.task.TaskListener;
import resources.Icons;
import resources.MultiIcon;
@ -44,6 +52,7 @@ public class DecompilerDiffCodeComparisonPanel
implements DualDecompileResultsListener, OptionsChangeListener {
public static final String CODE_DIFF_VIEW = "Decompiler Diff View";
private static final String HELP_TOPIC = "FunctionComparison";
private DecompileDataDiff decompileDataDiff;
private DiffClangHighlightController leftHighlightController;
private DiffClangHighlightController rightHighlightController;
@ -199,7 +208,8 @@ public class DecompilerDiffCodeComparisonPanel
*/
public MyToggleExactConstantMatching(String owner) {
super("Toggle Exact Constant Matching", owner);
setHelpLocation(new HelpLocation(HELP_TOPIC, "Toggle Exact Constant Matching"));
this.setToolBarData(new ToolBarData(NO_EXACT_CONSTANT_MATCHING_ICON, "toggles"));
setDescription(HTMLUtilities.toHTML("Toggle whether or not constants must\n" +

View file

@ -4939,6 +4939,19 @@
</para>
</sect2>
<sect2 id="ActionEditOverride">
<title>Edit Signature Override</title>
<para>
Edit the existing overriding function prototype to the called function under the cursor.
</para>
<para>
This action can only be triggered at call sites with an existing signature override. As with the Override
Signature command, users must select either the token representing the called function's name or the
tokens representing the function pointer at the call site. The action brings up a dialog where the user
can edit the current overriding function prototype.
</para>
</sect2>
<sect2 id="ActionReference">
<title>References</title>
<sect3 id="ActionFindUses">

View file

@ -1111,6 +1111,21 @@
</p>
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="ActionEditOverride"></a>Edit Signature Override</h3></div></div></div>
<p>
Edit the overriding function prototype applied previously to the called function under the cursor.
</p>
<p>
This action can only be triggered at call sites with an existing signature override. As with the Override
Signature command, users must select either the token representing the called function's name or the
tokens representing the function pointer at the call site. The action brings up a dialog where the user
can edit the current overriding function prototype.
</p>
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="ActionReference"></a>References</h3></div></div></div>

View file

@ -31,7 +31,7 @@ public class EditPrototypeOverrideAction extends AbstractDecompilerAction {
public EditPrototypeOverrideAction() {
super("Edit Signature Override");
setHelpLocation(new HelpLocation(HelpTopics.DECOMPILER, "ActionEditOverride"));
setHelpLocation(new HelpLocation(HelpTopics.DECOMPILER, "ActionEditOverride"));
setPopupMenuData(new MenuData(new String[] { "Edit Signature Override" }, "Decompile"));
}

View file

@ -36,7 +36,7 @@ import ghidra.util.exception.InvalidInputException;
public class OverridePrototypeAction extends AbstractDecompilerAction {
public OverridePrototypeAction() {
super("Override Signature");
super("Override Signature");
setHelpLocation(new HelpLocation(HelpTopics.DECOMPILER, "ActionOverrideSignature"));
setPopupMenuData(new MenuData(new String[] { "Override Signature" }, "Decompile"));
}

View file

@ -38,7 +38,7 @@ public class OpenVersionTrackingSessionAction extends DockingAction {
String[] menuPath = { ToolConstants.MENU_FILE, "Open Session..." };
setMenuBarData(new MenuData(menuPath, "AAA"));
setDescription("Opens a Version Tracking Session");
setHelpLocation(new HelpLocation("VersionTrackingPlugin", "Open_Session"));
setHelpLocation(new HelpLocation("VersionTrackingPlugin", "Version_Tracking_Tool"));
}
@Override