* diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/ProgramPlugin.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/ProgramPlugin.java index 2c976a65a2..457d827d3a 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/ProgramPlugin.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/ProgramPlugin.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -34,11 +34,11 @@ import ghidra.program.util.ProgramSelection; * Subclasses should override the following methods if they are interested in the corresponding * events: *
* The string struct is found in a couple of different ways: *
* For example, if one wants to autocomplete a string "Runscr" into "runScript", * the fields may look as follows: *
* The data types resulting from the parse operation can either be added to the data type manager in * the current program, or written to an archive data file. * diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/function/tags/FunctionTagTable.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/function/tags/FunctionTagTable.java index 792693bfc7..97a2115689 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/function/tags/FunctionTagTable.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/function/tags/FunctionTagTable.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -79,8 +79,10 @@ public class FunctionTagTable extends GhidraTable { /** * We need to override the renderer for the following cases: - *
* Specifically this provides the following: *
* This class maintains a queue of all strings found at any given top-level data element. When diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/terminal/vt/VtHandler.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/terminal/vt/VtHandler.java index 0685d9770c..f370d4a3a2 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/terminal/vt/VtHandler.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/terminal/vt/VtHandler.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -62,17 +62,17 @@ import ghidra.util.Msg; *
* The structures modeled here are described in detail in the C++ ABI. diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFDataTypeConflictHandler.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFDataTypeConflictHandler.java index 1b2b171960..9340af6564 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFDataTypeConflictHandler.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFDataTypeConflictHandler.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -39,16 +39,16 @@ import ghidra.util.SystemUtilities; *
*
*
* Runs after other ElfInfoProducers that have a normal priority. diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/GoFunctionMultiReturn.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/GoFunctionMultiReturn.java index 92c11096b1..ede4f2e851 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/GoFunctionMultiReturn.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/GoFunctionMultiReturn.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -30,10 +30,10 @@ import ghidra.program.model.lang.Register; *
* Assigning custom storage for the return value is complicated by: *
*
* The information that can be recovered about arguments is limited to: *
read method of the underlying stream returns
- * -1, indicating end-of-file, or
+ * -1, indicating end-of-file, orready method of the underlying stream returns
- * false, indicating that further input requests would block.
+ * false, indicating that further input requests would block.read on the underlying stream returns
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSRL.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSRL.java
index 7c561acff8..f0d9fbc18d 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSRL.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSRL.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -39,13 +39,13 @@ import ghidra.util.SystemUtilities;
* * Examples (pipes shown in red since they are hard to see): *
* See {@link FSRLRoot} for examples of how FSRL and FSRLRoot's are related. diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSRLRoot.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSRLRoot.java index 1c8a6d4f9d..0c604d53be 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSRLRoot.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSRLRoot.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -26,11 +26,11 @@ package ghidra.formats.gfilesystem; *
*
* NOTE: *
* This class is used by GhidraScript. diff --git a/Ghidra/Features/Base/src/main/java/ghidra/util/bytesearch/AlignRule.java b/Ghidra/Features/Base/src/main/java/ghidra/util/bytesearch/AlignRule.java index b6606476f8..3a5bc5a977 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/util/bytesearch/AlignRule.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/util/bytesearch/AlignRule.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -22,12 +22,12 @@ import ghidra.xml.XmlPullParser; /** * ByteSearch post search rule when a pattern is found. Used when a pattern must have a certain * alignment at an offset from the location the pattern matches. - * + *
* The pattern can be constructed or restored from XML of the form,
* where alignOffset=mark, alignmask=bits
- *
- *
{@code
+ *
*/
public class AlignRule implements PostRule {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/util/bytesearch/Pattern.java b/Ghidra/Features/Base/src/main/java/ghidra/util/bytesearch/Pattern.java
index 7d65fa7afc..03893ebfa5 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/util/bytesearch/Pattern.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/util/bytesearch/Pattern.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -185,7 +185,7 @@ public class Pattern extends DittedBitSequence {
}
/**
- * Read just the post patterns from the * The larger pattern has the idea of bits of check, which means the number of bits that are fixed to * a value when matching (not don't care). There is a pre pattern bits of check and post pattern bits * of check. The bits of check are used to statistically gauge the accuracy of the pattern. - * + *
* An example of the XML format follows:
- * {@code
+ *
diff --git a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/util/DecompilerConcurrentQ.java b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/util/DecompilerConcurrentQ.java index 3cca028fe6..df62938fec 100644 --- a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/util/DecompilerConcurrentQ.java +++ b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/util/DecompilerConcurrentQ.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -37,7 +37,7 @@ import utility.function.Dummy; * {@link #waitForResults()}. *
* * @param The input data needed by the supplied {@link QCallback} diff --git a/Ghidra/Framework/DB/src/main/java/db/VarRecNode.java b/Ghidra/Framework/DB/src/main/java/db/VarRecNode.java index 9ed17d7ecc..e6180054bd 100644 --- a/Ghidra/Framework/DB/src/main/java/db/VarRecNode.java +++ b/Ghidra/Framework/DB/src/main/java/db/VarRecNode.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -27,11 +27,11 @@ import ghidra.util.exception.AssertException; *
* This type of node has the following layout within a single DataBuffer * (field size in bytes): - *
+ * {@code
* | NodeType(1) | KeyCount(4) | PrevLeafId(4) | NextLeafId(4) | Key0(8) | RecOffset0(4) | IndFlag0(1) |...
*
* | KeyN(8) | RecOffsetN(4) | IndFlagN(1) |...... | RecN |... | Rec0 |
- *
+ * }
* IndFlag - if not zero the record has been stored within a chained DBBuffer
* whose 4-byte integer buffer ID has been stored within this leaf at the record offset.
*/
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/ComponentProvider.java b/Ghidra/Framework/Docking/src/main/java/docking/ComponentProvider.java
index 2fe3ef2d13..46d15f32aa 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/ComponentProvider.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/ComponentProvider.java
@@ -49,17 +49,17 @@ import utilities.util.reflection.ReflectionUtilities;
* * This also provides several useful convenience methods: *
* There are a handful of stub methods that can be overridden as desired: *
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/KeyBindingOverrideKeyEventDispatcher.java b/Ghidra/Framework/Docking/src/main/java/docking/KeyBindingOverrideKeyEventDispatcher.java index a660115b52..bb2d4c9ec3 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/KeyBindingOverrideKeyEventDispatcher.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/KeyBindingOverrideKeyEventDispatcher.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -86,7 +86,7 @@ public class KeyBindingOverrideKeyEventDispatcher implements KeyEventDispatcher * * Ghidra has altered this flow to be: *
- ** * - *+ *
Option Dialogs
* The primary type of * dialog provided herein is the basic option dialog that allows the user to specify the buttons * that appear on the dialog. By default, the given option text will appear as a button(s), @@ -44,55 +42,37 @@ import ghidra.util.exception.AssertException; * {@link #showOptionNoCancelDialog(Component, String, String, String, String, int)} methods if * you do not want aCancelbutton. To use this type of dialog you can use the * variousshowOptionDialog*methods. - * ** Each of the option dialog methods will return a result, which is a number indicating the * choice made by the user. See each method for more details. - *
- *
- *+ *- * The methods listed here allow the user to either enter data from the keyboard or to choose - * from a pre-populated list of data. - *
- *- * {@link #showInputChoiceDialog(Component, String, String, String[], String, int)}- *
- * {@link #showInputMultilineDialog(Component, String, String, String)}
- * {@link #showInputSingleLineDialog(Component, String, String, String)} - *
- ** * - *+ *
Yes/No Dialogs
* Finally, there are a series of methods that presentYesandNobuttons in * a dialog. There are versions that do and do not have aCancelbutton. - * - *
- ** - *+ *
Basic Message / Warning / Error Dialogs
* If you would like to display a simple message to the user, but do not require input from the * user, then you should use the various methods of {@link Msg}, such as * {@link Msg#showInfo(Object, Component, String, Object)}. - * ** Note, the user will be unable to select any text shown in the message area of the dialog. - *
- *
- ** * @see Msg * @see OptionDialogBuilder diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/autocomplete/TextFieldAutocompleter.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/autocomplete/TextFieldAutocompleter.java index 263641006e..f4a67e99d0 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/autocomplete/TextFieldAutocompleter.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/autocomplete/TextFieldAutocompleter.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -77,7 +77,7 @@ import ghidra.util.task.SwingUpdateManager; * The simplest use case is to create a text field, create an autocompleter with a custom model, and * then attach and show. * - *For more advanced input dialog usage, to include allowing the user to tell the dialog + *
"Apply to All" / "Don't Show Again"
+ * For more advanced input dialog usage, to include allowing the user to tell the dialog * to remember a particular decision, or to apply a given choice to all future request, see * {@link OptionDialogBuilder}. - *
+ * {@code
* JTextField field = new JTextField();
*
* AutocompletionModel model = new AutocompletionModel() {
@@ -90,7 +90,7 @@ import ghidra.util.task.SwingUpdateManager;
* completer.attachTo(field);
* // ... Add the field to, e.g., a dialog, and show.
*
- *
+ * }
*
* @param GhidraFileChooser to allow the user to just
* select files, just select
* directories, or select both files and directories. The default is
- * JFilesChooser.FILES_ONLY.
+ * {@link JFileChooser#FILES_ONLY}.
*
* @param mode the type of files to be displayed:
* mode is an
@@ -1007,8 +1007,8 @@ public class GhidraFileChooser extends ReusableDialogComponentProvider implement
*
* If the given file is null, then the selected file state is cleared.
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/searchlist/DefaultSearchListModel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/searchlist/DefaultSearchListModel.java
index bdd8ac2d2a..d38d9b1381 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/searchlist/DefaultSearchListModel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/searchlist/DefaultSearchListModel.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -26,8 +26,8 @@ import utility.function.Dummy;
/**
* Default implementation of the {@link SearchListModel}. Since this model's primary purpose is
* to also implement the {@link ListModel}, this class extends the AbstractListModel.
- * This model's primary type is T, but it implements the list model on SearchListEntry
* Since this class wraps the given table with a new model, you must use this class to
* translate row number values. For example, when getting the selected row, the normal Java
@@ -84,14 +84,14 @@ import utility.function.Callback;
*
*
*
- *
* If {@link JTable#getAutoCreateColumnsFromModel()} returns true, then the columns will
* be recreated and resized when this class is constructed.
*
* To get a row count that is always all of the model's data, call
* {@link #getUnfilteredRowCount()}.
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/LocalDateSpinnerModel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/LocalDateSpinnerModel.java
index b0f4ee2f79..41bfd6a670 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/LocalDateSpinnerModel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/LocalDateSpinnerModel.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -38,9 +38,9 @@ public class LocalDateSpinnerModel extends AbstractSpinnerModel {
* @param maxDate maximum value for spinner model. (Can be null)
* @param calendarField specifies the year, month, or day to increment/decrement. One of:
*
*/
@@ -128,9 +128,9 @@ public class LocalDateSpinnerModel extends AbstractSpinnerModel {
*
* @param calendarField one of
*
*
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableUpdateJob.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableUpdateJob.java
index ba4e1cfe99..53ba881ce4 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableUpdateJob.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableUpdateJob.java
@@ -191,18 +191,18 @@ public class TableUpdateJob Modal Usage
- * Note: the task created by this call will be both cancellable and have progress. If
* you task cannot be cancelled or does not have progress, then do not use this
@@ -93,13 +92,12 @@ public class TaskLauncher {
/**
* A convenience method to directly run a {@link MonitoredRunnable} in a separate
* thread as a {@link Task}, displaying a modal progress dialog.
- *
- * Note: the task created by this call will be both cancellable and have progress. If
* you task cannot be cancelled or does not have progress, then do not use this
@@ -128,11 +126,11 @@ public class TaskLauncher {
* to have it immediately go away. If you desire this default behavior, then do not use
* this convenience method.
*
- * Note: the task created by this call will not be cancellable nor have progress. If
* you need either of these behaviors, the do not use this
diff --git a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/exec/PcodeUseropLibrary.java b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/exec/PcodeUseropLibrary.java
index b9cba81972..91daf85621 100644
--- a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/exec/PcodeUseropLibrary.java
+++ b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/exec/PcodeUseropLibrary.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -40,7 +40,7 @@ public interface PcodeUseropLibrary
* For each of those categories the ids specify a specific property for those components.
*
* Clients that just need to access the colors, fonts, and icons from the theme can use the
* convenience methods in the {@link Gui} class. Clients that need to directly manipulate the
diff --git a/Ghidra/Framework/Gui/src/main/java/generic/theme/laf/UiDefaultsMapper.java b/Ghidra/Framework/Gui/src/main/java/generic/theme/laf/UiDefaultsMapper.java
index 433717b7d7..17ef4d0129 100644
--- a/Ghidra/Framework/Gui/src/main/java/generic/theme/laf/UiDefaultsMapper.java
+++ b/Ghidra/Framework/Gui/src/main/java/generic/theme/laf/UiDefaultsMapper.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -47,16 +47,16 @@ import ghidra.util.Msg;
* Some basic concepts:
*
@@ -65,7 +65,7 @@ import ghidra.util.Msg;
*
- *
*
* Based on these requirements, we need to use multi-threading. Further complicating the need
diff --git a/Ghidra/Framework/Gui/src/main/java/generic/theme/SystemThemeIds.java b/Ghidra/Framework/Gui/src/main/java/generic/theme/SystemThemeIds.java
index 08851486ce..4b2eb71eca 100644
--- a/Ghidra/Framework/Gui/src/main/java/generic/theme/SystemThemeIds.java
+++ b/Ghidra/Framework/Gui/src/main/java/generic/theme/SystemThemeIds.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -35,18 +35,18 @@ import generic.theme.laf.UiDefaultsMapper;
*
- *
* Calendar.YEAR
- * Calendar.MONTH
- * Calendar.DAY_OF_MONTH
+ *
- *
* Calendar.YEAR
- * Calendar.MONTH
- * Calendar.DAY_OF_MONTH
+ *
*
* @param newSortingContext the TableColumnComparator to use to sort the data.
* @param forceSort True signals to re-sort, even if this is already sorted
* @return true if the sort can be processed by this job, false if this job is essentially
- * already completed and therefor cannot perform the sort job.
+ * already completed and therefore cannot perform the sort job.
*/
public synchronized boolean requestSort(TableSortingContext
*
* @return true if the filter can be processed by this job, false if this job is essentially
- * already completed and therefor cannot perform the filter job.
+ * already completed and therefore cannot perform the filter job.
*/
public synchronized boolean requestFilter() {
if (currentState == DONE) {
@@ -718,7 +718,7 @@ public class TableUpdateJob
+ *
- * TaskLauncher.launchNonModal( "My task",
+ * }
*
*
- * null, // parent
- * monitor -> { while ( !monitor.isCanceled() ) { longRunningWork(); } }
+ * {@code
+ * TaskLauncher.launchNonModal("My task",
+ * null, // parent
+ * monitor -> { while (!monitor.isCanceled()) { longRunningWork(); } }
* );
- *
- * TaskLauncher.launchModal( "My task",
+ * }
*
*
- * null, // parent
- * monitor -> { while ( !monitor.isCanceled() ) { longRunningWork(); } }
+ * {@code
+ * TaskLauncher.launchModal("My task",
+ * null, // parent
+ * monitor -> { while (!monitor.isCanceled()) { longRunningWork(); } }
* );
- *
- * TaskLauncher.launchModal( "My task",
+ * }
*
*
- * monitor -> { { foo(); }
+ * {@code
+ * TaskLauncher.launchModal("My task",
+ * monitor -> { foo(); }
* );
- *
- *
*/
public class SystemThemeIds {
diff --git a/Ghidra/Framework/Gui/src/main/java/generic/theme/ThemeManager.java b/Ghidra/Framework/Gui/src/main/java/generic/theme/ThemeManager.java
index 508d76da55..243e762227 100644
--- a/Ghidra/Framework/Gui/src/main/java/generic/theme/ThemeManager.java
+++ b/Ghidra/Framework/Gui/src/main/java/generic/theme/ThemeManager.java
@@ -41,13 +41,13 @@ import utility.function.Callback;
* The basic idea is that all the colors, fonts, and icons used in an application should be
* accessed indirectly via an "id" string. Then the actual color, font, or icon can be changed
* without changing the source code. The default mapping of the id strings to a value is defined
- * in
*
*
*
. and ..
* syntax. Further, they can use the special help system syntax, which is:
* help/topics/topicName/Filename.html for referencing help topic files
+ * help/topics/topicName/Filename.html for referencing help topic fileshelp/shared/image.png for referencing image files at paths rooted under
- * the module's root help dir
+ * the module's root help dir*
Plugin (directly or indirectly).
- * public MyPlugin(PluginTool tool) { ... }
- * protected void init().
+ * Plugin (directly or indirectly).public MyPlugin(PluginTool tool) { ... }protected void init().diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/sleigh/ParserWalker.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/sleigh/ParserWalker.java index 0f2cc7d104..358c4c2aac 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/sleigh/ParserWalker.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/sleigh/ParserWalker.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -26,9 +26,9 @@ import ghidra.util.exception.AssertException; * Class for walking the Sleigh Parser tree. The nodes of the tree are the Sleigh Constructors arranged for a particular * instruction. This tree is walked for various purposes: *
inst_next2.
+ * NOTE: This form does not support use of {@code inst_next2}.
* @param aAddr = address to which 'inst_start' resolves
* @param nAddr = address to which 'inst_next' resolves
* @param rAddr = special address associated with original call
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/sleigh/VarnodeData.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/sleigh/VarnodeData.java
index 5c60196e6b..c33008a617 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/sleigh/VarnodeData.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/sleigh/VarnodeData.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -36,7 +36,7 @@ public class VarnodeData {
public int size;
/**
- * Encode the data to stream as an \ element
+ * Encode the data to stream as an {@code } element
* @param encoder is the stream encoder
* @throws IOException for errors writing to the underlying stream
*/
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/sleigh/template/ConstructTpl.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/sleigh/template/ConstructTpl.java
index 194b68e05e..78c2a68b60 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/sleigh/template/ConstructTpl.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/sleigh/template/ConstructTpl.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -96,7 +96,7 @@ public class ConstructTpl {
}
/**
- * Decode this template from a \ tag in the stream.
+ * Decode this template from a {@code } tag in the stream.
* @param decoder is the stream
* @return the constructor section id described by the tag
* @throws DecoderException for errors in the encoding
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/NamespaceUtils.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/NamespaceUtils.java
index 792e471ad2..6ba53ea9bd 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/NamespaceUtils.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/NamespaceUtils.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -29,25 +29,25 @@ import ghidra.util.exception.*;
*
* Example string format:
*
- * - global{@link Namespace#DELIMITER ::}child1{@link Namespace#DELIMITER ::}child2
- *
- child1
+ *
- global{@link Namespace#DELIMITER ::}child1{@link Namespace#DELIMITER ::}child2
+ * - child1
*
*
* Assumptions for creating namespaces from a path string:
*
* - All elements of a namespace path should be namespace symbols and not other
- * symbol types.
- *
- Absolute paths can optionally start with the global namespace.
+ * symbol types.
+ * - Absolute paths can optionally start with the global namespace.
* - You can provide a relative path that will start at the given
- * parent namespace (or global if there is no parent provided).
+ * parent namespace (or global if there is no parent provided).
* - You can provide a path that has as its first entry the name of the
* given parent. In this case, the first entry will not be created,
- * but rather the provided parent will be used.
+ * but rather the provided parent will be used.
* - If you provide a path and a parent, but the first element of the
* path is the global namespace, then the global namespace will be
- * used as the parent namespace and not the one that was provided.
+ * used as the parent namespace and not the one that was provided.
* - You cannot embed the global namespace in a path, but it can be at
- * the root.
+ * the root.
*
*
*
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/PseudoDisassembler.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/PseudoDisassembler.java
index 424f94ed33..45b09b5962 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/PseudoDisassembler.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/PseudoDisassembler.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -361,10 +361,10 @@ public class PseudoDisassembler {
/**
* Check that this entry point leads to valid code:
*
- * - May have multiple entries into the body of the code.
- *
- The intent is that it be valid code, not nice code.
- *
- Hit no bad instructions.
- *
- It should return.
+ *
- May have multiple entries into the body of the code.
+ * - The intent is that it be valid code, not nice code.
+ * - Hit no bad instructions.
+ * - It should return.
*
* @param entryPoint
* @return true if the entry point leads to valid code
@@ -377,10 +377,10 @@ public class PseudoDisassembler {
/**
* Check that this entry point leads to valid code:
*
- * - May have multiple entries into the body of the code.
- *
- The intent is that it be valid code, not nice code.
- *
- Hit no bad instructions.
- *
- It should return.
+ *
- May have multiple entries into the body of the code.
+ * - The intent is that it be valid code, not nice code.
+ * - Hit no bad instructions.
+ * - It should return.
*
*
* @param entryPoint location to test for valid code
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/SymbolPath.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/SymbolPath.java
index 4cb840c043..fe274942e0 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/SymbolPath.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/SymbolPath.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -28,9 +28,9 @@ import ghidra.program.model.symbol.*;
* name of a symbol in the "bar" namespace, which is in the "foo" namespace.
*
*
- * - {@link #getName()} will return "baz".
- *
- {@link #getParentPath()} will return "foo:bar".
- *
- {@link #getPath()} will return "foo::bar::baz".
+ *
- {@link #getName()} will return "baz".
+ * - {@link #getParentPath()} will return "foo:bar".
+ * - {@link #getPath()} will return "foo::bar::baz".
*
*
*/
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcodeCPort/slgh_compile/ParseException.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcodeCPort/slgh_compile/ParseException.java
index 9dbd54948b..baeaed59fb 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcodeCPort/slgh_compile/ParseException.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcodeCPort/slgh_compile/ParseException.java
@@ -1,13 +1,12 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -28,18 +27,18 @@ package ghidra.pcodeCPort.slgh_compile;
*/
public class ParseException extends Exception {
- /**
- * This constructor is used by the method "generateParseException"
- * in the generated parser. Calling this constructor generates
- * a new object of this type with the fields "currentToken",
- * "expectedTokenSequences", and "tokenImage" set. The boolean
- * flag "specialConstructor" is also set to true to indicate that
- * this constructor was used to create this object.
- * This constructor calls its super class with the empty string
- * to force the "toString" method of parent class "Throwable" to
- * print the error message in the form:
- * ParseException:
- */
+ /**
+ * This constructor is used by the method "generateParseException"
+ * in the generated parser. Calling this constructor generates
+ * a new object of this type with the fields "currentToken",
+ * "expectedTokenSequences", and "tokenImage" set. The boolean
+ * flag "specialConstructor" is also set to true to indicate that
+ * this constructor was used to create this object.
+ * This constructor calls its super class with the empty string
+ * to force the "toString" method of parent class "Throwable" to
+ * print the error message in the form:
+ * {@code ParseException: }
+ */
public ParseException(Token currentTokenVal,
int[][] expectedTokenSequencesVal,
String[] tokenImageVal
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/ProgramAddressFactory.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/ProgramAddressFactory.java
index 885437c1f1..3dc0b79009 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/ProgramAddressFactory.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/ProgramAddressFactory.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -40,7 +40,7 @@ public class ProgramAddressFactory extends DefaultAddressFactory {
* A stack space (see {@link AddressSpace#TYPE_STACK})
* {@link AddressSpace#HASH_SPACE}
* A join space (see {@link AddressSpace#TYPE_JOIN})
- *
+ *
* In addition, support is provided for {@link ProgramOverlayAddressSpace}.
* @param language language specification
* @param compilerSpec compiler specification
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/SpecExtension.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/SpecExtension.java
index e89f614cfb..2944a4d58c 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/SpecExtension.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/SpecExtension.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -35,34 +35,37 @@ import ghidra.xml.*;
/**
* Utility class for installing/removing "specification extensions" to a Program.
* A specification extension is a program specific version of either a:
- * - Prototype Model
- * - Call Fixup or
- * - Callother Fixup
+ *
+ * - Prototype Model
+ * - Call Fixup or
+ * - Callother Fixup
+ *
* Normally these objects are provided by the language specific configuration files (.cspec or .pspec),
* but this class allows additional objects to be added that are specific to the program.
- *
+ *
* Internally, each spec extension is stored as an XML document as a formal Program Option. Each type of
* extension is described by a specific XML tag and is parsed as it would be in a .cspec or .pspec file.
* The XML tags are:
- * - \ - describing a Call Fixup
- * - \ - describing a Callother Fixup
- * - \ - describing a typical Prototype Model
- * - \ - describing a Prototype Model merged from other models
- *
+ *
+ * - {@code
} - describing a Call Fixup
+ * - {@code
} - describing a Callother Fixup
+ * - {@code
} - describing a typical Prototype Model
+ * - {@code
} - describing a Prototype Model merged from other models
+ *
* Each type of object has a unique name or target, which must be specified as part of the XML tag,
- * which is referred to in this class as the extension's "formal name". In the \ tag,
- * the formal name is given by the "targetop" attribute; for all the other tags, the formal name is
- * given by the "name" attribute".
- *
+ * which is referred to in this class as the extension's "formal name". In the
+ * {@code } tag, the formal name is given by the "targetop" attribute; for all the
+ * other tags, the formal name is given by the "name" attribute".
+ *
* The parent option for all extensions is given by the static field SPEC_EXTENSION. Under the parent
* option, each extension is stored as a string with an option name, constructed by
* concatenating the extension's formal name with a prefix corresponding to the extension's XML tag name.
- *
+ *
* testExtensionDocument() is used independently to extensively test whether a document
* describes a valid extension.
- *
- * Extensions are installed on a program via addReplaceCompilerSpecExtension().
- * Extensions are removed from a program via removeCompilerSpecExtension().
+ *
+ * Extensions are installed on a program via {@code addReplaceCompilerSpecExtension()}.
+ * Extensions are removed from a program via {@code removeCompilerSpecExtension()}.
*/
public class SpecExtension {
@@ -394,10 +397,12 @@ public class SpecExtension {
/**
* Parse an XML string and build the corresponding compiler spec extension object.
* Currently this can either be a
- * - PrototypeModel or
- * - InjectPayload
+ *
+ * - PrototypeModel
+ * - InjectPayload
+ *
*
- * For InjectPayloadCallfixup or InjectPayloadCallother, the p-code \ tag
+ * For InjectPayloadCallfixup or InjectPayloadCallother, the p-code {@code } tag
* is also parsed, and the caller can control whether any parse errors
* cause an exception or whether a dummy payload is provided instead.
* @param optionName is the option name the extension is attached to
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/util/AddressRangeMapDB.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/util/AddressRangeMapDB.java
index 7c76443f37..b90bfa018d 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/util/AddressRangeMapDB.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/util/AddressRangeMapDB.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -39,9 +39,9 @@ import ghidra.util.task.TaskMonitor;
*
* This is implemented by storing records for each contiguous range with the same value.
*
- * - The key is the encoded start address of the range.
- *
- The TO_COL column of the record stores the encoded end address of the range.
- *
- The VALUE_COL column of the record stores the value for the range.
+ *
- The key is the encoded start address of the range.
+ * - The TO_COL column of the record stores the encoded end address of the range.
+ * - The VALUE_COL column of the record stores the value for the range.
*
*
* This implementation is complicated by several issues.
@@ -51,7 +51,7 @@ import ghidra.util.task.TaskMonitor;
* Encoded addresses do not necessarily encode to keys that have the same ordering.
* Therefore, all comparisons must be done in address space and not in the encoded space.
* Also, record iterators must use the {@link AddressKeyRecordIterator} which will return
- * records in address order versus encoded key order.
+ * records in address order versus encoded key order.
*
The default space's image base can be changed after records have been created. This can
* cause the address ranges represented by a record to wrap around. For example, suppose
* the image base is 0 and you paint a range from address 0 to 0x20, which say maps to
@@ -66,7 +66,8 @@ import ghidra.util.task.TaskMonitor;
* logic, any wrapping record will first be split into two records before painting. However
* we can only do this during a write operation (when we can make changes). Since the getter
* methods and iterators cannot modify the database, they have to deal with wrapping
- * records on the fly.
+ * records on the fly.
+ *
*/
public class AddressRangeMapDB implements DBListener {
public static final String RANGE_MAP_TABLE_PREFIX = "Range Map - ";
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/BasicBlockModel.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/BasicBlockModel.java
index 515dbd03f8..345c880d98 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/BasicBlockModel.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/BasicBlockModel.java
@@ -1,13 +1,12 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -26,14 +25,14 @@ import ghidra.program.model.symbol.*;
* Each Codeblock is made up of contiguous instructions in address order.
*
* Blocks satisfy the following:
- * - Any instruction with a label starts a block.
+ *
- Any instruction with a label starts a block.
* - Each instruction that could cause program control flow to change local to
- * the containing function (i.e., excludes calls) is the last instruction of a Codeblock.
+ * the containing function (i.e., excludes calls) is the last instruction of a Codeblock.
* - All other instructions are "NOP" fallthroughs, meaning
* after execution the program counter will be at
- * the instruction immediately following.
+ * the instruction immediately following.
* - Any instruction that is unreachable and has no label is also considered the start
- * of a block.
+ * of a block.
*
* So a CodeBlock in this model consists of contiguous code that has zero or
* more fallthrough or call instructions followed by a single flow instruction.
@@ -41,11 +40,12 @@ import ghidra.program.model.symbol.*;
* have a label at any other instruction contained in the block.
*
* This model handles delay slot instructions with the following
- * assumptions:
+ * assumptions:
+ *
* - The delay slot depth of the delayed instruction will always
* correspond to the number of delay slot instructions immediately
* following the instruction. The model may not behave properly if
- * the disassembled code violates this assumption.
+ * the disassembled code violates this assumption.
*
* @see ghidra.program.model.block.CodeBlockModel
*/
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/SimpleBlockModel.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/SimpleBlockModel.java
index f01fdb7a30..449d48c42b 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/SimpleBlockModel.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/SimpleBlockModel.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -30,34 +30,35 @@ import ghidra.util.task.TaskMonitor;
* Each Codeblock is made up of contiguous instructions in address order.
*
* Blocks satisfy the following:
- * - Any instruction with a label starts a block.
+ *
- Any instruction with a label starts a block.
* - Each instruction that could cause program control flow to change is the
- * last instruction of a Codeblock.
+ * last instruction of a Codeblock.
* - All other instructions are "NOP" fallthroughs, meaning
* after execution the program counter will be at
- * the instruction immediately following.
+ * the instruction immediately following.
* - Any instruction that is unreachable and has no label is also considered the start
- * of a block.
+ * of a block.
*
* So a CodeBlock in this model consists of contiguous code that has zero or
* more nonflow fallthrough instructions followed by a single flow instruction.
* Each block may or may not have a label at the first instruction, but may not
* have a label at any other instruction contained in the block.
- *
+ *
* This model does not implement the pure simple block model
* because unreachable code is still considered a block.
- *
+ *
* This model handles delay slot instructions with the following
- * assumptions:
+ * assumptions:
+ *
* - A delayed instruction is always corresponds to a change in
* flow and terminates a block. The delay slot instructions
* following this instruction are always included with the
- * block. Therefor, delay slot instructions will always fall
- * at the bottom of a simple block.
+ * block. Therefore, delay slot instructions will always fall
+ * at the bottom of a simple block.
* - The delay slot depth of the delayed instruction will always
* correspond to the number of delay slot instructions immediately
* following the instruction. The model may not behave properly if
- * the disassembled code violates this assumption.
+ * the disassembled code violates this assumption.
*
* @see ghidra.program.model.block.CodeBlockModel
*/
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/BitFieldPackingImpl.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/BitFieldPackingImpl.java
index e213342e22..899ba51463 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/BitFieldPackingImpl.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/BitFieldPackingImpl.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -165,7 +165,7 @@ public class BitFieldPackingImpl implements BitFieldPacking {
}
/**
- * Restore settings from a \ tag in an XML stream.
+ * Restore settings from a {@code } tag in an XML stream.
* The XML is designed to override existing settings from the default constructor
* @param parser is the XML stream
*/
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/Composite.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/Composite.java
index 320a5cadaf..7b95fdf200 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/Composite.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/Composite.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -275,9 +275,9 @@ public interface Composite extends DataType {
* affect of disabled packing differs between {@link Structure} and {@link Union}. When
* packing disabled:
*
- * - Structures utilize explicit component offsets and produce undefined filler
- * components where defined components do not consume space.
- * - Unions always place components at offset 0 and do not pad for alignment.
+ *
- Structures utilize explicit component offsets and produce undefined filler
+ * components where defined components do not consume space.
+ * - Unions always place components at offset 0 and do not pad for alignment.
*
* In addition, when packing is disabled the default alignment is always 1 unless a
* different minimum alignment has been set. When packing is enabled the overall
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/DataUtilities.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/DataUtilities.java
index 6cf8153f3d..51c5b9493f 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/DataUtilities.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/DataUtilities.java
@@ -424,7 +424,7 @@ public final class DataUtilities {
*
* - If the originalDataType is any type of pointer the supplied newDatatype
* will replace the pointer's base type (e.g., int * would become db * when
- * newDataType is {@link ByteDataType}).
+ * newDataType is {@link ByteDataType}).
*
* If false, only required transformations will be applied, Example:
* if newDataType is a FunctionDefinitionDataType it will be transformed
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringDataType.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringDataType.java
index f8977ca0c3..0629092f5e 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringDataType.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringDataType.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -23,23 +23,23 @@ import ghidra.util.classfinder.ClassTranslator;
*
* All string data types:
*
- * - {@link StringDataType} - this type, fixed length, user settable charset.
- *
- {@link StringUTF8DataType} - fixed length UTF-8 string.
- *
- {@link TerminatedStringDataType} - terminated and unbounded string, user settable charset.
- *
- {@link TerminatedUnicodeDataType} - terminated and unbounded UTF-16 string.
- *
- {@link TerminatedUnicode32DataType} - terminated and unbounded UTF-32 string.
- *
- {@link PascalString255DataType} - length-prefixed string (limited to 255 chars), user settable charset.
- *
- {@link PascalStringDataType} - length-prefixed string (limited to 64k), user settable charset.
- *
- {@link PascalUnicodeDataType} - length-prefixed UTF-16 (limited to 64k).
- *
- {@link UnicodeDataType} - fixed length UTF-16 string.
- *
- {@link Unicode32DataType} - fixed length UTF-32 string.
+ *
- {@link StringDataType} - this type, fixed length, user settable charset.
+ * - {@link StringUTF8DataType} - fixed length UTF-8 string.
+ * - {@link TerminatedStringDataType} - terminated and unbounded string, user settable charset.
+ * - {@link TerminatedUnicodeDataType} - terminated and unbounded UTF-16 string.
+ * - {@link TerminatedUnicode32DataType} - terminated and unbounded UTF-32 string.
+ * - {@link PascalString255DataType} - length-prefixed string (limited to 255 chars), user settable charset.
+ * - {@link PascalStringDataType} - length-prefixed string (limited to 64k), user settable charset.
+ * - {@link PascalUnicodeDataType} - length-prefixed UTF-16 (limited to 64k).
+ * - {@link UnicodeDataType} - fixed length UTF-16 string.
+ * - {@link Unicode32DataType} - fixed length UTF-32 string.
*
*
* The following settings are supported by all string types on the data instance:
*
* - {@link TranslationSettingsDefinition} - controls display of string values that have been
- * translated to english.
- *
- {@link RenderUnicodeSettingsDefinition} - controls display of non-ascii Unicode characters.
+ * translated to English.
+ * - {@link RenderUnicodeSettingsDefinition} - controls display of non-ascii Unicode characters.
*
*/
public class StringDataType extends AbstractStringDataType {
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringLayoutEnum.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringLayoutEnum.java
index 550a05c201..d8e0143a8c 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringLayoutEnum.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringLayoutEnum.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -18,12 +18,12 @@ package ghidra.program.model.data;
/**
* Controls strings termination
*
- * - {@link StringLayoutEnum#FIXED_LEN}
- *
- {@link StringLayoutEnum#CHAR_SEQ}
- *
- {@link StringLayoutEnum#NULL_TERMINATED_UNBOUNDED}
- *
- {@link StringLayoutEnum#NULL_TERMINATED_BOUNDED}
- *
- {@link StringLayoutEnum#PASCAL_255}
- *
- {@link StringLayoutEnum#PASCAL_64k}
+ *
- {@link StringLayoutEnum#FIXED_LEN}
+ * - {@link StringLayoutEnum#CHAR_SEQ}
+ * - {@link StringLayoutEnum#NULL_TERMINATED_UNBOUNDED}
+ * - {@link StringLayoutEnum#NULL_TERMINATED_BOUNDED}
+ * - {@link StringLayoutEnum#PASCAL_255}
+ * - {@link StringLayoutEnum#PASCAL_64k}
*
*/
public enum StringLayoutEnum {
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StructureDataType.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StructureDataType.java
index 3bc5fc85b9..497ea46d18 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StructureDataType.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StructureDataType.java
@@ -29,7 +29,7 @@ import ghidra.util.exception.AssertException;
* NOTES:
*
* - Implementation is not thread safe when being modified.
- * - For a structure to treated as having a zero-length (see {@link #isZeroLength()}) it
+ *
- For a structure to treated as having a zero-length (see {@link #isZeroLength()}) it
*
*
*
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StructureFactory.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StructureFactory.java
index 149b48b7f9..5fdd018e4c 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StructureFactory.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StructureFactory.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -47,12 +47,12 @@ public class StructureFactory {
* @return A new structure not yet added to memory.
* @throws IllegalArgumentException for the following conditions:
*
- * - if
dataLength is not greater than zero
+ * - if
dataLength is not greater than zero
* - if the number of components to add exceeds the available
- * address space
+ * address space
* - if there are any instructions in the provided
- * address space
- *
- if there are no data components to add to the structure
+ * address space
+ * - if there are no data components to add to the structure
*
*/
public static Structure createStructureDataType(Program program, Address address,
@@ -73,13 +73,13 @@ public class StructureFactory {
* @return A new structure not yet added to memory.
* @throws IllegalArgumentException for the following conditions:
*
- * - if
structureName is null
- * - if
dataLength is not greater than zero
+ * - if
structureName is null
+ * - if
dataLength is not greater than zero
* - if the number of components to add exceeds the available
- * address space
+ * address space
* - if there are any instructions in the provided
- * address space
- *
- if there are no data components to add to the structure
+ * address space
+ * - if there are no data components to add to the structure
*
*/
public static Structure createStructureDataType(Program program, Address address,
@@ -147,9 +147,9 @@ public class StructureFactory {
* @throws IllegalArgumentException for the following conditions:
*
* - if the component at
fromPath or the component
- * at toPath are null
- * - if there is not data to add to the structure
- *
- if the parent data type is not a structure
+ * at
toPath are null
+ * - if there is not data to add to the structure
+ * - if the parent data type is not a structure
*
*/
public static Structure createStructureDataTypeInStrucuture(Program program, Address address,
@@ -176,11 +176,11 @@ public class StructureFactory {
* @return A new structure not yet added to memory.
* @throws IllegalArgumentException for the following conditions:
*
- * - if
structureName is null
+ * - if
structureName is null
* - if the component at
fromPath or the component
- * at toPath are null
- * - if there is not data to add to the structure
- *
- if the parent data type is not a structure
+ * at
toPath are null
+ * - if there is not data to add to the structure
+ * - if the parent data type is not a structure
*
*/
public static Structure createStructureDataTypeInStrucuture(Program program, Address address,
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/BasicCompilerSpec.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/BasicCompilerSpec.java
index 89bb059f43..9b36c235c5 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/BasicCompilerSpec.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/BasicCompilerSpec.java
@@ -5,9 +5,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -582,7 +582,7 @@ public class BasicCompilerSpec implements CompilerSpec {
}
/**
- * Initialize this object from an XML stream. A single \ tag is expected.
+ * Initialize this object from an XML stream. A single {@code } tag is expected.
* @param parser is the XML stream
* @throws XmlParseException for badly formed XML
* @throws DuplicateNameException if we parse more than one PrototypeModel with the same name
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/CompilerSpec.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/CompilerSpec.java
index ce9f62732d..550f7b9a07 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/CompilerSpec.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/CompilerSpec.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -261,7 +261,7 @@ public interface CompilerSpec {
/**
* Encode this entire specification to a stream. A document is written with
- * root element \.
+ * root element {@code }.
* @param encoder is the stream encoder
* @throws IOException for errors writing to the underlying stream
*/
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/ContextSetting.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/ContextSetting.java
index f71e63cfdf..c7999a2a3b 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/ContextSetting.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/ContextSetting.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -47,11 +47,11 @@ public final class ContextSetting {
}
/**
- * Construct from an XML \ tag. The tag is a child of either \ or \
- * which provides details of the memory range affected.
+ * Construct from an XML {@code } tag. The tag is a child of either {@code }
+ * or {@code } which provides details of the memory range affected.
* @param el is the XML tag
* @param cspec is used to lookup register names present in the tag
- * @param isContextReg is true for a \ parent, false for a \ parent
+ * @param isContextReg is true for a {@code } parent, false for a {@code } parent
* @param first is the first Address in the affected memory range
* @param last is the last Address in the affected memory range
*/
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/InjectPayload.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/InjectPayload.java
index f357d90ae5..6284a9244f 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/InjectPayload.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/InjectPayload.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -157,7 +157,7 @@ public interface InjectPayload {
public boolean isIncidentalCopy();
/**
- * Encode configuration parameters as a \ element to stream
+ * Encode configuration parameters as a {@code } element to stream
* @param encoder is the stream encoder
* @throws IOException for errors writing to the underlying stream
*/
@@ -165,7 +165,7 @@ public interface InjectPayload {
/**
* Restore the payload from an XML stream. The root expected document is
- * the \ tag, which may be wrapped with another tag by the derived class.
+ * the {@code } tag, which may be wrapped with another tag by the derived class.
* @param parser is the XML stream
* @param language is used to resolve registers and address spaces
* @throws XmlParseException for badly formed XML
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/AddressXML.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/AddressXML.java
index 4e001d33bf..d4fc461e17 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/AddressXML.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/AddressXML.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -34,15 +34,16 @@ import ghidra.xml.XmlParseException;
/**
* Utility class for the myriad ways of marshaling/unmarshaling an address and an optional size,
* to/from XML for the various configuration files.
- *
+ *
* An object of the class itself is the most general form, where the specified address
- * - MAY have an associated size given in bytes
- * - MAY be in the JOIN address space, with physical pieces making up the logical value explicitly provided.
- *
- * The static buildXML methods write out an \ tag given component elements without allocating an object.
+ *
+ * - MAY have an associated size given in bytes
+ * - MAY be in the JOIN address space, with physical pieces making up the logical value explicitly provided
+ *
+ * The static buildXML methods write out an {@code } tag given component elements without allocating an object.
* The static readXML methods read XML tags (presented in different forms) and returns an Address object.
* The static appendAttributes methods write out attributes of an address to an arbitrary XML tag.
- * The static restoreXML methods read an \ tag and produce a general AddressXML object.
+ * The static restoreXML methods read an {@code } tag and produce a general AddressXML object.
*/
public class AddressXML {
@@ -136,7 +137,7 @@ public class AddressXML {
}
/**
- * Encode this sized address as an \ element to the stream
+ * Encode this sized address as an {@code } element to the stream
* @param encoder is the stream encoder
* @throws IOException for errors in the underlying stream
*/
@@ -433,12 +434,14 @@ public class AddressXML {
/**
* Create an address from a stream encoding. This recognizes elements
- * - \
- * - \
- * - \ or
- * - any element with "space" and "offset" attributes
- *
- * An empty \ element, with no attributes, results in Address.NO_ADDRESS being returned.
+ *
+ * - {@code
}
+ * - {@code
}
+ * - {@code
} or
+ * - any element with "space" and "offset" attributes
+ *
+ * An empty {@code } element, with no attributes, results in {@link Address#NO_ADDRESS}
+ * being returned.
* @param decoder is the stream decoder
* @return Address created from decode info
* @throws DecoderException for any problems decoding the stream
@@ -545,7 +548,7 @@ public class AddressXML {
}
/**
- * Encode the given Address as an \ element to the stream
+ * Encode the given Address as an {@code } element to the stream
*
* @param encoder is the stream encoder
* @param addr -- Address to encode
@@ -563,7 +566,7 @@ public class AddressXML {
}
/**
- * Encode the given Address and a size as an \ element to the stream
+ * Encode the given Address and a size as an {@code } element to the stream
*
* @param encoder is the stream encoder
* @param addr is the given Address
@@ -577,9 +580,9 @@ public class AddressXML {
}
/**
- * Encode a sequence of Varnodes as a single \ element to the stream.
+ * Encode a sequence of Varnodes as a single {@code } element to the stream.
* If there is more than one Varnode, or if the logical size is non-zero,
- * the \ element will specify the address space as "join" and will have
+ * the {@code } element will specify the address space as "join" and will have
* additional "piece" attributes.
*
* @param encoder is the stream encoder
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/PcodeDataTypeManager.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/PcodeDataTypeManager.java
index 9af94f1f9c..d2d0503538 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/PcodeDataTypeManager.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/PcodeDataTypeManager.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -826,8 +826,8 @@ public class PcodeDataTypeManager {
/**
* Encode a TypeDef data-type to the stream. Generally this sends
- * a \ element with a \ reference to the underlying data-type being typedefed,
- * but we check for Settings on the TypeDef object that can indicate
+ * a {@code } element with a {@code } reference to the underlying data-type being
+ * typedefed, but we check for Settings on the TypeDef object that can indicate
* specialty data-types with their own encodings.
* @param encoder is the stream encoder
* @param type is the TypeDef to build the XML for
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/PcodeOp.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/PcodeOp.java
index 8c993de27a..fedc30abfe 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/PcodeOp.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/PcodeOp.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -431,7 +431,7 @@ public class PcodeOp {
/**
* Encode just the opcode and input/output Varnode data for this PcodeOp to a stream
- * as an \ element
+ * as an {@code } element
* @param encoder is the stream encoder
* @param addrFactory is a factory for looking up encoded address spaces
* @throws IOException for errors in the underlying stream
diff --git a/Ghidra/Framework/Utility/src/main/java/ghidra/framework/ApplicationIdentifier.java b/Ghidra/Framework/Utility/src/main/java/ghidra/framework/ApplicationIdentifier.java
index a2ff8d4753..a417595054 100644
--- a/Ghidra/Framework/Utility/src/main/java/ghidra/framework/ApplicationIdentifier.java
+++ b/Ghidra/Framework/Utility/src/main/java/ghidra/framework/ApplicationIdentifier.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -29,7 +29,7 @@ import utility.application.ApplicationUtilities;
*
* Examples:
*
- * - ghidra-7.4_DEV
+ *
- ghidra-7.4_DEV
*
*/
public class ApplicationIdentifier {
diff --git a/Ghidra/Framework/Utility/src/main/java/ghidra/framework/ApplicationVersion.java b/Ghidra/Framework/Utility/src/main/java/ghidra/framework/ApplicationVersion.java
index b549c37003..bf53b68224 100644
--- a/Ghidra/Framework/Utility/src/main/java/ghidra/framework/ApplicationVersion.java
+++ b/Ghidra/Framework/Utility/src/main/java/ghidra/framework/ApplicationVersion.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -18,16 +18,16 @@ package ghidra.framework;
/**
* Class to represent an application's version information.
*
- * The version format is \d\.\d(\.\d)?(\-.+)?
+ * The version format is {@code \d\.\d(\.\d)?(\-.+)?}
*
* Note: this class has a natural ordering that is inconsistent with equals (the tag
* part of the version is disregarded in the {@link #compareTo(ApplicationVersion)} method).
*
* Examples:
*
- * - 7.4
- *
- 7.4.1
- *
- 7.4.1-BETA
+ *
- 7.4
+ * - 7.4.1
+ * - 7.4.1-BETA
*
*/
public class ApplicationVersion implements Comparable {
diff --git a/Ghidra/Framework/Utility/src/main/java/ghidra/util/UserSearchUtils.java b/Ghidra/Framework/Utility/src/main/java/ghidra/util/UserSearchUtils.java
index 3cd71fb1ed..4bd372ea8c 100644
--- a/Ghidra/Framework/Utility/src/main/java/ghidra/util/UserSearchUtils.java
+++ b/Ghidra/Framework/Utility/src/main/java/ghidra/util/UserSearchUtils.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -82,10 +82,10 @@ public class UserSearchUtils {
* Note: This method will escape regular expression
* characters, such as:
*
- * - ?
- *
- .
- *
- $
- *
- ...and many others
+ *
- ?
+ * - .
+ * - $
+ * - ...and many others
*
* Thus, this method is not meant to accept regular expressions, but
* rather generates regular expressions.