From 4c3d3360dcec205e6cd893804722231771d3eccf Mon Sep 17 00:00:00 2001 From: astrelsky Date: Mon, 3 Feb 2020 13:44:54 -0500 Subject: [PATCH 1/2] Documentation Fix --- .../java/ghidra/program/model/pcode/HighFunctionDBUtil.java | 2 +- .../main/java/ghidra/program/model/pcode/HighVariable.java | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/HighFunctionDBUtil.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/HighFunctionDBUtil.java index 249ef536cb..aea4df2768 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/HighFunctionDBUtil.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/HighFunctionDBUtil.java @@ -727,7 +727,7 @@ public class HighFunctionDBUtil { /** * Get the Address referred to by a spacebase reference. Address-of references are encoded in - * the p-code syntax tree as: vn = PTRSUB(, #const). This decodes the reference and + * the p-code syntax tree as: {@code vn = PTRSUB(, #const)}. This decodes the reference and * returns the Address * @param program is the program containing the Address * @param op is the PTRSUB op encoding the reference diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/HighVariable.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/HighVariable.java index f92ecc61c3..ee5b3824e1 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/HighVariable.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/HighVariable.java @@ -144,7 +144,7 @@ public abstract class HighVariable { * Restore the data-type and the Varnode instances of this HighVariable. * The "representative" Varnode is also populated. * @param parser is the XML stream - * @param el is the root tag + * @param el is the root {@code } tag * @throws PcodeXMLException if the XML is not valid */ protected void restoreInstances(XmlPullParser parser, XmlElement el) @@ -193,7 +193,7 @@ public abstract class HighVariable { } /** - * Restore this HighVariable from a XML tag + * Restore this HighVariable from a {@code } XML tag * @param parser is the XML stream * @throws PcodeXMLException if the XML is not valid */ From a3d163fd81c877edecd625520c7590b7f2c27558 Mon Sep 17 00:00:00 2001 From: astrelsky Date: Thu, 13 Feb 2020 09:36:30 -0500 Subject: [PATCH 2/2] Docfix AbstractActionBuilder --- .../java/docking/action/builder/AbstractActionBuilder.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Ghidra/Framework/Docking/src/main/java/docking/action/builder/AbstractActionBuilder.java b/Ghidra/Framework/Docking/src/main/java/docking/action/builder/AbstractActionBuilder.java index 14b918d79d..0d472c9d1f 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/action/builder/AbstractActionBuilder.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/action/builder/AbstractActionBuilder.java @@ -578,7 +578,7 @@ public abstract class AbstractActionBuilder - * builder.enabledWhen(context -> { + * {@literal builder.enabledWhen(context -> }{ * if (!(context instanceof FooContext)) { * return false; * } @@ -589,7 +589,7 @@ public abstract class AbstractActionBuilder - * builder.enabledWhen(context -> return context.isAwesome() } + * {@literal builder.enabledWhen(context -> return context.isAwesome() }} * * * @param newActionContextClass the more specific ActionContext type.