diff --git a/GPL/DMG/src/dmg/java/mobiledevices/dmg/ghidra/GDataConverterBE.java b/GPL/DMG/src/dmg/java/mobiledevices/dmg/ghidra/GDataConverterBE.java index 980ffe0a6c..14f46e28cc 100644 --- a/GPL/DMG/src/dmg/java/mobiledevices/dmg/ghidra/GDataConverterBE.java +++ b/GPL/DMG/src/dmg/java/mobiledevices/dmg/ghidra/GDataConverterBE.java @@ -13,9 +13,6 @@ package mobiledevices.dmg.ghidra; public class GDataConverterBE implements GDataConverter { public static final GDataConverterBE INSTANCE = new GDataConverterBE(); - /** - * - */ private static final long serialVersionUID = 1L; /** diff --git a/GPL/DMG/src/dmg/java/mobiledevices/dmg/ghidra/GDataConverterLE.java b/GPL/DMG/src/dmg/java/mobiledevices/dmg/ghidra/GDataConverterLE.java index 555076c3c6..9c26f6b344 100644 --- a/GPL/DMG/src/dmg/java/mobiledevices/dmg/ghidra/GDataConverterLE.java +++ b/GPL/DMG/src/dmg/java/mobiledevices/dmg/ghidra/GDataConverterLE.java @@ -11,9 +11,7 @@ package mobiledevices.dmg.ghidra; public class GDataConverterLE implements GDataConverter { public static GDataConverterLE INSTANCE = new GDataConverterLE(); - /** - * - */ + private static final long serialVersionUID = 1L; /** diff --git a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/data/TraceBasedDataTypeManager.java b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/data/TraceBasedDataTypeManager.java index d97b66d910..f3531d6535 100644 --- a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/data/TraceBasedDataTypeManager.java +++ b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/data/TraceBasedDataTypeManager.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. @@ -48,9 +48,6 @@ public interface TraceBasedDataTypeManager extends ProgramBasedDataTypeManager { */ @SuppressWarnings("unchecked") default T resolveType(T dataType, DataTypeConflictHandler handler) { - /** - * - */ return (T) resolve(dataType, handler); } diff --git a/Ghidra/Features/BSim/src/main/java/ghidra/features/bsim/query/facade/SFOverviewInfo.java b/Ghidra/Features/BSim/src/main/java/ghidra/features/bsim/query/facade/SFOverviewInfo.java index f80c32ff02..f2cbf09e4a 100755 --- a/Ghidra/Features/BSim/src/main/java/ghidra/features/bsim/query/facade/SFOverviewInfo.java +++ b/Ghidra/Features/BSim/src/main/java/ghidra/features/bsim/query/facade/SFOverviewInfo.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,7 +35,7 @@ public class SFOverviewInfo { * Constructs an overview request with default parameters. * @param functions required--a set of functions (at least one) for which an overview will be * computed. All functions must be from the same program. - * @throws IllegalArgumentException if functions is null/empty or functions + * @throws IllegalArgumentException if {@code functions} is {@code null}/empty or functions * are from multiple programs. */ public SFOverviewInfo(Set functions) { diff --git a/Ghidra/Features/BSim/src/main/java/ghidra/features/bsim/query/facade/SFQueryInfo.java b/Ghidra/Features/BSim/src/main/java/ghidra/features/bsim/query/facade/SFQueryInfo.java index d0ce3771c0..eba4baf6db 100755 --- a/Ghidra/Features/BSim/src/main/java/ghidra/features/bsim/query/facade/SFQueryInfo.java +++ b/Ghidra/Features/BSim/src/main/java/ghidra/features/bsim/query/facade/SFQueryInfo.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. @@ -48,7 +48,7 @@ public class SFQueryInfo { * Constructs a query request with default parameters. * @param functions required--a set of functions (at least one) for which similar functions * will searched. All functions must be from the same program. - * @throws IllegalArgumentException if functions is null/empty or functions + * @throws IllegalArgumentException if {@code functions} is {@code null}/empty or functions * are from multiple programs. */ public SFQueryInfo(Set functions) { diff --git a/Ghidra/Features/BSim/src/main/java/ghidra/features/bsim/query/facade/SimilarFunctionQueryService.java b/Ghidra/Features/BSim/src/main/java/ghidra/features/bsim/query/facade/SimilarFunctionQueryService.java index ecd975bf6d..36c337098a 100755 --- a/Ghidra/Features/BSim/src/main/java/ghidra/features/bsim/query/facade/SimilarFunctionQueryService.java +++ b/Ghidra/Features/BSim/src/main/java/ghidra/features/bsim/query/facade/SimilarFunctionQueryService.java @@ -118,7 +118,7 @@ public class SimilarFunctionQueryService implements AutoCloseable { } /** - * Query the given server with the parameters provider by queryInfo. + * Query the given server with the parameters provider by {@code queryInfo}. * * @param queryInfo a query info object containing the settings for the query * @param listener is the listener to be informed of the query status and incremental results diff --git a/Ghidra/Features/Base/ghidra_scripts/InstructionSearchScript.java b/Ghidra/Features/Base/ghidra_scripts/InstructionSearchScript.java index e0c04cc59f..7911f2905b 100644 --- a/Ghidra/Features/Base/ghidra_scripts/InstructionSearchScript.java +++ b/Ghidra/Features/Base/ghidra_scripts/InstructionSearchScript.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. @@ -33,9 +33,6 @@ public class InstructionSearchScript extends GhidraScript { testLoadAddresses(); } - /** - * - */ @SuppressWarnings("unused") private void testSearcher() { AddressFactory addressFactory = currentProgram.getAddressFactory(); @@ -65,9 +62,6 @@ public class InstructionSearchScript extends GhidraScript { } } - /** - * - */ @SuppressWarnings("unused") private void testLoadString() { InstructionSearchApi searcher = new InstructionSearchApi(); @@ -76,9 +70,6 @@ public class InstructionSearchScript extends GhidraScript { searcher.loadInstructions(bytes, state.getTool()); } - /** - * - */ private void testLoadAddresses() { InstructionSearchApi searcher = new InstructionSearchApi(); diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/cmd/data/AbstractCreateStructureCmd.java b/Ghidra/Features/Base/src/main/java/ghidra/app/cmd/data/AbstractCreateStructureCmd.java index 6b9f2e493a..7c3e53a3f8 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/cmd/data/AbstractCreateStructureCmd.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/cmd/data/AbstractCreateStructureCmd.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. @@ -76,7 +76,7 @@ public abstract class AbstractCreateStructureCmd implements Command { /** * Initializes the structure that is represented by the provided - * structureInfo object. This involves populating the new + * {@code structureInfo} object. This involves populating the new * structure with data and then returning the data type object that * represents the newly created structure. * diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/context/DataLocationListContext.java b/Ghidra/Features/Base/src/main/java/ghidra/app/context/DataLocationListContext.java index e9712409ad..6fe9d97327 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/context/DataLocationListContext.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/context/DataLocationListContext.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. @@ -42,7 +42,7 @@ public interface DataLocationListContext { /** * Returns a list of the locations of the current {@link Data} objects in the current action context that pass the given filter. - *

+ * * @param filter a filter to apply to the current context's Data list, null * implies all elements match. * @return a list of the locations of the current {@link Data} objects in the current action context that pass the given filter. diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/merge/datatypes/DataTypeMergeManager.java b/Ghidra/Features/Base/src/main/java/ghidra/app/merge/datatypes/DataTypeMergeManager.java index 82d51da499..1016706079 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/merge/datatypes/DataTypeMergeManager.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/merge/datatypes/DataTypeMergeManager.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. @@ -2208,9 +2208,6 @@ public class DataTypeMergeManager implements MergeResolver { } } - /** - * - */ private void processDataTypesAdded() throws CancelledException { for (Long element : myDtAddedList) { currentMonitor.checkCancelled(); diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/merge/datatypes/SourceArchiveMergePanel.java b/Ghidra/Features/Base/src/main/java/ghidra/app/merge/datatypes/SourceArchiveMergePanel.java index 0130697b7c..3ad19e4c3a 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/merge/datatypes/SourceArchiveMergePanel.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/merge/datatypes/SourceArchiveMergePanel.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. @@ -85,9 +85,6 @@ class SourceArchiveMergePanel extends JPanel { buttonGroup.add(originalRB); } - /** - * - */ int getSelectedOption() { if (latestRB.isSelected()) { return DataTypeMergeManager.OPTION_LATEST; diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/AnalysisTaskList.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/AnalysisTaskList.java index ccb7eeed4e..56516ad465 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/AnalysisTaskList.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/AnalysisTaskList.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. @@ -16,18 +15,15 @@ */ package ghidra.app.plugin.core.analysis; +import java.util.*; +import java.util.concurrent.CopyOnWriteArrayList; + import ghidra.app.services.Analyzer; import ghidra.framework.options.Options; import ghidra.program.model.address.Address; import ghidra.program.model.address.AddressSetView; import ghidra.program.model.listing.Program; -import java.util.*; -import java.util.concurrent.CopyOnWriteArrayList; - -/** - * - */ public class AnalysisTaskList { private List tasks; private AutoAnalysisManager analysisMgr; diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/FindReferencesTableModel.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/FindReferencesTableModel.java index 898b74bee1..ac62f4b2b3 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/FindReferencesTableModel.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/FindReferencesTableModel.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. @@ -16,6 +15,9 @@ */ package ghidra.app.plugin.core.analysis; +import java.util.List; + +import docking.widgets.table.TableColumnDescriptor; import ghidra.app.util.query.AlignedObjectBasedPreviewTableModel; import ghidra.framework.plugintool.PluginTool; import ghidra.framework.plugintool.ServiceProvider; @@ -28,13 +30,6 @@ import ghidra.util.exception.CancelledException; import ghidra.util.table.field.*; import ghidra.util.task.TaskMonitor; -import java.util.List; - -import docking.widgets.table.TableColumnDescriptor; - -/** - * - */ public class FindReferencesTableModel extends AlignedObjectBasedPreviewTableModel { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/bookmark/BookmarkPlugin.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/bookmark/BookmarkPlugin.java index 7ca56f797a..5aff60a93b 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/bookmark/BookmarkPlugin.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/bookmark/BookmarkPlugin.java @@ -513,7 +513,7 @@ public class BookmarkPlugin extends ProgramPlugin implements PopupActionProvider /** * Returns a list of actions to delete bookmarks that are in the code unit surrounding the given - * address. The list of actions will not exceed maxActionsCount + * address. The list of actions will not exceed {@code maxActionsCount} * * @param primaryAddress The address required to find the containing code unit. * @param maxActionsCount The maximum number of actions to include in the returned list. @@ -544,7 +544,7 @@ public class BookmarkPlugin extends ProgramPlugin implements PopupActionProvider * @param primaryAddress The address required to find the containing code unit. * @param type The bookmark type to retrieve. * @param navigator The BookmarkNavigator used to determine whether there are bookmarks inside - * the code unit containing the given primaryAddress. + * the code unit containing the given {@code primaryAddress}. * @return a list of actions to delete bookmarks that are in the code unit surrounding the given * address for the given type of bookmark. */ @@ -579,8 +579,8 @@ public class BookmarkPlugin extends ProgramPlugin implements PopupActionProvider } /** - * Adds the actions in newActionList to actionList while the size of - * actionList is less than the given {@link #MAX_DELETE_ACTIONS}. + * Adds the actions in {@code newActionList} to {@code actionList} while the size of + * {@code actionList} is less than the given {@link #MAX_DELETE_ACTIONS}. * * @param actionList The list to add to * @param newActionList The list containing items to add diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/compositeeditor/CompositeEditorPanel.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/compositeeditor/CompositeEditorPanel.java index 435ef41b7c..e53051dc00 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/compositeeditor/CompositeEditorPanel.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/compositeeditor/CompositeEditorPanel.java @@ -1449,7 +1449,7 @@ public abstract class CompositeEditorPanel extends JPanel * list of traversal components. Once one of the radio buttons is focused, the up and down * arrow keys can be used to navigate the radio buttons. With this traversal policy, pressing * Tab when on these buttons will move to the next traversal component. - *

+ * * @see #getFocusComponents() */ private class CompFocusTraversalPolicy extends FocusTraversalPolicy { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/data/CreateStructureDialog.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/data/CreateStructureDialog.java index df187b5a10..1f83f61070 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/data/CreateStructureDialog.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/data/CreateStructureDialog.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. @@ -415,7 +415,7 @@ public class CreateStructureDialog extends ReusableDialogComponentProvider { /** * Shows a dialog that allows the user to create a new structure. *

- * This method expects that program and structure be + * This method expects that {@code program} and {@code structure} be * non-null. * * @param program The current program which will be used to obtain current diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/disassembler/DisassembledViewPlugin.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/disassembler/DisassembledViewPlugin.java index 7a00b9dcdb..6a6a0e9885 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/disassembler/DisassembledViewPlugin.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/disassembler/DisassembledViewPlugin.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. @@ -543,7 +543,7 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec /** * Constructs a new info instance based upon the given address. *

- * Note: A NullPointerException will be logged if address is + * Note: A NullPointerException will be logged if {@code address} is * null. * * @param address The address that this info is based upon. diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/model/MaskSettings.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/model/MaskSettings.java index 42fdfa77b4..98e9d17fff 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/model/MaskSettings.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/model/MaskSettings.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,9 +37,6 @@ public class MaskSettings { this.maskAddresses = maskAddresses; } - /** - * - */ public void clear() { maskOperands = false; maskScalars = false; diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/ui/ControlPanelWidget.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/ui/ControlPanelWidget.java index 286959bd8f..ad910a76f0 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/ui/ControlPanelWidget.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/ui/ControlPanelWidget.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,9 +29,6 @@ import javax.swing.border.*; */ public abstract class ControlPanelWidget extends JPanel { - /** - * - */ public ControlPanelWidget( String title) { this.setLayout(new FlowLayout()); diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/ui/SearchDirectionWidget.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/ui/SearchDirectionWidget.java index d074e4b3e1..f5c04e5c70 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/ui/SearchDirectionWidget.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/ui/SearchDirectionWidget.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. @@ -59,9 +59,6 @@ public class SearchDirectionWidget extends ControlPanelWidget { * PROTECTED METHODS ********************************************************************************************/ - /** - * - */ @Override protected JPanel createContent() { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/LocationDescriptor.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/LocationDescriptor.java index 7223a8793f..e2e37780f8 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/LocationDescriptor.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/LocationDescriptor.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. @@ -262,8 +262,8 @@ public abstract class LocationDescriptor { } /** - * Returns a generic {@link ProgramLocation} based upon the program and - * homeAddress of this LocationDescriptor. Subclasses should override this + * Returns a generic {@link ProgramLocation} based upon the {@code program} and + * {@code homeAddress} of this {@code LocationDescriptor}. Subclasses should override this * method to return more specific addresses. * * @return a generic ProgramLocation. @@ -314,7 +314,7 @@ public abstract class LocationDescriptor { * @param obj The object associated with the text being rendered (e.g., CodeUnit). * @param fieldFactoryClass The class that created the field being rendered. * @param highlightColor The color to use for highlighting. - * @return An array of highlights to render for the given text + * @return An array of highlights to render for the given {@code text} */ abstract Highlight[] getHighlights(String text, Object obj, Class fieldFactoryClass, Color highlightColor); diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/LocationReference.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/LocationReference.java index e9cef3a394..5f90a341f3 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/LocationReference.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/LocationReference.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. @@ -98,7 +98,7 @@ public class LocationReference implements Comparable { /** * Returns the address where the item described by this object is used. For example, for * data types, the address is where a data type is applied; for references, this value is the - * from address. + * {@code from} address. * * @return the address where the item described by this object is used. */ diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/LocationReferencesService.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/LocationReferencesService.java index afee60d8c9..8197f05f5e 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/LocationReferencesService.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/LocationReferencesService.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,7 +38,7 @@ public interface LocationReferencesService { * location. * @param location The location for which to show references. * @param navigatable The navigatable in which the references should be shown - * @throws NullPointerException if location is null. + * @throws NullPointerException if {@code location} is null. */ public void showReferencesToLocation(ProgramLocation location, Navigatable navigatable); diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/ReferenceUtils.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/ReferenceUtils.java index 132da32f43..7c6d7588e7 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/ReferenceUtils.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/ReferenceUtils.java @@ -173,7 +173,7 @@ public final class ReferenceUtils { * * @param accumulator the results storage. * @param dataType The datatype for which to find references. - * @param fieldName optional field name for which to search; the dataType must be a + * @param fieldName optional field name for which to search; the {@code dataType} must be a * {@link Composite} to search for a field. * @param program The program from within which to find references. * @param monitor A task monitor to be updated as data is searched; if this is null, then a @@ -198,7 +198,7 @@ public final class ReferenceUtils { * * @param accumulator the results storage. * @param dataType The datatype for which to find references. - * @param fieldName optional field name for which to search; the dataType must be a + * @param fieldName optional field name for which to search; the {@code dataType} must be a * {@link Composite} to search for a field. * @param program The program from within which to find references. * @param discoverTypes if true, the {@link DataTypeReferenceFinder} service will be used to diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/VariableTypeLocationDescriptor.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/VariableTypeLocationDescriptor.java index fdff4ce292..6930eafd0e 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/VariableTypeLocationDescriptor.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/VariableTypeLocationDescriptor.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. @@ -61,7 +61,7 @@ class VariableTypeLocationDescriptor extends DataTypeLocationDescriptor { /** * Overridden to catch special cases when processing variable locations. This method will * call to the {@link super#getHighlights(String, Object, Class, Color)} - * super implementation if no variable highlights are found. + * {@code super} implementation if no variable highlights are found. * * @see DataTypeLocationDescriptor#getHighlights(String, Object, Class, Color) */ diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/programtree/DnDTreeCellRenderer.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/programtree/DnDTreeCellRenderer.java index 62b7f21335..42cc5a3f76 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/programtree/DnDTreeCellRenderer.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/programtree/DnDTreeCellRenderer.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. @@ -90,7 +90,7 @@ class DnDTreeCellRenderer extends DefaultTreeCellRenderer { /** * Enables and disables the rendering of HTML content in this renderer. If enabled, this * renderer will interpret HTML content when the text this renderer is showing begins with - * <html> + * {@code } * * @param enable true to enable HTML rendering; false to disable it */ diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/references/ExternalReferencesProvider.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/references/ExternalReferencesProvider.java index bce0cc19d1..ffd3605433 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/references/ExternalReferencesProvider.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/references/ExternalReferencesProvider.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. @@ -49,7 +49,6 @@ import resources.Icons; /** * ComponentProvider that displays a table of External Programs. - *

*/ public class ExternalReferencesProvider extends ComponentProviderAdapter { private static Icon ADD_ICON = Icons.ADD_ICON; diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/stackeditor/StackEditorModel.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/stackeditor/StackEditorModel.java index 71607a065e..fa3c7bcc2a 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/stackeditor/StackEditorModel.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/stackeditor/StackEditorModel.java @@ -446,9 +446,6 @@ public class StackEditorModel extends CompositeEditorModel { setRelOffsetSelection(offsetSelection); } - /** - * - */ private OffsetPairs getRelOffsetSelection() { OffsetPairs offsets = new OffsetPairs(); int num = selection.getNumRanges(); @@ -469,9 +466,6 @@ public class StackEditorModel extends CompositeEditorModel { return offsets; } - /** - * - */ private void setRelOffsetSelection(OffsetPairs offsets) { FieldSelection newSelection = new FieldSelection(); int num = offsets.getNumPairs(); diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/string/StringTableModel.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/string/StringTableModel.java index addd2a92ad..dfc9efb60c 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/string/StringTableModel.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/string/StringTableModel.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. @@ -33,7 +33,6 @@ import ghidra.util.task.TaskMonitor; /** * Table model for the Search -> For Strings... result dialog. - *

*/ public class StringTableModel extends AddressBasedTableModel { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/strings/ViewStringsPlugin.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/strings/ViewStringsPlugin.java index e5a5d5e887..4fc6aa71af 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/strings/ViewStringsPlugin.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/strings/ViewStringsPlugin.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,8 +47,6 @@ import resources.ResourceManager; /** * Plugin that provides the "Defined Strings" table, where all the currently defined * string data in the program is listed. - *

- * */ //@formatter:off @PluginInfo( diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/symboltree/nodes/OrganizationNode.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/symboltree/nodes/OrganizationNode.java index 59045f61d3..47f9f8cabe 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/symboltree/nodes/OrganizationNode.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/symboltree/nodes/OrganizationNode.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. @@ -94,12 +94,12 @@ public class OrganizationNode extends SymbolTreeNode { * abcc * g * - *

+ * * @param list list of child nodes of to breakup into smaller groups * @param maxGroupSize the max number of nodes to allow before trying to organize into * smaller groups * @param monitor the TaskMonitor to be checked for canceling this operation - * @return the given list sub-grouped as outlined above + * @return the given {@code list} sub-grouped as outlined above * @throws CancelledException if the operation is cancelled */ public static List organize(List list, int maxGroupSize, 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 570a486c13..830b045b4e 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 @@ -88,7 +88,7 @@ import ghidra.util.Msg; *

* For example, the Cursor Position sequence is documented as: *

- * CSI n ; m H + * {@code CSI n ; m H} *

* Supposing {@code n} is 13 and {@code m} is 40, this sequence would be encoded as the string * {@code "\033[13;40H"}. The parser will handle decoding the CSI, parameters, and final byte @@ -682,7 +682,7 @@ public interface VtHandler { } /** - * Parse a sequence of integers in the form n ; m ; .... + * Parse a sequence of integers in the form {@code n ; m ;} .... * *

* This is designed to replace the {@link String#split(String)} and diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/match/SubroutineMatch.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/match/SubroutineMatch.java index 7b62453bde..5d9e726067 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/match/SubroutineMatch.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/match/SubroutineMatch.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. @@ -31,9 +31,7 @@ public class SubroutineMatch { private Address[] progAAddrs; private Address[] progBAddrs; private String reason; - /** - * - */ + public SubroutineMatch(String reason) { progAAddrs = new Address[0]; progBAddrs = new Address[0]; diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/script/GhidraScript.java b/Ghidra/Features/Base/src/main/java/ghidra/app/script/GhidraScript.java index bdc31cc6e7..49ae7c83e8 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/script/GhidraScript.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/script/GhidraScript.java @@ -1515,8 +1515,7 @@ public abstract class GhidraScript extends FlatProgramAPI { *

  • In the headless environment this method will set the {@link #currentSelection} * variable to the given value and update the GhidraState's selection variable.
  • * - *

    - * + * * @param addressSet the set of addresses to include in the selection. If this value is null, * the current selection will be cleared and the variables set to null. */ @@ -1558,7 +1557,6 @@ public abstract class GhidraScript extends FlatProgramAPI { *

  • In the headless environment this method will set the {@link #currentHighlight} * variable to the given value and update the GhidraState's highlight variable.
  • * - *

    * * @param addressSet the set of addresses to include in the highlight. If this value is null, * the current highlight will be cleared and the variables set to null. @@ -2986,7 +2984,6 @@ public abstract class GhidraScript extends FlatProgramAPI { *

    * Note that in both headless and GUI modes, you may specify "PI" or "E" and get the * corresponding floating point value to 15 decimal places. - *

    * * @param title the title of the dialog (in GUI mode) or the first part of the variable name * (in headless mode or when using .properties file) diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/services/MarkerService.java b/Ghidra/Features/Base/src/main/java/ghidra/app/services/MarkerService.java index 2b249f667c..305c48cac0 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/services/MarkerService.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/services/MarkerService.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,6 @@ import ghidra.program.model.listing.Program; * Navigation Margin. The higher the priority, the more likely the marker/bar will be displayed on * the top. Areas will always be lower than marker priorities. *

    - * Recommended Usage
    * Recommended Usage
    * The service used to work independently of {@link Program}s. In order to work effectively this * service has been changed to associate created markers with individual programs. Thus, it is up to diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/BinaryReader.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/BinaryReader.java index 66e3983ff4..c04780f196 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/BinaryReader.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/BinaryReader.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. @@ -80,7 +80,6 @@ public class BinaryReader { /** * Reads and returns an object from the current position in the specified input stream. - *

    * * @param the type of object that will be returned */ @@ -579,7 +578,6 @@ public class BinaryReader { * advancing the current index by the length of the string that was found. *

    * Note: this method no longer trims() the returned String. - *

    * * @return the US-ASCII string at the current index * @exception IOException if an I/O error occurs @@ -596,7 +594,7 @@ public class BinaryReader { * a string from a fixed length field that is padded with trailing null chars) *

    * Note: this method no longer trims() the returned String. - *

    + * * @param length number of bytes to read * @return the US-ASCII string at the current index */ @@ -607,7 +605,6 @@ public class BinaryReader { /** * Reads a null-terminated UTF-16 Unicode string at the current index, * advancing the current index by the length of the string that was found. - *

    * * @return UTF-16 string at the current index * @exception IOException if an I/O error occurs @@ -619,7 +616,6 @@ public class BinaryReader { /** * Reads a fixed length UTF-16 Unicode string at the current index, * advancing the current index by the length of the string that was found. - *

    * * @param charCount number of UTF-16 characters to read (not bytes) * @return the UTF-16 Unicode string at the current index @@ -632,7 +628,6 @@ public class BinaryReader { /** * Reads a null-terminated UTF-8 string at the current index, * advancing the current index by the length of the string that was found. - *

    * * @return UTF-8 string at the current index * @exception IOException if an I/O error occurs @@ -644,7 +639,6 @@ public class BinaryReader { /** * Reads a fixed length UTF-8 string the current index, * advancing the current index by the length of the string that was found. - *

    * * @param length number of bytes to read * @return the UTF-8 string at the current index @@ -658,7 +652,7 @@ public class BinaryReader { * Reads a null terminated string starting at the current index, * using a specific {@link Charset}, advancing the current index by the length of * the string that was found. - *

    + * * @param charset {@link Charset}, see {@link StandardCharsets} * @param charLen number of bytes in each character * @return the string @@ -679,7 +673,7 @@ public class BinaryReader { *

    * Trailing null terminator characters will be removed. (suitable for reading * a string from a fixed length field that is padded with trailing null chars) - *

    + * * @param charCount the number of charLen character elements to read * @param charset {@link Charset}, see {@link StandardCharsets} * @param charLen number of bytes in each character @@ -851,7 +845,6 @@ public class BinaryReader { * the first null character. *

    * Note: this method no longer trims() the returned String. - *

    * * @param index starting position of the string * @return US-ASCII string, excluding the trailing null terminator character @@ -868,7 +861,7 @@ public class BinaryReader { * a string from a fixed length field that is padded with trailing null chars) *

    * Note: this method no longer trims() the returned String. - *

    + * * @param index where the string begins * @param length number of bytes to read * @return the US-ASCII string @@ -883,7 +876,7 @@ public class BinaryReader { * the pre-specified {@link #setLittleEndian(boolean) endianness}. *

    * The end of the string is denoted by a two-byte (ie. short) null character. - *

    + * * @param index where the UTF-16 Unicode string begins * @return the UTF-16 Unicode string * @exception IOException if an I/O error occurs @@ -899,7 +892,7 @@ public class BinaryReader { *

    * Trailing null terminator characters will be removed. (suitable for reading * a string from a fixed length field that is padded with trailing null chars) - *

    + * * @param index the index where the UTF-16 Unicode string begins * @param charCount the number of UTF-16 character elements to read. * @return the UTF-16 Unicode string @@ -911,7 +904,7 @@ public class BinaryReader { /** * Reads a null-terminated UTF-8 string starting at index. - *

    + * * @param index where the UTF-8 string begins * @return the string * @exception IOException if an I/O error occurs @@ -926,7 +919,7 @@ public class BinaryReader { *

    * Trailing null terminator characters will be removed. (suitable for reading * a string from a fixed length field that is padded with trailing null chars) - *

    + * * @param index the index where the UTF-8 string begins * @param length the number of bytes to read * @return the string @@ -942,7 +935,7 @@ public class BinaryReader { *

    * Trailing null terminator characters will be removed. (suitable for reading * a string from a fixed length field that is padded with trailing null chars) - *

    + * * @param index the index where the string begins * @param charCount the number of charLen character elements to read * @param charset {@link Charset}, see {@link StandardCharsets} @@ -965,7 +958,7 @@ public class BinaryReader { /** * Reads a null-terminated string starting at index, using a specific * {@link Charset}. - *

    + * * @param index where the string begins * @param charset {@link Charset}, see {@link StandardCharsets} * @param charLen number of bytes in each character diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/ByteProviderInputStream.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/ByteProviderInputStream.java index 32b9f25bf1..402e01601e 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/ByteProviderInputStream.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/ByteProviderInputStream.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,14 +30,13 @@ public class ByteProviderInputStream extends InputStream { * An {@link InputStream} that reads from a {@link ByteProvider}, and DOES * {@link ByteProvider#close() close()} the underlying ByteProvider when * closed itself. - *

    */ public static class ClosingInputStream extends ByteProviderInputStream { /** * Creates an {@link InputStream} that reads from a {@link ByteProvider}, that * DOES {@link ByteProvider#close() close()} the underlying ByteProvider when * closed itself. - *

    + * * @param provider the {@link ByteProvider} to read from (and close) */ public ClosingInputStream(ByteProvider provider) { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/ByteProviderPaddedInputStream.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/ByteProviderPaddedInputStream.java index 299b494ae6..44d321d160 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/ByteProviderPaddedInputStream.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/ByteProviderPaddedInputStream.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,7 +39,7 @@ public class ByteProviderPaddedInputStream extends InputStream { * The source ByteProvider is not closed when this stream is closed. *

    * The total number of bytes that can be read from this instance will be length + padCount. - *

    + * * @param provider the {@link ByteProvider} to wrap. * @param startOffset the starting offset in the ByteProvider. * @param length the number of bytes from the {@link ByteProvider} to allow to be read by this InputStream. diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/ByteProviderWrapper.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/ByteProviderWrapper.java index fced8c7a90..c882b33959 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/ByteProviderWrapper.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/ByteProviderWrapper.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. @@ -33,7 +33,6 @@ public class ByteProviderWrapper implements ByteProvider { /** * Creates a wrapper around a {@link ByteProvider} that contains the same bytes as the specified * provider, but with a new {@link FSRL} identity. - *

    * * @param provider {@link ByteProvider} to wrap * @param fsrl {@link FSRL} identity for the instance diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/FileByteProvider.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/FileByteProvider.java index ed84f6b06e..aaa145c0a8 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/FileByteProvider.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/FileByteProvider.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. @@ -135,7 +135,6 @@ public class FileByteProvider implements MutableByteProvider { * Read bytes at the specified index into the given byte array. *

    * See {@link InputStream#read(byte[], int, int)}. - *

    * * @param index file offset to start reading * @param buffer byte array that will receive the bytes diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/GhidraRandomAccessFile.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/GhidraRandomAccessFile.java index 1bd09b64fc..4bf0a81383 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/GhidraRandomAccessFile.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/GhidraRandomAccessFile.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. @@ -55,7 +55,6 @@ public class GhidraRandomAccessFile implements AutoCloseable { *

    * This implementation relies on java.net.RandomAccessFile, * but adds buffering to limit the amount. - *

    * *

    The mode argument specifies the access mode * in which the file is to be opened. The permitted values and their diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/InputStreamByteProvider.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/InputStreamByteProvider.java index ec3c1017f6..b5c8b70884 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/InputStreamByteProvider.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/InputStreamByteProvider.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. @@ -24,7 +24,6 @@ import java.io.*; *

    * In other words, this {@link ByteProvider} can only be used to read data at ever increasing * offsets. - *

    */ public class InputStreamByteProvider implements ByteProvider { private InputStream inputStream; diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/LEB128Info.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/LEB128Info.java index fb0820de88..265e49b7dd 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/LEB128Info.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/LEB128Info.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,7 +27,7 @@ public class LEB128Info { /** * Reads an unsigned LEB128 value from the BinaryReader and returns a {@link LEB128Info} instance * that contains the value along with size and position metadata. - *

    + * * @param reader {@link BinaryReader} to read bytes from * @return a {@link LEB128Info} instance with the read LEB128 value with metadata * @throws IOException if an I/O error occurs or value is outside the range of a java @@ -40,7 +40,7 @@ public class LEB128Info { /** * Reads an signed LEB128 value from the BinaryReader and returns a {@link LEB128Info} instance * that contains the value along with size and position metadata. - *

    + * * @param reader {@link BinaryReader} to read bytes from * @return a {@link LEB128Info} instance with the read LEB128 value with metadata * @throws IOException if an I/O error occurs or value is outside the range of a java @@ -125,7 +125,7 @@ public class LEB128Info { /** * Reads a LEB128 value from the BinaryReader and returns a {@link LEB128Info} instance * that contains the value along with size and position metadata. - *

    + * * @param reader {@link BinaryReader} to read bytes from * @param isSigned true if the value is signed * @return a {@link LEB128Info} instance with the read LEB128 value with metadata diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/MemoryByteProvider.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/MemoryByteProvider.java index 938eef22e7..1f38a3109a 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/MemoryByteProvider.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/MemoryByteProvider.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. @@ -104,7 +104,6 @@ public class MemoryByteProvider implements ByteProvider { * Constructs a new {@link MemoryByteProvider} for a specific {@link AddressSpace}. Bytes * will be provided relative to the minimum address (typically 0) in the space, and ranges * to the highest address in the same address space currently found in the memory map. - *

    * * * @param memory the {@link Memory} diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/RandomAccessByteProvider.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/RandomAccessByteProvider.java index 836978f2df..9a13c7948a 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/RandomAccessByteProvider.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/RandomAccessByteProvider.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,7 +30,7 @@ import ghidra.util.Msg; * {@link ArrayIndexOutOfBoundsException}s. *

    * See {@link SynchronizedByteProvider} as a solution. - *

    + * * @deprecated See {@link FileByteProvider} as replacement ByteProvider. */ @Deprecated(since = "10.1", forRemoval = true) diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/RangeMappedByteProvider.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/RangeMappedByteProvider.java index c48f7915bc..ad3a572c16 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/RangeMappedByteProvider.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/RangeMappedByteProvider.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. @@ -177,7 +177,6 @@ public class RangeMappedByteProvider implements ByteProvider { * Read bytes at the specified index into the given byte array. *

    * See {@link InputStream#read(byte[], int, int)}. - *

    * * @param index file offset to start reading * @param buffer byte array that will receive the bytes diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/UnlimitedByteProviderWrapper.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/UnlimitedByteProviderWrapper.java index 774243d28b..eea4db74d0 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/UnlimitedByteProviderWrapper.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/UnlimitedByteProviderWrapper.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,7 +30,6 @@ public class UnlimitedByteProviderWrapper extends ByteProviderWrapper { /** * Creates a wrapper around a {@link ByteProvider} that contains the same bytes as the specified * provider. - *

    * * @param provider {@link ByteProvider} to wrap * @throws IOException if error @@ -42,7 +41,6 @@ public class UnlimitedByteProviderWrapper extends ByteProviderWrapper { /** * Creates a wrapper around a {@link ByteProvider} that contains the same bytes as the specified * provider, but with a new {@link FSRL} identity. - *

    * * @param provider {@link ByteProvider} to wrap * @param fsrl {@link FSRL} identity for the instance diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/coff/archive/CoffArchiveHeader.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/coff/archive/CoffArchiveHeader.java index 1e7ccb327a..4213d9aca3 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/coff/archive/CoffArchiveHeader.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/coff/archive/CoffArchiveHeader.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. @@ -41,7 +41,7 @@ public final class CoffArchiveHeader implements StructConverter { /** * Returns true if the data contained in the {@link ByteProvider provider} contains * a COFF Archive file. - *

    + * * @param provider * @return * @throws IOException @@ -56,7 +56,7 @@ public final class CoffArchiveHeader implements StructConverter { *

    * Returns a {@link CoffArchiveHeader} that has a list of the * {@link CoffArchiveMemberHeader members} in the archive. - *

    + * * @param provider * @param monitor * @return diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/coff/archive/CoffArchiveMemberHeader.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/coff/archive/CoffArchiveMemberHeader.java index c179089778..8406eab486 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/coff/archive/CoffArchiveMemberHeader.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/coff/archive/CoffArchiveMemberHeader.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. @@ -20,7 +20,6 @@ import java.io.IOException; import ghidra.app.util.bin.*; import ghidra.program.model.data.*; import ghidra.util.Msg; -import ghidra.util.StringUtilities; import ghidra.util.exception.DuplicateNameException; public class CoffArchiveMemberHeader implements StructConverter { @@ -58,7 +57,7 @@ public class CoffArchiveMemberHeader implements StructConverter { *

    * The archive member's name is fixed up using the specified {@link LongNamesMember longNames} * object. - *

    + * * @param reader stream from which to read the COFF archive member header from * @param longNames optional, string table with long file names (only present in some * COFF ar formats) diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DIEAggregate.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DIEAggregate.java index 731e341d85..74165170d0 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DIEAggregate.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DIEAggregate.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. @@ -70,7 +70,7 @@ public class DIEAggregate { *

    * DW_AT_abstract_origin and DW_AT_specification attributes are followed to find the previous * {@link DebugInfoEntry} instances. - *

    + * * @param die starting DIE record * @return new {@link DIEAggregate} made up of the starting DIE and all DIEs that it points * to via abstract_origin and spec attributes. @@ -131,7 +131,7 @@ public class DIEAggregate { *

    * Mainly useful early in the {@link DWARFCompilationUnit}'s bootstrapping process * when it needs to read values from DIEs. - *

    + * * @param die {@link DebugInfoEntry} * @return {@link DIEAggregate} containing a single DIE */ @@ -318,7 +318,6 @@ public class DIEAggregate { *

    * Attributes are searched for in each fragment in this aggregate, starting with the * 'head' fragment, progressing toward the 'decl' fragment. - *

    * * @param attribute See {@link DWARFAttribute} * @param clazz must be derived from {@link DWARFAttributeValue} @@ -337,7 +336,6 @@ public class DIEAggregate { *

    * Attributes are searched for in each fragment in this aggregate, starting with the * 'head' fragment, progressing toward the 'decl' fragment. - *

    * * @param attribute See {@link DWARFAttribute} * @return DWARFAttributeValue, or null if not found @@ -362,7 +360,7 @@ public class DIEAggregate { /** * Returns the boolean value of the requested attribute, or -defaultValue- if * the attribute is missing or not the correct type. - *

    + * * @param attribute {@link DWARFAttribute} id * @param defaultValue value to return if attribute is not present * @return boolean value, or the defaultValue if attribute is not present @@ -375,7 +373,7 @@ public class DIEAggregate { /** * Returns the string value of the requested attribute, or -defaultValue- if * the attribute is missing or not the correct type. - *

    + * * @param attribute {@link DWARFAttribute} id * @param defaultValue value to return if attribute is not present * @return String value, or the defaultValue if attribute is not present @@ -391,7 +389,7 @@ public class DIEAggregate { /** * Returns the string value of the {@link DWARFAttribute#DW_AT_name dw_at_name} attribute, * or null if it is missing. - *

    + * * @return name of this DIE aggregate, or null if missing */ public String getName() { @@ -435,7 +433,7 @@ public class DIEAggregate { /** * Returns the {@link DIEAggregate diea} instance pointed to by the requested attribute, * or null if the attribute does not exist. - *

    + * * @param attribute {@link DWARFAttribute} id * @return {@link DIEAggregate}, or the null if attribute is not present */ @@ -484,7 +482,7 @@ public class DIEAggregate { /** * Return a list of children that are of a specific DWARF type. - *

    + * * @param childTag see {@link DWARFTag DWARFTag DW_TAG_* values} * @return List of children DIEs that match the specified tag */ @@ -527,7 +525,7 @@ public class DIEAggregate { /** * Returns the signed integer value of the requested attribute after resolving * any DWARF expression opcodes. - *

    + * * @param attribute {@link DWARFAttribute} id * @param defaultValue value to return if attribute is not present * @return int value, or the defaultValue if attribute is not present @@ -560,7 +558,7 @@ public class DIEAggregate { /** * Returns the unsigned integer value of the requested attribute after resolving * any DWARF expression opcodes. - *

    + * * @param attribute {@link DWARFAttribute} id * @param defaultValue value to return if attribute is not present * @return unsigned long value, or the defaultValue if attribute is not present @@ -673,7 +671,7 @@ public class DIEAggregate { /** * Returns true if this DIE has a DW_AT_declaration attribute and * does NOT have a matching inbound DW_AT_specification reference. - *

    + * * @return boolean true if this DIE has a DW_AT_declaration attribute and * does NOT have a matching inbound DW_AT_specification reference */ diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFCompilationUnit.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFCompilationUnit.java index 91d53bc0c0..ce94a0baa9 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFCompilationUnit.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFCompilationUnit.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,7 +34,6 @@ import ghidra.util.task.TaskMonitor; * The first DIE record must be a DW_TAG_compile_unit. *

    * DIE records are identified by their byte offset in the .debug_info section. - *

    */ public class DWARFCompilationUnit extends DWARFUnitHeader { /** 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 9340af6564..5d2caa5cf4 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 @@ -36,7 +36,6 @@ import ghidra.util.SystemUtilities; *

    * When a candidate data type is matched with an existing data type, this * conflict handler will specify that the new data type is: - *

    *

      *
    • discarded and replaced by the existing data type * ({@link ConflictResult#USE_EXISTING})
    • @@ -45,7 +44,6 @@ import ghidra.util.SystemUtilities; *
    * or the candidate data type was NOT matched with an existing data type, * and the new data type is: - *

    *

      *
    • kept, but renamed with a .conflictNNNN suffix to make it unique * ({@link ConflictResult#RENAME_AND_ADD})
    • @@ -147,7 +145,7 @@ public class DWARFDataTypeConflictHandler extends DataTypeConflictHandler { *

      Each defined component in the candidate partial structure must be present * in the 'full' structure and must be equiv.

      The order and sparseness of * the candidate partial structure is not important, only that all of its - * defined components are present in the full structure.

      + * defined components are present in the full structure. */ private boolean isStructurePart(Structure full, Structure part, Set visitedDataTypes) { // Both structures should be equal in length diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFDataTypeImporter.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFDataTypeImporter.java index ab62a9af24..b160583c32 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFDataTypeImporter.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFDataTypeImporter.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. @@ -42,7 +42,6 @@ import ghidra.util.exception.InvalidInputException; *

      * Create a new instance of this class for each {@link DIEAggregate} datatype that you wish * to convert into a DataType. - *

      */ public class DWARFDataTypeImporter { private DWARFProgram prog; @@ -344,7 +343,7 @@ public class DWARFDataTypeImporter { /** * Gets the corresponding Ghidra base type. - *

      + * * @param diea * @throws IOException * @throws DWARFExpressionException @@ -401,7 +400,7 @@ public class DWARFDataTypeImporter { /** * Simple passthru, returns whatever type this "const" modifier applies to. - *

      + * * @param diea * @throws IOException * @throws DWARFExpressionException @@ -424,7 +423,6 @@ public class DWARFDataTypeImporter { *

      * This method takes liberties with the normal{@literal DWARF->Ghidra Impl DataType->Ghidra DB DataType} * workflow to be able to merge values into previous db enum datatypes. - *

      * * @param diea * @return diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFDataTypeManager.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFDataTypeManager.java index 97e9dd9a0f..7ae6ba572e 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFDataTypeManager.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFDataTypeManager.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. @@ -198,7 +198,7 @@ public class DWARFDataTypeManager { * Returns a Ghidra {@link DataType} corresponding to the specified {@link DIEAggregate}, * or the specified defaultValue if the DIEA param is null or does not map to an already * defined datatype (registered with {@link #addDataType(long, DataType, DWARFSourceInfo)}). - *

      + * * @param diea {@link DIEAggregate} that defines a data type * @param defaultValue Ghidra {@link DataType} to return if the specified DIEA is null * or not already defined. @@ -230,7 +230,6 @@ public class DWARFDataTypeManager { * Returns a Ghidra {@link DataType} corresponding to the specified DIE (based on its * offset), or the specified defaultValue if the DIE does not map to a defined * datatype (registered with {@link #addDataType(long, DataType, DWARFSourceInfo)}). - *

      * * @param dieOffset offset of a DIE record that defines a data type * @param defaultValue Ghidra {@link DataType} to return if the specified DIE not already defined. @@ -312,7 +311,7 @@ public class DWARFDataTypeManager { /** * Returns a Ghidra {@link DataType datatype} that corresponds to a type * that can be used to represent an offset. - *

      + * * @param size * @return */ @@ -366,7 +365,7 @@ public class DWARFDataTypeManager { *

      * Any newly created Ghidra data types will be cached and the same instance will be returned * if the same DWARF named base type is requested again. - *

      + * * @param name * @param dwarfSize * @param dwarfEncoding @@ -672,7 +671,6 @@ public class DWARFDataTypeManager { /** * Regex to match common fixed-size type names like "int64", "int64_t", etc, by triggering * off some known size designators in the string. - *

      *

       	 * \D+ ← one or more non-digits
       	 *    (8|16|32|64|128) ← list of common sizes that we are triggering on
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFLocationList.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFLocationList.java
      index 3025f42ba4..13fcfb1c53 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFLocationList.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFLocationList.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,7 +47,7 @@ public class DWARFLocationList {
       
       	/**
       	 * Read a v4 {@link DWARFLocationList} from the debug_loc section.
      -	 * 

      + * * @param reader stream positioned at the start of a .debug_loc location list * @param cu the compUnit that refers to the location list * @return list of DWARF locations (address range and location expression) diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFName.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFName.java index 92cd579305..03c9970cab 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFName.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFName.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,7 +26,6 @@ import ghidra.program.model.symbol.SymbolType; /** * A immutable hierarchical path based name implementation that can be viewed as either * {@link Namespace namespaces} or {@link CategoryPath categorypaths}. - *

      */ public class DWARFName { @@ -246,7 +245,6 @@ public class DWARFName { /** * Returns true if this instance's {@link #getName() name} value is different * than its {@link #getOriginalName() original} form. - *

      * * @return boolean true if the original name doesn't match the ghidra-ized name */ diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFProgram.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFProgram.java index de3f7a4db8..f4c862b686 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFProgram.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFProgram.java @@ -71,7 +71,7 @@ public class DWARFProgram implements Closeable { * If the program is a MachO binary (Mac), it must have a ".dSYM" directory co-located * next to the original binary file on the native filesystem (outside of Ghidra). See the * DSymSectionProvider for more info. - *

      + * * @param program {@link Program} to test * @return boolean true if program probably has DWARF info, false if not */ @@ -104,7 +104,6 @@ public class DWARFProgram implements Closeable { *

      * This is similar to {@link #isDWARF(Program)}, but is a stronger check that is more * expensive as it could involve searching for external files. - *

      * * @param program {@link Program} to test * @param monitor {@link TaskMonitor} that can be used to cancel @@ -1336,7 +1335,7 @@ public class DWARFProgram implements Closeable { * A fixup value that needs to be applied to static addresses of the program. *

      * This value is necessary if the program's built-in base address is overridden at import time. - *

      + * * @return long value to add to static addresses discovered in DWARF to make it agree with * Ghidra's imported program. */ diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFRegisterMappings.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFRegisterMappings.java index 8c7cf96c41..6b734c4c26 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFRegisterMappings.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFRegisterMappings.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. @@ -15,11 +15,11 @@ */ package ghidra.app.util.bin.format.dwarf; -import ghidra.program.model.lang.Register; - import java.util.Collections; import java.util.Map; +import ghidra.program.model.lang.Register; + /** * Immutable mapping information between DWARF and Ghidra. *

      @@ -30,7 +30,7 @@ import java.util.Map; * in xml files referenced from the language *.ldefs file in an * <external_name tool="DWARF.register.mapping.file" name="register_mapping_filename_here"/> *

      - * The format is:

      + * The format is: *

        * <dwarf>
        *   <register_mappings>
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFRegisterMappingsManager.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFRegisterMappingsManager.java
      index ae7ba3e677..59c82d7358 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFRegisterMappingsManager.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFRegisterMappingsManager.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.
      @@ -15,13 +15,12 @@
        */
       package ghidra.app.util.bin.format.dwarf;
       
      +import java.io.IOException;
      +import java.io.InputStream;
       import java.util.*;
       import java.util.regex.Matcher;
       import java.util.regex.Pattern;
       
      -import java.io.IOException;
      -import java.io.InputStream;
      -
       import org.jdom.*;
       import org.jdom.input.SAXBuilder;
       
      @@ -32,7 +31,6 @@ import ghidra.util.xml.XmlUtilities;
       
       /**
        * Factory class to instantiate and cache {@link DWARFRegisterMappings} objects.
      - * 

      */ public class DWARFRegisterMappingsManager { private static final String DWARF_REGISTER_MAPPING_NAME = "DWARF.register.mapping.file"; @@ -54,7 +52,6 @@ public class DWARFRegisterMappingsManager { /** * Returns a possibly cached {@link DWARFRegisterMappings} object for the * specified language, - *

      * * @param lang {@link Language} to get the matching DWARF register mappings * for @@ -79,7 +76,6 @@ public class DWARFRegisterMappingsManager { *

      * Throws {@link IOException} if the lang does not have a mapping or it is * invalid. - *

      * * @param lang {@link Language} to read the matching DWARF register mappings * for @@ -118,7 +114,6 @@ public class DWARFRegisterMappingsManager { /** * Creates a new {@link DWARFRegisterMappings} from the data present in the * xml element. - *

      * * @param rootElem JDom XML element containing the <dwarf> root * element of the mapping file. diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFUtil.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFUtil.java index 310a74e11d..2ebf9c515b 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFUtil.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFUtil.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. @@ -58,7 +58,7 @@ public class DWARFUtil { * which holds a specific value. *

      * Can be thought of as an enum numeric value to to name lookup. - *

      + * * @param clazz * @param value * @return @@ -110,7 +110,7 @@ public class DWARFUtil { *

      * For example, "_ZN19class1_inline_funcs3fooEv" -> * [19 chars]'class1_inline_funcs', [3 chars]'foo' - *

      + * * @param s * @return */ @@ -143,7 +143,7 @@ public class DWARFUtil { /** * Try to find gnu mangled name nesting info in a DIE's children's linkage strings. - *

      + * * @param die * @return a list of string of nesting names, ending with what should be the DIE parameter's * name. @@ -175,7 +175,7 @@ public class DWARFUtil { *

      * operator<() and operator<<() are handled so their angle brackets * don't trigger the template start/end angle bracket incorrectly. - *

      + * * @param name symbol name with C++ template portions * @return base portion of the symbol name without template portion */ @@ -193,7 +193,7 @@ public class DWARFUtil { /** * Creates a name for anon types based on their position in their parent's childList. - *

      + * * @param diea the die aggregate. * @return the anonymous name of the die aggregate. */ @@ -468,7 +468,7 @@ public class DWARFUtil { * Returns a value specified in a {@link Language} definition via a *

      <external_name tool="name" name="value"/>
      * entry. - *

      + * * @param lang {@link Language} to query * @param name name of the value * @return String value diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DataTypeGraphComparator.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DataTypeGraphComparator.java index 2da22b1022..b060431346 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DataTypeGraphComparator.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DataTypeGraphComparator.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. @@ -45,7 +45,6 @@ public class DataTypeGraphComparator { * This callback can choose to abort traversing the tree of child types if it returns * false. (ie. if this was a Pointer DataType, returning false would stop * the graph comparator from comparing the DataType pointed to by this Pointer) - *

      * * @param dt1 element from the first/left/src DataType graph * @param dt2 matching element from the second/right/dest DataType graph @@ -57,7 +56,7 @@ public class DataTypeGraphComparator { /** * Compares two {@link DataType datatypes} graphs, calling the observer callback * for each paired DataType that occupy equivalent positions in each graph. - *

      + * * @param preDT - Original (impl) DataType from before submitting to DataTypeManager. * @param postDT - Result DataType from the DataTypeManager * @param observer - Callback called for each position in the preDT graph that has a matching diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DebugInfoEntry.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DebugInfoEntry.java index 3fcb4359d1..7e60691ca6 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DebugInfoEntry.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DebugInfoEntry.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. @@ -132,7 +132,7 @@ public class DebugInfoEntry { /** * Return a list of children that are of a specific DWARF type. - *

      + * * @param childTag DIE tag used to filter the child DIEs * @return list of matching child DIE records */ diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/StringTable.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/StringTable.java index 1991ce42a1..6fb5cf85b2 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/StringTable.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/StringTable.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. @@ -54,7 +54,7 @@ public class StringTable { /** * Returns true if the specified offset is a valid offset for this string table. - *

      + * * @param offset location of possible string * @return boolean true if location is valid */ diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/attribs/DWARFAttribute.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/attribs/DWARFAttribute.java index 360071b195..2de004e415 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/attribs/DWARFAttribute.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/attribs/DWARFAttribute.java @@ -229,7 +229,7 @@ public enum DWARFAttribute { * Reads a {@link DWARFAttribute.AttrDef} instance from the {@link BinaryReader reader}. *

      * Returns a null if its a end-of-list marker. - *

      + * * @param reader {@link BinaryReader} abbr stream * @return new {@link AttrDef}, or null if end-of-list * @throws IOException if error reading diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/attribs/DWARFAttributeDef.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/attribs/DWARFAttributeDef.java index c01b925f07..63e6bae7ae 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/attribs/DWARFAttributeDef.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/attribs/DWARFAttributeDef.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. @@ -43,7 +43,7 @@ public class DWARFAttributeDef> { * Reads a {@link DWARFAttributeDef} instance from the {@link BinaryReader reader}. *

      * Returns a null if its a end-of-list marker (which is only used by an attributespec list). - *

      + * * @param attribute id enum type * @param reader {@link BinaryReader} * @param mapper func that converts an attribute id int into its enum diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/expression/DWARFExpression.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/expression/DWARFExpression.java index c48eb7e948..cbd0a7badb 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/expression/DWARFExpression.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/expression/DWARFExpression.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. @@ -191,7 +191,7 @@ public class DWARFExpression { /** * Finds the index of an {@link DWARFExpressionOperation operation} by its offset * from the beginning of the expression. - *

      + * * @param offset * @return -1 if there is no op at the specified offset */ diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/expression/DWARFExpressionEvaluator.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/expression/DWARFExpressionEvaluator.java index 5e06feb7b0..210d480e07 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/expression/DWARFExpressionEvaluator.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/expression/DWARFExpressionEvaluator.java @@ -34,7 +34,6 @@ import ghidra.program.model.lang.Register; * Can only specify offset from register for framebase and stack relative
      *

      * Result can be a numeric value (ie. static address) or a register 'name' or a stack based offset. - *

      */ public class DWARFExpressionEvaluator { @@ -121,7 +120,7 @@ public class DWARFExpressionEvaluator { *

      * Note, you should check {@link #isDeref()} to see if the register is just a pointer * to the object instead of the object itself. - *

      + * * @return */ public Register getTerminalRegister() { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/expression/DWARFExpressionOperation.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/expression/DWARFExpressionOperation.java index 6eee3a9f75..a882646321 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/expression/DWARFExpressionOperation.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/expression/DWARFExpressionOperation.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. @@ -21,7 +21,6 @@ import java.util.Arrays; * An immutable representation of a single {@link DWARFExpression} instruction and its operands. *

      * A DWARF expression operation can take 0, 1, or 2 operands. - *

      */ class DWARFExpressionOperation { protected final int offset; @@ -71,7 +70,7 @@ class DWARFExpressionOperation { *

      * Ie. If this opcode was DW_OP_reg12 (0x5c), and the base op code was DW_OP_reg0 (0x50), * the result value would be 12. - *

      + * * @param baseOpCode Ordinal value of the opcode that this opcode is being compared ot. * @return numeric difference between this opcode and the base opcode. */ diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/line/DWARFLineContentType.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/line/DWARFLineContentType.java index 323bad5bf0..9c13bdfad4 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/line/DWARFLineContentType.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/line/DWARFLineContentType.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. @@ -70,7 +70,7 @@ public enum DWARFLineContentType { * Reads a {@link DWARFLineContentType.Def} instance from the {@link BinaryReader reader}. *

      * Returns a null if its a end-of-list marker. - *

      + * * @param reader {@link BinaryReader} stream * @return {@link DWARFLineContentType.Def}, or null if stream was at a end-of-list marker * (which isn't really a thing for line content defs, but is a thing for attribute defs) diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/sectionprovider/CompressedSectionProvider.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/sectionprovider/CompressedSectionProvider.java index dd00181eb2..fa28425570 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/sectionprovider/CompressedSectionProvider.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/sectionprovider/CompressedSectionProvider.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. @@ -15,13 +15,12 @@ */ package ghidra.app.util.bin.format.dwarf.sectionprovider; +import java.io.IOException; +import java.io.InputStream; import java.util.HashMap; import java.util.Map; import java.util.zip.InflaterInputStream; -import java.io.IOException; -import java.io.InputStream; - import ghidra.app.util.bin.BinaryReader; import ghidra.app.util.bin.ByteProvider; import ghidra.formats.gfilesystem.FSUtilities; @@ -35,7 +34,6 @@ import ghidra.util.task.TaskMonitor; * A wrapper around another DWARFSectionProvider, this provider * fetches DWARF section data that has been compressed and stored in sections in the underlying * {@link DWARFSectionProvider}. - *

      */ public class CompressedSectionProvider implements DWARFSectionProvider { private static final int ZLIB_MAGIC_BE = 0x5a4c4942; // "ZLIB" diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/elf/ElfCompressedSectionHeader.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/elf/ElfCompressedSectionHeader.java index fdcb9efe83..d794b32e7f 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/elf/ElfCompressedSectionHeader.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/elf/ElfCompressedSectionHeader.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,7 +23,6 @@ import ghidra.app.util.bin.BinaryReader; * Header at the beginning of an ELF compressed section. *

      * See https://docs.oracle.com/cd/E53394_01/html/E54813/section_compression.html - *

      *

        * typedef struct {
        *      Elf32_Word      ch_type;
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/elf/info/NoteGnuProperty.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/elf/info/NoteGnuProperty.java
      index 0faed9a37e..a525879c1b 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/elf/info/NoteGnuProperty.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/elf/info/NoteGnuProperty.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.
      @@ -15,11 +15,10 @@
        */
       package ghidra.app.util.bin.format.elf.info;
       
      +import java.io.IOException;
       import java.util.ArrayList;
       import java.util.List;
       
      -import java.io.IOException;
      -
       import ghidra.app.util.bin.BinaryReader;
       import ghidra.app.util.bin.StructConverter;
       import ghidra.framework.options.Options;
      @@ -35,7 +34,6 @@ import ghidra.util.NumericUtilities;
        * An ELF note that contains a list of enumerated "properties".
        * 

      * Currently known property types are stack_size and no_copy_on_protected (flag). - *

      *

        *  array of Elf_Prop {
        *    word pr_type;
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/GoRegisterInfo.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/GoRegisterInfo.java
      index 19d496746c..9e3ed89ed0 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/GoRegisterInfo.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/GoRegisterInfo.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,7 +30,6 @@ import ghidra.util.exception.InvalidInputException;
       /**
        * Immutable information about registers, alignment sizes, etc needed to allocate storage
        * for parameters during a function call.
      - * 

      */ public class GoRegisterInfo { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/GolangDWARFFunctionFixup.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/GolangDWARFFunctionFixup.java index b18afde3ff..4f8cf5522a 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/GolangDWARFFunctionFixup.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/GolangDWARFFunctionFixup.java @@ -45,7 +45,6 @@ import ghidra.util.task.TaskMonitor; *

      * Go's 'unique' usage of DW_TAG_subroutine_type to define its ptr-to-ptr-to-func is handled in * DWARFDataTypeImporter.makeDataTypeForFunctionDefinition(). - *

      */ @ExtensionPointProperties(priority = DWARFFunctionFixup.PRIORITY_NORMAL_EARLY) public class GolangDWARFFunctionFixup implements DWARFFunctionFixup { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/GoRttiMapper.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/GoRttiMapper.java index 29885217e8..81e161f8d1 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/GoRttiMapper.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/GoRttiMapper.java @@ -1026,7 +1026,6 @@ public class GoRttiMapper extends DataTypeMapper implements DataTypeMapperContex /** * Returns a function definition for a method that is attached to a golang type. - *

      * * @param methodName name of method * @param methodType golang function def type @@ -1339,7 +1338,6 @@ public class GoRttiMapper extends DataTypeMapper implements DataTypeMapperContex /** * Returns the {@link GoName} corresponding to an offset that is relative to the controlling * GoModuledata's typesOffset. - *

      * * @param ptrInModule the address of the structure that contains the offset that needs to be * calculated. The containing-structure's address is important because it indicates which @@ -1534,7 +1532,7 @@ public class GoRttiMapper extends DataTypeMapper implements DataTypeMapperContex /** * Returns true if the specified function should be included in the bootstrap function defs * that are written to the golang_NNNN.gdt archive. - *

      + * * @return true if function should be included in golang.gdt bootstrap file */ public boolean isBootstrapFunction() { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/GoSlice.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/GoSlice.java index d6b2512cc7..c6d13307ee 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/GoSlice.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/GoSlice.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,7 +38,6 @@ import ghidra.util.exception.CancelledException; *

      * Like java's type erasure for generics, a golang slice instance does not have type information * about the elements found in the array blob (nor the size of the blob). - *

      */ @StructureMapping(structureName = "runtime.slice") public class GoSlice implements StructureMarkup { @@ -269,7 +268,7 @@ public class GoSlice implements StructureMarkup { /** * Treats this slice as a array of unsigned integers, of the specified intSize. - *

      + * * @param intSize size of integer * @return array of longs, containing the (possibly smaller) integers contained in the slice * @throws IOException if error reading diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/GoString.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/GoString.java index a142e77831..909daae075 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/GoString.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/GoString.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. @@ -33,7 +33,7 @@ public class GoString implements StructureMarkup { /** * Creates a artificial gostring instance that was not read from a memory location. - *

      + * * @param goBinary {@link GoRttiMapper} * @param stringData location of char array * @param len length of char array diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/types/GoBaseType.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/types/GoBaseType.java index a0d68d17b4..b015f8898a 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/types/GoBaseType.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/types/GoBaseType.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,7 +30,6 @@ import ghidra.app.util.bin.format.golang.structmapping.*; *

      * Additionally, there can be an {@link GoUncommonType} structure immediately after this type, if * the uncommon bit is set in tflag. - *

      *

        * struct specialized_type { basetype_struct; (various_fields)* } struct uncommon; 
        * 
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/structmapping/FieldReadFunction.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/structmapping/FieldReadFunction.java index bff836ed02..6dc366077a 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/structmapping/FieldReadFunction.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/structmapping/FieldReadFunction.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. @@ -19,7 +19,7 @@ import java.io.IOException; /** * Functional interface to read a structure field's value. - *

      + * * @see #get(FieldContext) * * @param type of structure mapped class that contains this field diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/macho/prelink/NoPreLinkSectionException.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/macho/prelink/NoPreLinkSectionException.java index c964e8b5e4..a5dc3f34da 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/macho/prelink/NoPreLinkSectionException.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/macho/prelink/NoPreLinkSectionException.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. @@ -17,9 +17,7 @@ package ghidra.app.util.bin.format.macho.prelink; public class NoPreLinkSectionException extends Exception { - /** - * - */ + private static final long serialVersionUID = 1L; public NoPreLinkSectionException( String message ) { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/omf/OmfRecord.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/omf/OmfRecord.java index 1eb7fc45d1..b580e291ce 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/omf/OmfRecord.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/omf/OmfRecord.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,9 +36,6 @@ public abstract class OmfRecord implements StructConverter { protected BinaryReader dataReader; protected long dataEnd; - /** - * - */ public OmfRecord() { // nothing to do } diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/BoundImportDescriptor.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/BoundImportDescriptor.java index 61aebf94d9..a305aa45d4 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/BoundImportDescriptor.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/BoundImportDescriptor.java @@ -29,7 +29,6 @@ import ghidra.util.exception.DuplicateNameException; * A class to represent the * IMAGE_BOUND_IMPORT_DESCRIPTOR * data structure defined in winnt.h. - *

      *

        * typedef struct _IMAGE_BOUND_IMPORT_DESCRIPTOR {
        *     DWORD   TimeDateStamp;
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/BoundImportForwarderRef.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/BoundImportForwarderRef.java
      index 6fb1a93870..68d0794ae0 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/BoundImportForwarderRef.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/BoundImportForwarderRef.java
      @@ -27,7 +27,6 @@ import ghidra.util.exception.DuplicateNameException;
        * A class to represent the 
        * IMAGE_BOUND_FORWARDER_REF
        * data structure defined in winnt.h.
      - * 

      *

        * typedef struct _IMAGE_BOUND_FORWARDER_REF {
        *     DWORD   TimeDateStamp;
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/DelayImportDescriptor.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/DelayImportDescriptor.java
      index 166a4f8b9e..24c957fdcc 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/DelayImportDescriptor.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/DelayImportDescriptor.java
      @@ -29,7 +29,6 @@ import ghidra.util.exception.DuplicateNameException;
        * A class to represent the 
        * ImgDelayDescr
        * data structure defined in DELAYIMP.H.
      - * 

      *

        * typedef struct ImgDelayDescr {
        *     DWORD           grAttrs;        // attributes
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/ImageCor20Header.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/ImageCor20Header.java
      index a46ecdf3be..e4a269ec41 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/ImageCor20Header.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/ImageCor20Header.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.
      @@ -32,6 +32,7 @@ import ghidra.util.exception.DuplicateNameException;
       import ghidra.util.task.TaskMonitor;
       
       /**
      + * 
        * typedef struct IMAGE_COR20_HEADER
        * {
        *     // Header versioning
      @@ -61,7 +62,6 @@ import ghidra.util.task.TaskMonitor;
        *
        *};
        *
      - * */ public class ImageCor20Header implements StructConverter, PeMarkupable { private static final String NAME = "IMAGE_COR20_HEADER"; diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/MachineName.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/MachineName.java index 85f03163b3..7d4ad82c1c 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/MachineName.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/MachineName.java @@ -15,9 +15,6 @@ */ package ghidra.app.util.bin.format.pe; -/** - * - */ class MachineName { static String getName(short machine) { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/SecurityCertificate.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/SecurityCertificate.java index d16131dc8a..0243874287 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/SecurityCertificate.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/SecurityCertificate.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,7 +28,6 @@ import ghidra.util.exception.DuplicateNameException; * struct as defined in winbase.h. *

      * This structure encapsulates a signature used in verifying executables. - *

      *

        * typedef struct _WIN_CERTIFICATE {
        *     DWORD       dwLength;
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/DebugSymbolSelector.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/DebugSymbolSelector.java
      index 16f55e4161..0e2c730588 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/DebugSymbolSelector.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/DebugSymbolSelector.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.
      @@ -19,9 +19,6 @@ import java.io.IOException;
       
       import ghidra.app.util.bin.BinaryReader;
       
      -/**
      - * 
      - */
       public class DebugSymbolSelector {
       
       	public static DebugSymbol selectSymbol(BinaryReader reader, int ptr) throws IOException {
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_BLOCK32.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_BLOCK32.java
      index a8a3144d4c..fcd96b3a0d 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_BLOCK32.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_BLOCK32.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.
      @@ -15,9 +15,6 @@
        */
       package ghidra.app.util.bin.format.pe.debug;
       
      -/**
      - * 
      - */
       class S_BLOCK32 extends DebugSymbol {
       
       	S_BLOCK32(short length, short type) {
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_COMPILE.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_COMPILE.java
      index ce2622e20d..c42ec80ebf 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_COMPILE.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_COMPILE.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.
      @@ -15,9 +15,6 @@
        */
       package ghidra.app.util.bin.format.pe.debug;
       
      -/**
      - * 
      - */
       class S_COMPILE extends DebugSymbol {
       
       	S_COMPILE(short length, short type) {
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_CONSTANT32.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_CONSTANT32.java
      index 78258b93a4..2f6cb6c50d 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_CONSTANT32.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_CONSTANT32.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.
      @@ -19,11 +19,7 @@ import java.io.IOException;
       
       import ghidra.app.util.bin.BinaryReader;
       import ghidra.util.Conv;
      -import ghidra.util.Msg;
       
      -/**
      - * 
      - */
       class S_CONSTANT32 extends DebugSymbol {
       
       	S_CONSTANT32(short length, short type, BinaryReader reader, int ptr) throws IOException {
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_END.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_END.java
      index 3b1b08f7ad..de164722b4 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_END.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_END.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,9 +18,6 @@ package ghidra.app.util.bin.format.pe.debug;
       import ghidra.app.util.bin.BinaryReader;
       import ghidra.util.Msg;
       
      -/**
      - * 
      - */
       class S_END extends DebugSymbol {
       
       	S_END(short length, short type, BinaryReader reader, int ptr) {
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_GDATA32_NEW.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_GDATA32_NEW.java
      index a0ef07661f..06bf3dbd94 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_GDATA32_NEW.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_GDATA32_NEW.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.
      @@ -21,9 +21,6 @@ import ghidra.app.util.bin.BinaryReader;
       import ghidra.util.Conv;
       import ghidra.util.Msg;
       
      -/**
      - * 
      - */
       class S_GDATA32_NEW extends DebugSymbol {
       
       	S_GDATA32_NEW(short length, short type, BinaryReader reader, int ptr) throws IOException {
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_LABEL32.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_LABEL32.java
      index b030615ebc..c7b96a7f26 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_LABEL32.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_LABEL32.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.
      @@ -21,9 +21,6 @@ import ghidra.app.util.bin.BinaryReader;
       import ghidra.util.Conv;
       import ghidra.util.Msg;
       
      -/**
      - * 
      - */
       class S_LABEL32 extends DebugSymbol {
           private byte flags;
       	
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_LDATA32_NEW.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_LDATA32_NEW.java
      index b867be762c..5c0f8c01dd 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_LDATA32_NEW.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_LDATA32_NEW.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.
      @@ -20,9 +20,6 @@ import java.io.IOException;
       import ghidra.app.util.bin.BinaryReader;
       import ghidra.util.Conv;
       
      -/**
      - * 
      - */
       class S_LDATA32_NEW extends DebugSymbol{
           private int reserved;
       	private byte [] padding;
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_OBJNAME.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_OBJNAME.java
      index 0df63159bb..4065bbf545 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_OBJNAME.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_OBJNAME.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.
      @@ -20,9 +20,6 @@ import java.io.IOException;
       import ghidra.app.util.bin.BinaryReader;
       import ghidra.util.Conv;
       
      -/**
      - * 
      - */
       class S_OBJNAME extends DebugSymbol {
           private int signature;
       	private byte nameLen;
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_UDT32.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_UDT32.java
      index 7778397853..6ad17f0220 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_UDT32.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_UDT32.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.
      @@ -20,9 +20,6 @@ import java.io.IOException;
       import ghidra.app.util.bin.BinaryReader;
       import ghidra.util.Conv;
       
      -/**
      - * 
      - */
       class S_UDT32 extends DebugSymbol {
           private int checksum;
       	private byte typeLen;
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_UDT32_NEW.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_UDT32_NEW.java
      index 3f70ba38a0..c84c74c5d8 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_UDT32_NEW.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/S_UDT32_NEW.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.
      @@ -20,9 +20,6 @@ import java.io.IOException;
       import ghidra.app.util.bin.BinaryReader;
       import ghidra.util.Conv;
       
      -/**
      - * 
      - */
       class S_UDT32_NEW extends DebugSymbol {
           private int symType;
       
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/UnknownSymbol.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/UnknownSymbol.java
      index ffa08cda94..37b0f74330 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/UnknownSymbol.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/UnknownSymbol.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.
      @@ -21,9 +21,6 @@ import ghidra.app.util.bin.BinaryReader;
       import ghidra.util.Conv;
       import ghidra.util.Msg;
       
      -/**
      - * 
      -*/
       class UnknownSymbol extends DebugSymbol{
           private byte [] unknown;
       
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/cparser/CPP/DefineTable.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/cparser/CPP/DefineTable.java
      index 42c173d0d7..9e5399afda 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/cparser/CPP/DefineTable.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/cparser/CPP/DefineTable.java
      @@ -23,9 +23,6 @@ import ghidra.app.util.cparser.CPP.PreProcessor.PPToken;
       import ghidra.program.model.data.*;
       import ghidra.util.Msg;
       
      -/**
      - * 
      - */
       public class DefineTable {
       	private static final String VARARG_ELLIPSIS = "...";
       
      @@ -44,9 +41,6 @@ public class DefineTable {
       
       	private final static String VALUE = "value";
       
      -	/**
      -	 * 
      -	 */
       	public DefineTable() {
       		super();
       		// TODO Auto-generated constructor stub
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI0DataType.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI0DataType.java
      index d0f1511ba7..3a0316caaf 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI0DataType.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI0DataType.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,7 +30,6 @@ import ghidra.util.Msg;
        * The RTTI0 data type represents a TypeDescriptor structure.
        * 

      * Fields for this RunTimeTypeInformation structure can be found on http://www.openrce.org - *

      *

        * struct TypeDescriptor {
        *     Pointer vfTablePointer;
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI1DataType.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI1DataType.java
      index 77dbe15740..ad1c72cd42 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI1DataType.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI1DataType.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,6 @@ import ghidra.program.model.mem.*;
        * The RTTI1 data type represents a BaseClassDescriptor structure.
        * 

      * Fields for this RunTimeTypeInformation structure can be found on http://www.openrce.org - *

      *

        * struct BaseClassDescriptor {
        *     4byte_ptr_or_disp pTypeDescriptor; // ref to TypeDescriptor (RTTI 0) for class
      @@ -38,7 +37,6 @@ import ghidra.program.model.mem.*;
        *     dword attributes;                  // bit flags
        * }
        * 
      - *

      *

        * struct pmd {
        *     int mdisp; // member displacement
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI3DataType.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI3DataType.java
      index aeedb87866..ebe18ff40c 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI3DataType.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI3DataType.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,7 +30,6 @@ import ghidra.util.Msg;
        * The RTTI3 data type represents a ClassHierarchyDescriptor structure.
        * 

      * Fields for this RunTimeTypeInformation structure can be found on http://www.openrce.org - *

      *

        * struct ClassHierarchyDescriptor {
        *     dword signature;
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI4DataType.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI4DataType.java
      index bddb5ff294..88714332fd 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI4DataType.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI4DataType.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,6 @@ import ghidra.program.model.mem.Memory;
        * The RTTI4 data type represents a CompleteObjectLocator structure.
        * 

      * Fields for this RunTimeTypeInformation structure can be found on http://www.openrce.org - *

      *

        * struct CompleteObjectLocator {
        *     dword signature;
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/Demangled.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/Demangled.java
      index f006adb4c3..504025ad3d 100644
      --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/Demangled.java
      +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/Demangled.java
      @@ -22,7 +22,7 @@ package ghidra.app.util.demangler;
        * future date.  Below is a listing of known uses:
        * 
        * 		
      - * 			
      + * 			
        * 		
        * 		
        * 			
      MethodDescriptionMethodDescription
      diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/dialog/CheckoutDialog.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/dialog/CheckoutDialog.java index b0090b7d50..405da14425 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/dialog/CheckoutDialog.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/dialog/CheckoutDialog.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. @@ -31,9 +31,6 @@ import ghidra.framework.remote.User; import ghidra.util.HelpLocation; import ghidra.util.Swing; -/** - * - */ public class CheckoutDialog extends DialogComponentProvider { public static final int CHECKOUT = 0; diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/AbstractLibrarySupportLoader.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/AbstractLibrarySupportLoader.java index 259ab2bed2..c6f31fc3a4 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/AbstractLibrarySupportLoader.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/AbstractLibrarySupportLoader.java @@ -658,7 +658,7 @@ public abstract class AbstractLibrarySupportLoader extends AbstractProgramLoader *

      * If the library path has a path and it wasn't found under the given folder, the * filename part of library path will be used to search the given folder for matches. - *

      + * * @param libraryPath path with filename of the library to find * @param folder {@link DomainFolder} within which imported libraries will be searched. * If null this method will return null. @@ -715,7 +715,7 @@ public abstract class AbstractLibrarySupportLoader extends AbstractProgramLoader *

      * If the library specifies an absolute path, its native path is searched on the local * filesystem. - *

      + * * @param libraryPath The library {@link Path}. This will be either an absolute path, a * relative path, or just a filename. * @param fsSearchPaths A {@link List} of {@link FileSystemSearchPath}s that will be searched diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/AbstractProgramLoader.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/AbstractProgramLoader.java index 28e214b98a..39cdd7a9a7 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/AbstractProgramLoader.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/AbstractProgramLoader.java @@ -344,7 +344,6 @@ public abstract class AbstractProgramLoader implements Loader { /** * Sets a program's Executable Path, Executable Format, MD5, SHA256, and FSRL properties. - *

      * * @param prog {@link Program} (with active transaction) * @param provider {@link ByteProvider} that the program was created from diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/xml/FunctionsXmlMgr.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/xml/FunctionsXmlMgr.java index d64ec1df3d..c1dc17aebb 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/xml/FunctionsXmlMgr.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/xml/FunctionsXmlMgr.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. @@ -74,7 +74,7 @@ class FunctionsXmlMgr { *

      
       	 * <!ELEMENT FUNCTION (RETURN_TYPE?, ADDRESS_RANGE*, REGULAR_CMT?, REPEATABLE_CMT?, TYPEINFO_CMT?, STACK_FRAME?, REGISTER_VAR*)>
       	 * 
      - *

      + * * @param parser the parser * @param overwriteConflicts true to overwrite any conflicts * @param ignoreStackFrames true to ignore stack frames diff --git a/Ghidra/Features/Base/src/main/java/ghidra/features/base/codecompare/model/FunctionComparisonModel.java b/Ghidra/Features/Base/src/main/java/ghidra/features/base/codecompare/model/FunctionComparisonModel.java index 61778c2ced..575e16b80e 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/features/base/codecompare/model/FunctionComparisonModel.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/features/base/codecompare/model/FunctionComparisonModel.java @@ -13,9 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -/** - * - */ + package ghidra.features.base.codecompare.model; import java.util.Collection; diff --git a/Ghidra/Features/Base/src/main/java/ghidra/features/base/codecompare/model/MatchedFunctionComparisonModel.java b/Ghidra/Features/Base/src/main/java/ghidra/features/base/codecompare/model/MatchedFunctionComparisonModel.java index ddd9d9325e..c5d9091e92 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/features/base/codecompare/model/MatchedFunctionComparisonModel.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/features/base/codecompare/model/MatchedFunctionComparisonModel.java @@ -4,18 +4,16 @@ * 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. * See the License for the specific language governing permissions and * limitations under the License. */ -/** - * - */ + package ghidra.features.base.codecompare.model; import static ghidra.util.datastruct.Duo.Side.*; diff --git a/Ghidra/Features/Base/src/main/java/ghidra/features/base/memsearch/mnemonic/MaskGenerator.java b/Ghidra/Features/Base/src/main/java/ghidra/features/base/memsearch/mnemonic/MaskGenerator.java index 334b765eb4..07e1ebcc2f 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/features/base/memsearch/mnemonic/MaskGenerator.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/features/base/memsearch/mnemonic/MaskGenerator.java @@ -24,9 +24,6 @@ import ghidra.program.model.listing.*; import ghidra.program.util.ProgramSelection; import ghidra.util.Msg; -/** - * - */ class MaskGenerator { /** @@ -45,9 +42,6 @@ class MaskGenerator { */ private List> ops = new ArrayList<>(); - /** - * - */ private SLMaskControl maskControl; /** @@ -297,9 +291,6 @@ class MaskGenerator { return combineInstructionMasks(masks, values, totalLength); } - /** - * - */ private class MnemonicMaskValue extends MaskValue { /** @@ -313,9 +304,6 @@ class MaskGenerator { } } - /** - * - */ private class OperandMaskValue extends MaskValue { private boolean constant = false; diff --git a/Ghidra/Features/Base/src/main/java/ghidra/features/base/memsearch/mnemonic/MaskValue.java b/Ghidra/Features/Base/src/main/java/ghidra/features/base/memsearch/mnemonic/MaskValue.java index f92693a349..529372d1d8 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/features/base/memsearch/mnemonic/MaskValue.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/features/base/memsearch/mnemonic/MaskValue.java @@ -50,9 +50,6 @@ class MaskValue { this.textRepresentation = textRepresentation; } - /** - * - */ @Override public String toString() { String rep = textRepresentation == null ? "" : textRepresentation; diff --git a/Ghidra/Features/Base/src/main/java/ghidra/features/base/values/GhidraValuesMap.java b/Ghidra/Features/Base/src/main/java/ghidra/features/base/values/GhidraValuesMap.java index a536e03ba1..2416f9424b 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/features/base/values/GhidraValuesMap.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/features/base/values/GhidraValuesMap.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. @@ -204,7 +204,7 @@ public class GhidraValuesMap extends GValuesMap { * while some object is using it, the object itself is typically passed in as * the consumer. For example, when used in a script, passing in the java keyword "this" as the * consumer will make the script itself the consumer. - *

      + * * @param name the name of a previously defined program value * @param consumer the consumer to be used to open the program * @param tool if non-null, the program will also be opened in the given tool. Note: the diff --git a/Ghidra/Features/Base/src/main/java/ghidra/features/base/values/ProgramFileValue.java b/Ghidra/Features/Base/src/main/java/ghidra/features/base/values/ProgramFileValue.java index f5fb158461..462c61aaf9 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/features/base/values/ProgramFileValue.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/features/base/values/ProgramFileValue.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. @@ -88,7 +88,7 @@ public class ProgramFileValue extends ProjectFileValue { * while some object is using it, the object itself is typically passed in as * the consumer. For example, when used in a script, passing in the java keyword "this" as the * consumer will make the script itself the consumer. - *

      + * * @param consumer the consumer to be used to open the program * @param tool optional tool that if non-null, the program will also be opened in the tool * @param upgradeIfNeeded if true, program will be upgraded if needed and possible. If false, diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/AbstractFileExtractorTask.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/AbstractFileExtractorTask.java index 3b23ee8b0b..d4f13d29f1 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/AbstractFileExtractorTask.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/AbstractFileExtractorTask.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,7 +26,6 @@ import utilities.util.FileUtilities; /** * Common base class for tasks that need to extract files from a GFileSystem location. - *

      * */ public abstract class AbstractFileExtractorTask extends Task { @@ -216,7 +215,7 @@ public abstract class AbstractFileExtractorTask extends Task { /** * Return the number of files that were exported. - *

      + * * @return the number of files that were exported */ public int getTotalFilesExportedCount() { @@ -225,7 +224,7 @@ public abstract class AbstractFileExtractorTask extends Task { /** * Return the number of directories that were exported. - *

      + * * @return the number of directories that were exported */ public int getTotalDirsExportedCount() { @@ -234,7 +233,7 @@ public abstract class AbstractFileExtractorTask extends Task { /** * Return the number of bytes that were exported. - *

      + * * @return the number of bytes that were exported */ public long getTotalBytesExportedCount() { 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 f0d9fbc18d..f0252216bc 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 @@ -59,7 +59,6 @@ import ghidra.util.SystemUtilities; * FSRL's can be created from strings using {@link #fromString(String)}. *

      * FSRLs that have a MD5 value are {@link FileSystemService#getFullyQualifiedFSRL(FSRL, ghidra.util.task.TaskMonitor) "fully qualified"}. - *

      */ public class FSRL { public static final String PARAM_MD5 = "MD5"; @@ -100,7 +99,7 @@ public class FSRL { * are not intern()'d so will not be shared with other FSRL instances. *

      * See {@link #fromPartString(FSRL, String)} for details of character encoding fixups. - *

      + * * @param fsrlStr something like "fstype://path/path|fs2type://path2/path2|etc://etc/etc" * @return new {@link FSRL} instance, never null * @throws MalformedURLException if empty string or bad format @@ -113,7 +112,7 @@ public class FSRL { * Creates a {@link FSRL} from a raw string. *

      * See {@link #fromPartString(FSRL, String)} for details of character encoding fixups. - *

      + * * @param parent Parent {@link FSRL} * @param fsrlStr something like "fstype://path/path|fs2type://path2/path2|etc://etc/etc" * @return new {@link FSRL} instance, never null @@ -297,7 +296,7 @@ public class FSRL { * Returns the name portion of the FSRL part at parent depth {@code nestedDepth}, where 0 * is ourself (equiv to just calling {@link #getName()}, 1 is the parent * container's name, etc. - *

      + * * @param nestedDepth relative parent index of FSRL part to query, 0 == this instance. * @return name portion of the path of the specified FSRL part. * @throws IOException if nestedDepth is larger than number of FSRL parent parts. @@ -320,7 +319,7 @@ public class FSRL { * Returns the MD5 string associated with this file. *

      * NULL if no MD5 value present. - *

      + * * @return md5 string associated with this file object, or null if not present. */ public String getMD5() { @@ -357,7 +356,7 @@ public class FSRL { * but with a new path. *

      * See also {@link #appendPath(String)}. - *

      + * * @param newpath string path * @return new {@link FSRL} instance with the specified path. */ @@ -381,7 +380,7 @@ public class FSRL { /** * Creates a new {@link FSRL} instance, using the same {@link FSRLRoot} as this instance, * combining the current {@link #getPath() path} with the {@code relPath} value. - *

      + * * @param relPath relative path string to append, '/'s will be automatically added * @return new {@link FSRL} instance with additional path appended. */ @@ -481,7 +480,7 @@ public class FSRL { * "file://path"
      * "file://path|subfs://blah"
      * "file://path|subfs://blah|subfs2://blah2" - *

      + * * @return {@link List} of {@link FSRL} elements pointing to each level of this FSRL. */ public List split() { @@ -547,7 +546,7 @@ public class FSRL { /** * Returns {@code true} if this object is a child or descendant of the * specified {@code potentialParent} parameter. - *

      + * * @param potentialParent {@link FSRL} to test against * @return boolean true if the specified {@link FSRL} is a parent (ignoring md5 hashes) * of this instance. 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 0c604d53be..81a05ee6fb 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 @@ -23,7 +23,6 @@ package ghidra.formats.gfilesystem; * A FSRLRoot's parent is always a FSRL (ie. the container the filesystem data is in), or null. *

      * Examples of relationship between FSRL and FSRLRoots: - *

      *

        *
      • FSRLRoot [ file:// ]
        * "file://"
      • @@ -84,7 +83,7 @@ public class FSRLRoot extends FSRL { /** * Private constructor used by static factory methods. - *

        + * * @param parent {@link FSRL} parent * @param protocol string filesystem type. */ @@ -101,7 +100,7 @@ public class FSRLRoot extends FSRL { /** * Returns the "protocol" portion of this FSRLRoot, for example, in a FSRLRoot of * "file://", this method would return "file". - *

        + * * @return string protocol / filesystem type. */ public String getProtocol() { @@ -111,7 +110,7 @@ public class FSRLRoot extends FSRL { /** * Returns the parent containerfile FSRL, or null if this FSRLRoot specifies * a root-level filesystem. - *

        + * * @return {@link FSRL} of the container object that this filesystem is nested under. */ public FSRL getContainer() { @@ -152,7 +151,7 @@ public class FSRLRoot extends FSRL { /** * Creates a new {@link FSRL} as a child of this {@link FSRLRoot}, using the supplied * path and MD5 values. - *

        + * * @param newPath string path and filename of the object inside this filesystem, should * not be null. * @param newMD5 string md5 of the object inside this filesystem, null ok. diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSUtilities.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSUtilities.java index 6d42b0bb27..065b7c4566 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSUtilities.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSUtilities.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. @@ -135,7 +135,6 @@ public class FSUtilities { /** * Returns a decoded version of the input stream where "%nn" escape sequences are * replaced with their actual characters, using UTF-8 decoding rules. - *

        * * @param s string with escape sequences in the form "%nn", or null. * @return string with all escape sequences replaced with native characters, or null if @@ -281,7 +280,7 @@ public class FSUtilities { * Displays a filesystem related {@link Throwable exception} in the most user-friendly manner * possible, even if we have to do some hacky things with helping the user with * crypto problems. - *

        + * * @param originator * a Logger instance, "this", or YourClass.class * @param parent @@ -474,7 +473,7 @@ public class FSUtilities { *

        * Handles forward or back slashes as path separator characters in the input, but * only adds forward slashes when separating the path strings that need a separator. - *

        + * * @param paths vararg list of path strings, empty or null elements are ok and are skipped. * @return null if all params null, "" empty string if all are empty, or * "path_element[1]/path_element[2]/.../path_element[N]" otherwise. diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileCache.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileCache.java index 470b4ca07c..adf205dad8 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileCache.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileCache.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. @@ -15,12 +15,11 @@ */ package ghidra.formats.gfilesystem; -import java.util.*; -import java.util.regex.Pattern; - import java.io.*; import java.nio.file.*; import java.security.NoSuchAlgorithmException; +import java.util.*; +import java.util.regex.Pattern; import org.apache.commons.collections4.map.ReferenceMap; @@ -90,7 +89,7 @@ public class FileCache { /** * Creates a new {@link FileCache} instance where files are stored under the specified * {@code cacheDir} - *

        + * * @param cacheDir where to store the files * @throws IOException if there was a problem creating subdirectories under cacheDir or * when pruning expired files. @@ -176,7 +175,7 @@ public class FileCache { /** * Get a file (by md5) from the cache, returns NULL if not found. - *

        + * * @param md5 file md5 string. * @return File or null if not found. */ @@ -211,7 +210,7 @@ public class FileCache { /** * Adds a plaintext file to this cache, consuming it. - *

        + * * @param file plaintext file * @param monitor {@link TaskMonitor} * @return a {@link FileCacheEntry} that controls the contents of the newly added file @@ -243,7 +242,7 @@ public class FileCache { * process may remove a nested directory after it has been created. * 2) The source file is co-located with the cache directory to ensure its on the * same physical filesystem volume, and is already obfuscated. - *

        + * * @param tmpFile the File to add to the cache * @param md5 hex string md5 of the file * @return a new {@link FileCacheEntry} with the File's location and its md5 @@ -409,7 +408,6 @@ public class FileCache { /** * Allows creating {@link FileCacheEntry file cache entries} at the caller's convenience. - *

        */ public class FileCacheEntryBuilder extends OutputStream { @@ -491,7 +489,7 @@ public class FileCache { /** * Finalizes this builder, pushing the bytes that have been written to it into * the FileCache. - *

        + * * @return new {@link FileCacheEntry} * @throws IOException if error */ @@ -544,7 +542,7 @@ public class FileCache { /** * Returns the contents of this cache entry as a {@link ByteProvider}, using the specified * {@link FSRL}. - *

        + * * @param fsrl {@link FSRL} that the returned {@link ByteProvider} should have as its * identity * @return new {@link ByteProvider} containing the contents of this cache entry, caller is diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemIndexHelper.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemIndexHelper.java index 400b4ae544..3354e38dc7 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemIndexHelper.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemIndexHelper.java @@ -28,7 +28,7 @@ import ghidra.util.Msg; *

        * This class also provides filename 'unique-ifying' (per directory) where an auto-incrementing * number will be added to a file's filename if it is not unique in the directory. - *

        + * * @param the filesystem specific native file object that the user of this * class wants to be able to correlate with Ghidra {@link GFile} instances. */ @@ -63,7 +63,7 @@ public class FileSystemIndexHelper { * Creates a new {@link FileSystemIndexHelper} for the specified {@link GFileSystem}. *

        * A "root" directory GFile will be auto-created for the filesystem. - *

        + * * @param fs the {@link GFileSystem} that this index will be for. * @param fsFSRL the {@link FSRLRoot fsrl} of the filesystem itself. * (this parameter is explicitly passed here so there is no possibility of trying to call @@ -283,7 +283,6 @@ public class FileSystemIndexHelper { * Filenames that are not unique in their directory will have a "[nnn]" * suffix added to the resultant GFile name, where nnn is the file's * order of occurrence in the container file. - *

        * * @param path string path and filename of the file being added to the index. Back * slashes are normalized to forward slashes @@ -318,7 +317,6 @@ public class FileSystemIndexHelper { * Filenames that are not unique in their directory will have a "[nnn]" * suffix added to the resultant GFile name, where nnn is the file's * order of occurrence in the container file. - *

        * * @param filename the new file's name * @param parent the new file's parent directory @@ -346,7 +344,6 @@ public class FileSystemIndexHelper { * Filenames that are not unique in their directory will have a "[nnn]" * suffix added to the resultant GFile name, where nnn is the file's * order of occurrence in the container file. - *

        * * @param path string path and filename of the file being added to the index. Back * slashes are normalized to forward slashes @@ -384,7 +381,6 @@ public class FileSystemIndexHelper { * Filenames that are not unique in their directory will have a "[nnn]" * suffix added to the resultant GFile name, where nnn is the file's * order of occurrence in the container file. - *

        * * @param filename the new file's name * @param parent the new file's parent directory @@ -476,7 +472,7 @@ public class FileSystemIndexHelper { * Superfluous slashes in the original filename (ie. name/sub//subafter_extra_slash) will * be represented as empty string elements in the nameparts array and will be skipped * as if they were not there. - *

        + * * @param nameparts String[] containing the elements of a path * for them * @param nameComp optional comparator that will compare names, usually case-sensitive vs case @@ -527,7 +523,6 @@ public class FileSystemIndexHelper { /** * Creates a new GFile instance, using per-filesystem custom logic. - *

        * * @param parentFile the parent file of the new instance. Never null. * @param name the name of the file diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemInstanceManager.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemInstanceManager.java index c922b4ab66..eed9b30f51 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemInstanceManager.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemInstanceManager.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. @@ -89,7 +89,7 @@ class FileSystemInstanceManager implements FileSystemEventListener { /** * Returns a list of mounted file systems. - *

        + * * @return {@link List} of {@link FSRLRoot} of filesystems that are currently mounted. */ public synchronized List getMountedFilesystems() { @@ -141,7 +141,6 @@ class FileSystemInstanceManager implements FileSystemEventListener { /** * Returns true if there is a filesystem in the cache that has a containerFSRL that * is {@link FSRL#isEquivalent(FSRL) equiv} to the specified FSRL. - *

        * * @param containerFSRL {@link FSRL} location to query for currently mounted filesystem. * @return true if there is a filesystem mounted using that containerFSRL. diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemProbeConflictResolver.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemProbeConflictResolver.java index b40712e5fd..2355f0a4b1 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemProbeConflictResolver.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemProbeConflictResolver.java @@ -23,13 +23,12 @@ import ghidra.formats.gfilesystem.factory.FileSystemInfoRec; /** * A callback interface used to choose which filesystem implementation to use when * multiple filesystem types indicate that they can open a container file. - *

        */ public interface FileSystemProbeConflictResolver { /** * Picks a single {@link FileSystemInfoRec} to use when mounting a filesystem. - *

        + * * @param factories a {@link List} of {@link FileSystemInfoRec}s. * @return the chosen FSIR, or null */ @@ -49,7 +48,7 @@ public interface FileSystemProbeConflictResolver { * This method should be provided by the actual strategy implementation. *

        * This method will only be called if the list contains more than a single item. - *

        + * * @param factories {@link List} of {@link FileSystemInfoRec}, always more than 1 element. * @return the chosen FSIR, or null */ @@ -68,7 +67,6 @@ public interface FileSystemProbeConflictResolver { /** * Conflict handler that allows the user to pick the filesystem to use from a GUI list. - *

        */ public static FileSystemProbeConflictResolver GUI_PICKER = new FileSystemProbeConflictResolver() { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemRef.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemRef.java index 2e30ff844c..0e84bd0e42 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemRef.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemRef.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. @@ -15,10 +15,10 @@ */ package ghidra.formats.gfilesystem; -import ghidra.util.Msg; - import java.io.Closeable; +import ghidra.util.Msg; + /** * A handle to a {@link GFileSystem} which allows tracking the current users of the filesystem. *

        @@ -67,7 +67,7 @@ public class FileSystemRef implements Closeable { /** * Returns true if this ref was {@link #close() closed}. - *

        + * * @return boolean true if this ref was closed. */ public boolean isClosed() { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemRefManager.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemRefManager.java index e8ef6a311d..a80ddf1fc7 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemRefManager.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemRefManager.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. @@ -24,7 +24,6 @@ import ghidra.util.datastruct.ListenerSet; /** * A threadsafe helper class that manages creating and releasing {@link FileSystemRef} instances * and broadcasting events to {@link FileSystemEventListener} listeners. - *

        */ public class FileSystemRefManager { private GFileSystem fs; @@ -70,7 +69,6 @@ public class FileSystemRefManager { /** * Creates a new {@link FileSystemRef} that points at the owning {@link GFileSystem filesystem}. - *

        * * @return new {@link FileSystemRef} pointing at the filesystem, never null. */ @@ -95,7 +93,7 @@ public class FileSystemRefManager { * Releases an existing {@link FileSystemRef} and broadcasts * {@link FileSystemEventListener#onFilesystemRefChange(GFileSystem, FileSystemRefManager)} * to listeners. - *

        + * * @param ref the {@link FileSystemRef} to release. */ public void release(FileSystemRef ref) { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemService.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemService.java index f5e4f6c428..70e57e07e7 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemService.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemService.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. @@ -52,7 +52,6 @@ import ghidra.util.timer.GTimer; * {@link ObfuscatedFileByteProvider}. *

        * Thread-safe. - *

        */ public class FileSystemService { @@ -81,7 +80,6 @@ public class FileSystemService { * and will be closed by the caller. *

        * Example: - *

        *

        fsService.getDerivedByteProvider(
         	 *     containerFSRL, 
         	 *     null,
        @@ -100,7 +98,7 @@ public class FileSystemService {
         		 * 

        * The implementation needs to return an {@link InputStream} that contains the bytes * of the derived file. - *

        + * * @return a new {@link InputStream} that will produce all the bytes of the derived file * @throws IOException if there is a problem while producing the InputStream * @throws CancelledException if the user canceled @@ -115,7 +113,6 @@ public class FileSystemService { * The implementation needs to write bytes to the supplied {@link OutputStream}. *

        * Example: - *

        *

        fsService.getDerivedByteProviderPush(
         	 *     containerFSRL, 
         	 *     null,
        @@ -131,7 +128,7 @@ public class FileSystemService {
         		/**
         		 * Callback method intended to be implemented by the caller to
         		 * {@link FileSystemService#getDerivedByteProviderPush(FSRL, FSRL, String, long, DerivedStreamPushProducer, TaskMonitor) getDerivedByteProviderPush()}
        -		 * 

        + * * @param os {@link OutputStream} that the implementor should write the bytes to. Do * not close the stream when done * @throws IOException if there is a problem while writing to the OutputStream @@ -294,7 +291,7 @@ public class FileSystemService { * Never returns NULL, instead throws IOException if there is a problem. *

        * The caller is responsible for releasing the {@link FileSystemRef}. - *

        + * * @param fsFSRL {@link FSRLRoot} of file system you want a reference to. * @param monitor {@link TaskMonitor} to allow the user to cancel. * @return a new {@link FileSystemRef} that the caller is responsible for closing when @@ -394,7 +391,7 @@ public class FileSystemService { * If the file was not present in the cache, the {@link DerivedStreamProducer producer} * will be called and it will be responsible for returning an {@link InputStream} * which has the derived contents, which will be added to the file cache for next time. - *

        + * * @param containerFSRL {@link FSRL} w/hash of the source (or container) file that this * derived file is based on * @param derivedFSRL (optional) {@link FSRL} to assign to the resulting ByteProvider @@ -450,7 +447,7 @@ public class FileSystemService { * If the file was not present in the cache, the {@link DerivedStreamPushProducer pusher} * will be called and it will be responsible for producing and writing the derived * file's bytes to a {@link OutputStream}, which will be added to the file cache for next time. - *

        + * * @param containerFSRL {@link FSRL} w/hash of the source (or container) file that this * derived file is based on * @param derivedFSRL (optional) {@link FSRL} to assign to the resulting ByteProvider @@ -509,7 +506,7 @@ public class FileSystemService { * Temporary files that are written to disk are obfuscated to avoid interference from * overzealous virus scanners. See {@link ObfuscatedInputStream} / * {@link ObfuscatedOutputStream}. - *

        + * * @param sizeHint the expected size of the file, or -1 if unknown * @return {@link FileCacheEntryBuilder} that must be finalized by calling * {@link FileCacheEntryBuilder#finish() finish()} @@ -642,7 +639,7 @@ public class FileSystemService { /** * Returns true if the container file probably holds one of the currently supported * filesystem types. - *

        + * * @param containerFSRL {@link FSRL} of the file being queried. * @param monitor {@link TaskMonitor} to watch and update progress. * @return boolean true if the file probably is a container, false otherwise. @@ -771,7 +768,7 @@ public class FileSystemService { *

        * The caller is responsible for closing the resultant file system instance when it is * no longer needed. - *

        + * * @param containerFSRL a reference to the file that contains the file system image * @param fsClass the GFileSystem derived class that implements the specific file system * @param monitor {@link TaskMonitor} to allow the user to cancel @@ -808,7 +805,7 @@ public class FileSystemService { *

        * The caller is responsible for closing the resultant file system instance when it is * no longer needed. - *

        + * * @param containerFSRL a reference to the file that contains the file system image * @param monitor {@link TaskMonitor} to allow the user to cancel * @return new {@link GFileSystem} instance, caller is responsible for closing() when done. @@ -831,7 +828,7 @@ public class FileSystemService { /** * Returns a cloned copy of the {@code FSRL} that should have MD5 values specified. * (excluding GFile objects that don't have data streams) - *

        + * * @param fsrl {@link FSRL} of the file that should be forced to have a MD5 * @param monitor {@link TaskMonitor} to watch and update with progress. * @return possibly new {@link FSRL} instance with a MD5 value. @@ -915,7 +912,7 @@ public class FileSystemService { *

        * As a FSRL is returned, there is no guarantee that the filesystem will still be * mounted when you later use values from the list. - *

        + * * @return {@link List} of {@link FSRLRoot} of currently mounted filesystems. */ public List getMountedFilesystems() { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFile.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFile.java index 6f5717e3fd..c2b3d7e0a1 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFile.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFile.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,7 +23,6 @@ import java.util.List; *

        * Only valid while the {@link #getFilesystem() owning filesystem} object is still open and not * {@link GFileSystem#close() closed}. - *

        */ public interface GFile { @@ -63,7 +62,7 @@ public interface GFile { /** * Returns true if this is a directory. - *

        + * * @return boolean true if this file is a directory, false otherwise. */ boolean isDirectory(); @@ -77,7 +76,7 @@ public interface GFile { /** * Returns a listing of files in this sub-directory. - *

        + * * @return {@link List} of {@link GFile} instances. * @throws IOException if not a directory or error when accessing files. */ diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileImpl.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileImpl.java index 0fbcc2ae22..f2a8f7cb64 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileImpl.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileImpl.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,7 +38,6 @@ public class GFileImpl implements GFile { * to create GFile instances if you can supply the parent value as that will * allow reuse of the parent objects instead of duplicates of them being created * for each file with the same parent path. - *

        * * @param fileSystem the {@link GFileSystem} that owns this file * @param path forward slash '/' separated path and filename string. @@ -63,7 +62,6 @@ public class GFileImpl implements GFile { * to create GFile instances if you can supply the parent value as that will * allow reuse of the parent objects instead of duplicates of them being created * for each file with the same parent path. - *

        * * @param fileSystem the {@link GFileSystem} that owns this file * @param parent the parent of the new GFile or null if child-of-root. @@ -114,7 +112,7 @@ public class GFileImpl implements GFile { * and as a child of the specified parent. *

        * The filename is accepted without checking or validation. - *

        + * * @param fileSystem the {@link GFileSystem} that owns this file * @param parent the parent of the new GFile or null if child-of-root. * @param filename the file's name, not used if FSRL param specified. @@ -134,7 +132,7 @@ public class GFileImpl implements GFile { /** * Creates a GFile for a filesystem using the information in a FSRL as the file's name * and as a child of the specified parent. - *

        + * * @param fileSystem the {@link GFileSystem} that owns this file * @param parent the parent of the new GFile or null if child-of-root. * @param fsrl {@link FSRL} to assign to the file. @@ -157,7 +155,6 @@ public class GFileImpl implements GFile { * Protected constructor, use static helper methods to create new instances. *

        * Creates a new GFile instance without any name parsing. - *

        * * @param fileSystem the {@link GFileSystem} that owns this file * @param parentFile the parent of the new GFile or null if child-of-root. diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileSystem.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileSystem.java index f43e42e193..07976776b7 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileSystem.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileSystem.java @@ -106,7 +106,7 @@ public interface GFileSystem extends Closeable, ExtensionPoint { /** * Returns the {@link FileSystemRefManager ref manager} that is responsible for * creating and releasing {@link FileSystemRef refs} to this filesystem. - *

        + * * @return {@link FileSystemRefManager} that manages references to this filesystem. */ FileSystemRefManager getRefManager(); @@ -123,7 +123,7 @@ public interface GFileSystem extends Closeable, ExtensionPoint { /** * Retrieves a {@link GFile} from this filesystem based on its full path and filename, using * this filesystem's default name comparison logic (eg. case sensitive vs insensitive). - *

        + * * @param path string path and filename of a file located in this filesystem. Use * {@code null} or "/" to retrieve the root directory * @return {@link GFile} instance of requested file, null if not found. @@ -134,7 +134,7 @@ public interface GFileSystem extends Closeable, ExtensionPoint { /** * Retrieves a {@link GFile} from this filesystem based on its full path and filename, using * the specified name comparison logic (eg. case sensitive vs insensitive). - *

        + * * @param path string path and filename of a file located in this filesystem. Use * {@code null} or "/" to retrieve the root directory * @param nameComp string comparator used to compare filenames. Use {@code null} to specify @@ -171,7 +171,7 @@ public interface GFileSystem extends Closeable, ExtensionPoint { * Returns an {@link InputStream} that contains the contents of the specified {@link GFile}. *

        * The caller is responsible for closing the stream. - *

        + * * @param file {@link GFile} to get an InputStream for * @param monitor {@link TaskMonitor} to watch and update progress * @return new {@link InputStream} contains the contents of the file or NULL if the @@ -202,7 +202,7 @@ public interface GFileSystem extends Closeable, ExtensionPoint { /** * Returns a list of {@link GFile files} that reside in the specified directory on * this filesystem. - *

        + * * @param directory NULL means root of filesystem. * @return {@link List} of {@link GFile} instances of file in the requested directory. * @throws IOException if IO problem. @@ -239,7 +239,6 @@ public interface GFileSystem extends Closeable, ExtensionPoint { /** * Default implementation of getting an {@link InputStream} from a {@link GFile}'s * {@link ByteProvider}. - *

        * * @param file {@link GFile} * @param fs the {@link GFileSystem filesystem} containing the file diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileSystemBase.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileSystemBase.java index 31490818f0..27f59e75a1 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileSystemBase.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileSystemBase.java @@ -44,7 +44,6 @@ import ghidra.util.task.TaskMonitor; * The {@link ByteProvider} given to the constructor is not considered 'owned' by * the GFileSystemBase instance until after it passes the {@link #isValid(TaskMonitor) isValid} * check and is {@link #open(TaskMonitor) opened}. - *

        * */ public abstract class GFileSystemBase implements GFileSystem { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/SingleFileSystemIndexHelper.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/SingleFileSystemIndexHelper.java index 875f4edac4..0ed070e284 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/SingleFileSystemIndexHelper.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/SingleFileSystemIndexHelper.java @@ -32,7 +32,7 @@ public class SingleFileSystemIndexHelper { * Creates a new instance. * * A "root" directory GFile will be auto-created for the filesystem. - *

        + * * @param fs the {@link GFileSystem} that this index will be for. * @param fsFSRL the {@link FSRLRoot fsrl} of the filesystem itself. * (this parameter is explicitly passed here so there is no possibility of trying to call diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/annotations/FileSystemInfo.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/annotations/FileSystemInfo.java index 19a2af6294..a4b80acb43 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/annotations/FileSystemInfo.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/annotations/FileSystemInfo.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. @@ -15,14 +15,13 @@ */ package ghidra.formats.gfilesystem.annotations; +import java.lang.annotation.*; + import ghidra.formats.gfilesystem.GFileSystem; import ghidra.formats.gfilesystem.factory.GFileSystemFactory; -import java.lang.annotation.*; - /** * Specifies the info needed of a {@link GFileSystem} implementation. - *

        *

          *
        • {@link #type()} is required.
        • *
        • {@link #description()} is optional.
        • @@ -41,7 +40,7 @@ public @interface FileSystemInfo { /** * A longer description of this filesystem. - *

          + * * @return Free form description string, defaults to empty string if not set. */ String description() default ""; @@ -58,7 +57,7 @@ public @interface FileSystemInfo { * The relative priority of filesystems during probing. *

          * Higher numeric values are considered before lower values. - *

          + * * @return integer that specifies the relative ordering of filesystems during * probing. */ diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/crypto/CmdLinePasswordProvider.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/crypto/CmdLinePasswordProvider.java index cf34ed6ff1..cc18242a9d 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/crypto/CmdLinePasswordProvider.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/crypto/CmdLinePasswordProvider.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,7 +38,6 @@ import utilities.util.FileUtilities; * Example file contents, where each line is divided into fields by a tab * character where the first field is the password and the second optional field * is the file's identifying information (name, path, etc): - *

          *

            * password1   [tab]   myfirstzipfile.zip ← supplies a password for the named file located in any directory
            * someOtherPassword   [tab]   /full/path/tozipfile.zip ← supplies password for file at specified location 
          diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/FileSystemFactoryMgr.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/FileSystemFactoryMgr.java
          index b82fb6aec4..1be252969a 100644
          --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/FileSystemFactoryMgr.java
          +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/FileSystemFactoryMgr.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.
          @@ -33,13 +33,11 @@ import ghidra.util.task.TaskMonitor;
            * 

          * Auto-discovers all {@link GFileSystem} instances in the classpath that have a * {@link FileSystemInfo} annotation. - *

          */ public class FileSystemFactoryMgr { /** - *

          - * @return The single global {@link FileSystemFactoryMgr} instance. + * {@return The single global {@link FileSystemFactoryMgr} instance.} */ public static FileSystemFactoryMgr getInstance() { return Singleton.instance; @@ -135,7 +133,6 @@ public class FileSystemFactoryMgr { /** * Creates a new {@link GFileSystem} instance when the filesystem type is already * known, consuming the specified ByteProvider. - *

          * * @param fsType filesystem type string, ie. "file", "zip". * @param byteProvider {@link ByteProvider}, will be owned by the new file system @@ -192,7 +189,7 @@ public class FileSystemFactoryMgr { /** * Returns true if the specified file contains a supported {@link GFileSystem}. - *

          + * * @param byteProvider * @param fsService reference to the {@link FileSystemService} instance. * @param monitor {@link TaskMonitor} to use for canceling and updating progress. @@ -234,7 +231,6 @@ public class FileSystemFactoryMgr { /** * Probes the specified file for a supported {@link GFileSystem} implementation, and * if found, creates a new filesystem instance. - *

          * * @param byteProvider container {@link ByteProvider}, will be owned by the new filesystem * @param fsService reference to the {@link FileSystemService} instance. @@ -258,7 +254,7 @@ public class FileSystemFactoryMgr { * Probes the specified file for a supported {@link GFileSystem} implementation, and * if found, creates a new filesystem instance. The ByteProvider is owned by the new * file system. - *

          + * * @param byteProvider container {@link ByteProvider}, will be owned by the new filesystem * @param fsService reference to the {@link FileSystemService} instance. * @param conflictResolver {@link FileSystemProbeConflictResolver conflict resolver} to diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/FileSystemInfoRec.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/FileSystemInfoRec.java index ecdd41761f..8e7fc3674d 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/FileSystemInfoRec.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/FileSystemInfoRec.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. @@ -15,19 +15,18 @@ */ package ghidra.formats.gfilesystem.factory; -import ghidra.formats.gfilesystem.GFileSystem; -import ghidra.formats.gfilesystem.GFileSystemBase; -import ghidra.formats.gfilesystem.annotations.FileSystemInfo; -import ghidra.util.Msg; - import java.lang.reflect.Constructor; import java.lang.reflect.InvocationTargetException; import java.util.Comparator; import java.util.regex.Pattern; +import ghidra.formats.gfilesystem.GFileSystem; +import ghidra.formats.gfilesystem.GFileSystemBase; +import ghidra.formats.gfilesystem.annotations.FileSystemInfo; +import ghidra.util.Msg; + /** * Holds information read from a {@link FileSystemInfo} annotation. - *

          */ public class FileSystemInfoRec { private static final Pattern FSTYPE_VALID_REGEX = Pattern.compile("[a-z0-9]+"); diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/GFileSystemFactory.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/GFileSystemFactory.java index 1d484ec945..e1a5e3cca0 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/GFileSystemFactory.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/GFileSystemFactory.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. @@ -19,7 +19,7 @@ import ghidra.formats.gfilesystem.GFileSystem; /** * An empty interface that is a common type for the real factory interfaces to derive from. - *

          + * * @param {@link GFileSystem} derived type */ public interface GFileSystemFactory { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/GFileSystemFactoryByteProvider.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/GFileSystemFactoryByteProvider.java index 4eb4d5b0c6..ed49113c5a 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/GFileSystemFactoryByteProvider.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/GFileSystemFactoryByteProvider.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. @@ -25,7 +25,7 @@ import ghidra.util.task.TaskMonitor; /** * A {@link GFileSystemFactory} interface for filesystem implementations * that use a {@link ByteProvider}. - *

          + * * @param */ public interface GFileSystemFactoryByteProvider @@ -33,7 +33,7 @@ public interface GFileSystemFactoryByteProvider /** * Constructs a new {@link GFileSystem} instance that handles the specified file. - *

          + * * @param targetFSRL the {@link FSRLRoot} of the filesystem being created. * @param byteProvider a {@link ByteProvider} containing the contents of the file being probed. * This method is responsible for closing this byte provider instance. diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/GFileSystemProbeBytesOnly.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/GFileSystemProbeBytesOnly.java index 29cee98452..b719ab67df 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/GFileSystemProbeBytesOnly.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/GFileSystemProbeBytesOnly.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,7 +34,7 @@ public interface GFileSystemProbeBytesOnly extends GFileSystemProbe { /** * The minimum number of bytes needed to be supplied to the * {@link #probeStartBytes(FSRL, byte[])} method. - *

          + * * @return min number of bytes needed for probe */ public int getBytesRequired(); diff --git a/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/JavaFileListHandler.java b/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/JavaFileListHandler.java index 3ed03d4254..8ff42780bc 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/JavaFileListHandler.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/JavaFileListHandler.java @@ -4,18 +4,16 @@ * 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. * See the License for the specific language governing permissions and * limitations under the License. */ -/** - * - */ + package ghidra.framework.main.datatree; import java.awt.datatransfer.DataFlavor; diff --git a/Ghidra/Features/Base/src/main/java/ghidra/plugins/importer/batch/BatchImportDialog.java b/Ghidra/Features/Base/src/main/java/ghidra/plugins/importer/batch/BatchImportDialog.java index 13c0882a17..3783078c76 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/plugins/importer/batch/BatchImportDialog.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/plugins/importer/batch/BatchImportDialog.java @@ -65,7 +65,7 @@ public class BatchImportDialog extends DialogComponentProvider { *

          * The dialog will chain to the {@link ImportBatchTask} when the user clicks the * OK button. - *

          + * * @param tool {@link PluginTool} that will be the parent of the dialog * @param batchInfo optional {@link BatchInfo} instance with already discovered applications, or null. * @param initialFiles optional {@link List} of {@link FSRL files} to add to the batch import dialog, or null. diff --git a/Ghidra/Features/Base/src/main/java/ghidra/plugins/importer/batch/BatchInfo.java b/Ghidra/Features/Base/src/main/java/ghidra/plugins/importer/batch/BatchInfo.java index 4c9c5693a5..d6f57ebd37 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/plugins/importer/batch/BatchInfo.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/plugins/importer/batch/BatchInfo.java @@ -174,7 +174,7 @@ public class BatchInfo { *

          * If the file is a container for other files, this method will iterate through those * child files and recursively try to add them using this method. - *

          + * * @param fsrl {@link FSRL} of the file to add. * @param taskMonitor {@link TaskMonitor} to watch and update with progress. * @return boolean true if something in the file produced something to import. @@ -207,7 +207,7 @@ public class BatchInfo { *

          * The file is probed for high-priority filesystems first, then if no matches, * Ghidra loaders, and then if no matches, all filesystems. - *

          + * * @param fsrl {@link FSRL} of the file to probe and process * @param taskMonitor {@link TaskMonitor} to watch and update. * @return boolean true if something in the file produced something to import. @@ -421,7 +421,7 @@ public class BatchInfo { *

          * Doing this requires rescanning all original user-added source files and stopping * at the new max depth. - *

          + * * @param newMaxDepth new value for the max depth */ public void setMaxDepth(int newMaxDepth) { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/plugins/importer/tasks/ImportBatchTask.java b/Ghidra/Features/Base/src/main/java/ghidra/plugins/importer/tasks/ImportBatchTask.java index fe25eb50dc..581d579e4b 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/plugins/importer/tasks/ImportBatchTask.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/plugins/importer/tasks/ImportBatchTask.java @@ -62,7 +62,7 @@ public class ImportBatchTask extends Task { /** * Start a Batch Import session with an already populated {@link BatchInfo} * instance. - *

          + * * @param batchInfo {@link BatchInfo} state object * @param destFolder {@link DomainFolder} where to place imported files * @param programManager {@link ProgramManager} to use when opening newly imported files, null ok diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/database/ProgramBuilder.java b/Ghidra/Features/Base/src/main/java/ghidra/program/database/ProgramBuilder.java index 0fa47221f4..7c50ee6037 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/program/database/ProgramBuilder.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/program/database/ProgramBuilder.java @@ -338,7 +338,7 @@ public class ProgramBuilder { * Sets the bytes starting at {@code address} to the values encoded in {@code byteString}. *

          * See {@link #setBytes(String, byte[], boolean)}. - *

          + * * @param address String containing numeric value, preferably hex encoded: "0x1004000" * @param byteString String containing 2 digit hex values, separated by ' ' space chars * or by comma ',' chars: "12 05 ff". See {@link NumericUtilities#parseHexLong(String)}. @@ -354,7 +354,7 @@ public class ProgramBuilder { * and then optionally disassembling. *

          * See {@link #setBytes(String, byte[], boolean)}. - *

          + * * @param address String containing numeric value, preferably hex encoded: "0x1004000" * @param byteString String containing 2 digit hex values, separated by ' ' space chars * or by comma ',' chars: "12 05 ff". See {@link NumericUtilities#parseHexLong(String)}. @@ -373,7 +373,7 @@ public class ProgramBuilder { /** * Sets the bytes starting at {@code stringAddress} to the byte values in {@code bytes} * and then optionally disassembling. - *

          + * * @param stringAddress String containing numeric value, preferably hex encoded: "0x1004000" * @param bytes array of bytes to copy into the memory buffer at the addresss. * @param disassemble boolean flag. See {@link #disassemble(String, int)} diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/flatapi/FlatProgramAPI.java b/Ghidra/Features/Base/src/main/java/ghidra/program/flatapi/FlatProgramAPI.java index dfbb1b3916..c0c6688b8b 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/program/flatapi/FlatProgramAPI.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/program/flatapi/FlatProgramAPI.java @@ -71,7 +71,6 @@ import ghidra.util.task.TaskMonitor; * This class is used by GhidraScript. *

          * Changing this class will break user scripts. - *

          */ public class FlatProgramAPI { public static final int MAX_REFERENCES_TO = 0x1000; @@ -2563,7 +2562,7 @@ public class FlatProgramAPI { *

          * If a program already exists with the specified name, then a time stamp will be appended * to the name to make it unique. - *

          + * * @param program the program to save * @param path list of string path elements (starting at the root of the project) that specify * the project folder to save the program info. Example: { "folder1", "subfolder2", diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/util/MemoryDiff.java b/Ghidra/Features/Base/src/main/java/ghidra/program/util/MemoryDiff.java index 8fab4d6b42..3b7c32b7a1 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/program/util/MemoryDiff.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/program/util/MemoryDiff.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. @@ -146,7 +146,7 @@ public class MemoryDiff { /** * Gets the index of the address range containing the indicated address, * if it is contained in the list; - * otherwise, (-(insertion point) - 1). + * otherwise, {@code (-(insertion point) - 1)}. * @param address the address whose range we are interested in finding. * @return the index of the address range. */ diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramDiff.java b/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramDiff.java index e9c4513920..7dd60b7b7b 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramDiff.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramDiff.java @@ -20,6 +20,7 @@ import java.util.*; import javax.help.UnsupportedOperationException; import org.apache.commons.collections4.CollectionUtils; + import ghidra.program.database.properties.UnsupportedMapDB; import ghidra.program.database.sourcemap.SourceFile; import ghidra.program.model.address.*; @@ -46,7 +47,7 @@ import ghidra.util.task.TaskMonitor; * equivalent address spaces. If the programs have different program context * registers, the Diff can still occur but will not determine program context * differences. - *

          + * * @see ghidra.program.util.ProgramDiffFilter */ diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMerge.java b/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMerge.java index 561b898382..dd414c77df 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMerge.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMerge.java @@ -988,9 +988,6 @@ public class ProgramMerge { dupEquates.put(dupEquate.getName(), new DupEquate(dupEquate, desiredName)); } - /** - * - */ void reApplyDuplicateEquates() { for (String conflictName : dupEquates.keySet()) { DupEquate dupEquate = dupEquates.get(conflictName); @@ -1021,9 +1018,6 @@ public class ProgramMerge { } } - /** - * - */ String getDuplicateEquatesInfo() { StringBuffer buf = new StringBuffer(); for (String conflictName : dupEquates.keySet()) { @@ -1037,9 +1031,6 @@ public class ProgramMerge { return buf.toString(); } - /** - * - */ void clearDuplicateEquates() { dupEquates.clear(); } @@ -1922,9 +1913,6 @@ public class ProgramMerge { mergeLabels(originAddressSet, ProgramMergeFilter.REPLACE, true, replaceFunction, monitor); } - /** - * - */ void reApplyDuplicateSymbols() { SymbolTable originSymTab = originProgram.getSymbolTable(); SymbolTable resultSymTab = resultProgram.getSymbolTable(); @@ -1955,9 +1943,6 @@ public class ProgramMerge { } } - /** - * - */ String getDuplicateSymbolsInfo() { StringBuffer buf = new StringBuffer(); SymbolTable origSymTab = originProgram.getSymbolTable(); @@ -1989,9 +1974,6 @@ public class ProgramMerge { return buf.toString(); } - /** - * - */ void clearDuplicateSymbols() { conflictSymbolIDMap.removeAll(); // dupSyms.clear(); diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/util/string/AbstractStringSearcher.java b/Ghidra/Features/Base/src/main/java/ghidra/program/util/string/AbstractStringSearcher.java index 42494c762f..58a80e4578 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/program/util/string/AbstractStringSearcher.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/program/util/string/AbstractStringSearcher.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. @@ -95,7 +95,7 @@ public abstract class AbstractStringSearcher { *

        • if the given set is null, it will be re-initialized to encompass all of program memory
        • *
        • the set will be further culled to only include loaded memory blocks, if specified
        • *
        - *

        + * * @param addressSet the address set to search over; if null, will initialized to all memory * @param callback the callback invoked when a string is found * @param searchLoadedMemoryBlocksOnly if true, will exclude unloaded memory blocks from the search diff --git a/Ghidra/Features/Base/src/main/java/ghidra/util/bytesearch/DittedBitSequence.java b/Ghidra/Features/Base/src/main/java/ghidra/util/bytesearch/DittedBitSequence.java index bc85483788..8ade3fdec4 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/util/bytesearch/DittedBitSequence.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/util/bytesearch/DittedBitSequence.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. @@ -329,12 +329,12 @@ public class DittedBitSequence { /** * restore ditted string from XML stream with hex/binary ditted sequences in the form: - * 0x..d.4de2 ....0000 .1...... 00101101 11101001 + * {@code 0x..d.4de2 ....0000 .1...... 00101101 11101001 } * where 0x starts a hex number and '.' is a don't care nibble (hex) or bit (binary) * * @param parser XML pull parser stream * - * @return number of bytes read from XML tag + * @return number of bytes read from XML {@code } tag * * @throws IOException if XML read has an error */ diff --git a/Ghidra/Features/Base/src/main/java/ghidra/util/table/GhidraTable.java b/Ghidra/Features/Base/src/main/java/ghidra/util/table/GhidraTable.java index 75838fb184..d394031f5b 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/util/table/GhidraTable.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/util/table/GhidraTable.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. @@ -42,7 +42,6 @@ import ghidra.util.Msg; * selection navigation is enabled, then this table will navigate any time the selection of * the table changes. To prevent this feature call * {@link #setNavigateOnSelectionEnabled(boolean)} with a value of false. - *

        */ public class GhidraTable extends GTable { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/util/xml/XmlTestHelper.java b/Ghidra/Features/Base/src/main/java/ghidra/util/xml/XmlTestHelper.java index b5616f41af..a9b97ddbee 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/util/xml/XmlTestHelper.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/util/xml/XmlTestHelper.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. @@ -162,9 +162,6 @@ public class XmlTestHelper { return parser; } - /** - * - */ public void clearXml() { xmlList.clear(); } diff --git a/Ghidra/Features/Base/src/test.slow/java/ghidra/app/cmd/data/CreateDataBackgroundCmdTest.java b/Ghidra/Features/Base/src/test.slow/java/ghidra/app/cmd/data/CreateDataBackgroundCmdTest.java index 4483de40b1..8658a9c141 100644 --- a/Ghidra/Features/Base/src/test.slow/java/ghidra/app/cmd/data/CreateDataBackgroundCmdTest.java +++ b/Ghidra/Features/Base/src/test.slow/java/ghidra/app/cmd/data/CreateDataBackgroundCmdTest.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,6 @@ import ghidra.program.model.listing.*; import ghidra.test.AbstractGhidraHeadedIntegrationTest; import ghidra.test.TestEnv; -/** - * - */ public class CreateDataBackgroundCmdTest extends AbstractGhidraHeadedIntegrationTest { private static final long UNDEFINED_AREA = 0x01001000; diff --git a/Ghidra/Features/Base/src/test.slow/java/ghidra/app/plugin/core/processors/ShowInstructionInfoPluginTest.java b/Ghidra/Features/Base/src/test.slow/java/ghidra/app/plugin/core/processors/ShowInstructionInfoPluginTest.java index b14100ab51..4e046c79f7 100644 --- a/Ghidra/Features/Base/src/test.slow/java/ghidra/app/plugin/core/processors/ShowInstructionInfoPluginTest.java +++ b/Ghidra/Features/Base/src/test.slow/java/ghidra/app/plugin/core/processors/ShowInstructionInfoPluginTest.java @@ -398,9 +398,9 @@ public class ShowInstructionInfoPluginTest extends AbstractGhidraHeadedIntegrati * Tests the addresses of the table models of the "Instruction Info" dialog. * The method will fail the current test if the result is not as * expected by the caller of this method. For example, if - * expectedSame is true, then the method expects the values to + * {@code expectedSame} is true, then the method expects the values to * be the same when compared with the given address and will fail if - * they are not. If expectedSame is false, then the method will + * they are not. If {@code expectedSame} is false, then the method will * fail if the test values are the same. * * @param instructionAddress The address to compare against the address diff --git a/Ghidra/Features/Base/src/test.slow/java/ghidra/app/util/bin/format/dwarf/DWARFConflictHandlerTest.java b/Ghidra/Features/Base/src/test.slow/java/ghidra/app/util/bin/format/dwarf/DWARFConflictHandlerTest.java index e6502c3afb..d8da8051ba 100644 --- a/Ghidra/Features/Base/src/test.slow/java/ghidra/app/util/bin/format/dwarf/DWARFConflictHandlerTest.java +++ b/Ghidra/Features/Base/src/test.slow/java/ghidra/app/util/bin/format/dwarf/DWARFConflictHandlerTest.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. @@ -19,7 +19,6 @@ import static org.junit.Assert.*; import org.junit.*; -import ghidra.app.util.bin.format.dwarf.DWARFDataTypeConflictHandler; import ghidra.program.database.ProgramBuilder; import ghidra.program.database.ProgramDB; import ghidra.program.model.data.*; @@ -99,7 +98,7 @@ public class DWARFConflictHandlerTest extends AbstractGhidraHeadedIntegrationTes * Create a copy of the "addingStruct" before adding it because the impl instance can be * modified during the conflict resolution by the DTM when it tries to DataType.clone() * it before renaming the clone(). - *

        + * * @param existingStruct * @param addingStruct * @param expectedResult diff --git a/Ghidra/Features/Base/src/test.slow/java/ghidra/app/util/bin/format/dwarf/DWARFDataTypeImporterTest.java b/Ghidra/Features/Base/src/test.slow/java/ghidra/app/util/bin/format/dwarf/DWARFDataTypeImporterTest.java index 5c5c21c7b4..5274e79533 100644 --- a/Ghidra/Features/Base/src/test.slow/java/ghidra/app/util/bin/format/dwarf/DWARFDataTypeImporterTest.java +++ b/Ghidra/Features/Base/src/test.slow/java/ghidra/app/util/bin/format/dwarf/DWARFDataTypeImporterTest.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. @@ -197,7 +197,7 @@ public class DWARFDataTypeImporterTest extends DWARFTestBase { /** * Test structure definition when a struct is fwd decl'd in one CU and fully * defined in a second CU. - *

        + * * @throws CancelledException * @throws IOException * @throws DWARFException @@ -649,7 +649,6 @@ public class DWARFDataTypeImporterTest extends DWARFTestBase { * for the structs being placed in the root namespace. *

        * See GDTSD-351 - *

        */ @Test public void testDTMIncorrectOverwrite() { diff --git a/Ghidra/Features/Base/src/test.slow/java/ghidra/framework/data/IndexedFileSystemFolderTest.java b/Ghidra/Features/Base/src/test.slow/java/ghidra/framework/data/IndexedFileSystemFolderTest.java index 6079ba26f3..2fd730bee7 100644 --- a/Ghidra/Features/Base/src/test.slow/java/ghidra/framework/data/IndexedFileSystemFolderTest.java +++ b/Ghidra/Features/Base/src/test.slow/java/ghidra/framework/data/IndexedFileSystemFolderTest.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. @@ -83,7 +83,7 @@ public class IndexedFileSystemFolderTest extends AbstractGhidraHeadedIntegration /** * Tests issue where DomainFolder.getFolder("") returns * a malformed folder that will fail when used later. - *

        + * * @throws Exception */ @Test diff --git a/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/data/ConflictHandlerTest.java b/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/data/ConflictHandlerTest.java index a8d2828fb8..468801f59a 100644 --- a/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/data/ConflictHandlerTest.java +++ b/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/data/ConflictHandlerTest.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. @@ -106,7 +106,7 @@ public class ConflictHandlerTest extends AbstractGhidraHeadedIntegrationTest { * Create a copy of the "addingStruct" before adding it because the impl instance can be * modified during the conflict resolution by the DTM when it tries to DataType.clone() * it before renaming the clone(). - *

        + * * @param existingStruct * @param addingStruct * @param expectedResult diff --git a/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/function/ExternalFunctionDBTest.java b/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/function/ExternalFunctionDBTest.java index a885f65cba..02b4a09329 100644 --- a/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/function/ExternalFunctionDBTest.java +++ b/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/function/ExternalFunctionDBTest.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,9 +30,6 @@ import ghidra.test.AbstractGhidraHeadedIntegrationTest; import ghidra.util.exception.DuplicateNameException; import ghidra.util.exception.InvalidInputException; -/** - * - */ public class ExternalFunctionDBTest extends AbstractGhidraHeadedIntegrationTest { private ProgramDB program; diff --git a/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/function/FunctionDBTest.java b/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/function/FunctionDBTest.java index 98a07fbb89..c7e3595055 100644 --- a/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/function/FunctionDBTest.java +++ b/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/function/FunctionDBTest.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. @@ -45,9 +45,6 @@ import ghidra.test.AbstractGhidraHeadedIntegrationTest; import ghidra.util.exception.InvalidInputException; import ghidra.util.task.TaskMonitor; -/** - * - */ public class FunctionDBTest extends AbstractGhidraHeadedIntegrationTest implements DomainObjectListener { diff --git a/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/function/StackFrameTest.java b/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/function/StackFrameTest.java index 6232b99bfc..fc39e14a56 100644 --- a/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/function/StackFrameTest.java +++ b/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/function/StackFrameTest.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. @@ -15,8 +15,7 @@ */ package ghidra.program.database.function; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertTrue; +import static org.junit.Assert.*; import org.junit.After; import org.junit.Test; @@ -32,9 +31,6 @@ import ghidra.test.AbstractGhidraHeadedIntegrationTest; import ghidra.util.exception.DuplicateNameException; import ghidra.util.exception.InvalidInputException; -/** - * - */ public class StackFrameTest extends AbstractGhidraHeadedIntegrationTest { private ProgramDB program; diff --git a/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/IntPropertyMapDBTest.java b/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/IntPropertyMapDBTest.java index c365f9725d..6b3e5af15d 100644 --- a/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/IntPropertyMapDBTest.java +++ b/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/IntPropertyMapDBTest.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,9 +35,6 @@ import ghidra.test.AbstractGhidraHeadedIntegrationTest; import ghidra.util.exception.NoValueException; import ghidra.util.task.TaskMonitor; -/** - * - */ public class IntPropertyMapDBTest extends AbstractGhidraHeadedIntegrationTest implements ErrorHandler { diff --git a/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/LongPropertyMapDBTest.java b/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/LongPropertyMapDBTest.java index 5be649cd15..a55a51997c 100644 --- a/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/LongPropertyMapDBTest.java +++ b/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/LongPropertyMapDBTest.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,9 +35,6 @@ import ghidra.test.AbstractGhidraHeadedIntegrationTest; import ghidra.util.exception.NoValueException; import ghidra.util.task.TaskMonitor; -/** - * - */ public class LongPropertyMapDBTest extends AbstractGhidraHeadedIntegrationTest implements ErrorHandler { diff --git a/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/ObjectPropertyMapDBTest.java b/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/ObjectPropertyMapDBTest.java index 1f069eb756..55c2fc8416 100644 --- a/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/ObjectPropertyMapDBTest.java +++ b/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/ObjectPropertyMapDBTest.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,9 +34,6 @@ import ghidra.program.model.address.*; import ghidra.test.AbstractGhidraHeadedIntegrationTest; import ghidra.util.task.TaskMonitor; -/** - * - */ public class ObjectPropertyMapDBTest extends AbstractGhidraHeadedIntegrationTest implements ErrorHandler { diff --git a/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/TestSaveable.java b/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/TestSaveable.java index f8e558d38c..12fcb7e152 100644 --- a/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/TestSaveable.java +++ b/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/TestSaveable.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. @@ -20,9 +20,6 @@ import java.util.Arrays; import ghidra.util.ObjectStorage; import ghidra.util.Saveable; -/** - * - */ class TestSaveable implements Saveable { boolean booleanValue; diff --git a/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/VoidPropertyMapDBTest.java b/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/VoidPropertyMapDBTest.java index 0605417b7d..0745b46696 100644 --- a/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/VoidPropertyMapDBTest.java +++ b/Ghidra/Features/Base/src/test.slow/java/ghidra/program/database/properties/VoidPropertyMapDBTest.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. @@ -33,9 +33,6 @@ import ghidra.program.model.address.*; import ghidra.test.AbstractGhidraHeadedIntegrationTest; import ghidra.util.task.TaskMonitor; -/** - * - */ public class VoidPropertyMapDBTest extends AbstractGhidraHeadedIntegrationTest implements ErrorHandler { diff --git a/Ghidra/Features/Base/src/test/java/ghidra/app/GhidraLocationGenerator.java b/Ghidra/Features/Base/src/test/java/ghidra/app/GhidraLocationGenerator.java index 218f99b538..5fea108afe 100644 --- a/Ghidra/Features/Base/src/test/java/ghidra/app/GhidraLocationGenerator.java +++ b/Ghidra/Features/Base/src/test/java/ghidra/app/GhidraLocationGenerator.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. @@ -18,9 +17,6 @@ package ghidra.app; import ghidra.program.util.ProgramLocation; -/** - * - */ public interface GhidraLocationGenerator { void generateLocations(LocationCallback callback); diff --git a/Ghidra/Features/Base/src/test/java/ghidra/app/LocationCallback.java b/Ghidra/Features/Base/src/test/java/ghidra/app/LocationCallback.java index f8b7401f99..44c6675ef4 100644 --- a/Ghidra/Features/Base/src/test/java/ghidra/app/LocationCallback.java +++ b/Ghidra/Features/Base/src/test/java/ghidra/app/LocationCallback.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. @@ -18,9 +17,6 @@ package ghidra.app; import ghidra.program.util.ProgramLocation; -/** - * - */ public interface LocationCallback { void locationGenerated(ProgramLocation loc); diff --git a/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateArrayCmdTest.java b/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateArrayCmdTest.java index c25b49d3b3..b2885de625 100644 --- a/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateArrayCmdTest.java +++ b/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateArrayCmdTest.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,6 @@ import ghidra.program.model.address.AddressSpace; import ghidra.program.model.data.*; import ghidra.program.model.listing.*; -/** - * - */ public class CreateArrayCmdTest extends AbstractGenericTest { private static final long UNDEFINED_AREA = 0x01001000; diff --git a/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateArrayInStructureCmdTest.java b/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateArrayInStructureCmdTest.java index 4939ff3085..290036226b 100644 --- a/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateArrayInStructureCmdTest.java +++ b/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateArrayInStructureCmdTest.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,6 @@ import ghidra.program.model.data.*; import ghidra.program.model.listing.Data; import ghidra.program.model.listing.Program; -/** - * - */ public class CreateArrayInStructureCmdTest extends AbstractGenericTest { private static final long UNDEFINED_AREA = 0x01001000; diff --git a/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateDataCmdTest.java b/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateDataCmdTest.java index dae6d83c97..6de09b0efe 100644 --- a/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateDataCmdTest.java +++ b/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateDataCmdTest.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. @@ -32,9 +32,6 @@ import ghidra.program.model.symbol.SourceType; import ghidra.util.exception.DuplicateNameException; import ghidra.util.exception.InvalidInputException; -/** - * - */ public class CreateDataCmdTest extends AbstractGenericTest { private static final long UNDEFINED_AREA = 0x0150; diff --git a/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateDataInStructureBackgroundCmdTest.java b/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateDataInStructureBackgroundCmdTest.java index 5615d47e89..1cbf0851f6 100644 --- a/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateDataInStructureBackgroundCmdTest.java +++ b/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateDataInStructureBackgroundCmdTest.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,9 +29,6 @@ import ghidra.program.model.data.*; import ghidra.program.model.listing.Data; import ghidra.program.model.listing.Program; -/** - * - */ public class CreateDataInStructureBackgroundCmdTest extends AbstractGenericTest { private static final long UNDEFINED_AREA = 0x0100; diff --git a/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateDataInStructureCmdTest.java b/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateDataInStructureCmdTest.java index 783153015d..fe0ef4000d 100644 --- a/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateDataInStructureCmdTest.java +++ b/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateDataInStructureCmdTest.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,9 +29,6 @@ import ghidra.program.model.data.*; import ghidra.program.model.listing.Data; import ghidra.program.model.listing.Program; -/** - * - */ public class CreateDataInStructureCmdTest extends AbstractGenericTest { private static final long UNDEFINED_AREA = 0x0100; diff --git a/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateStructureCmdTest.java b/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateStructureCmdTest.java index 4ef4922fa1..4a96fa793d 100644 --- a/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateStructureCmdTest.java +++ b/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateStructureCmdTest.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,6 @@ import ghidra.program.model.data.*; import ghidra.program.model.listing.Data; import ghidra.program.model.listing.Program; -/** - * - */ public class CreateStructureCmdTest extends AbstractGenericTest { private static final long UNDEFINED_AREA = 0x01001398; diff --git a/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateStructureInStructureCmdTest.java b/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateStructureInStructureCmdTest.java index b037872880..39d4c500a5 100644 --- a/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateStructureInStructureCmdTest.java +++ b/Ghidra/Features/Base/src/test/java/ghidra/app/cmd/data/CreateStructureInStructureCmdTest.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,9 +27,6 @@ import ghidra.program.model.data.*; import ghidra.program.model.listing.Data; import ghidra.program.model.listing.Program; -/** - * - */ public class CreateStructureInStructureCmdTest extends AbstractGenericTest { private static final long UNDEFINED_AREA = 0x01001398; diff --git a/Ghidra/Features/Base/src/test/java/ghidra/app/util/bin/format/dwarf/DIECreatorTest.java b/Ghidra/Features/Base/src/test/java/ghidra/app/util/bin/format/dwarf/DIECreatorTest.java index f68db68b94..eaf33afb08 100644 --- a/Ghidra/Features/Base/src/test/java/ghidra/app/util/bin/format/dwarf/DIECreatorTest.java +++ b/Ghidra/Features/Base/src/test/java/ghidra/app/util/bin/format/dwarf/DIECreatorTest.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,7 +23,6 @@ import java.io.IOException; import org.junit.Test; -import ghidra.app.util.bin.format.dwarf.*; import ghidra.util.exception.CancelledException; /** @@ -77,7 +76,6 @@ public class DIECreatorTest extends DWARFTestBase { /** * Tests the creation of DIEAggregates when there is a many-to-one layout of * abstractorigin -> spec -> decl links. - *

        *

         	 *                                                   mystruct ao1
         	 *                                                 /
        diff --git a/Ghidra/Features/Base/src/test/java/ghidra/app/util/bin/format/dwarf/expression/DWARFExpressionEvaluatorTest.java b/Ghidra/Features/Base/src/test/java/ghidra/app/util/bin/format/dwarf/expression/DWARFExpressionEvaluatorTest.java
        index f66be2c654..b04c5b60a3 100644
        --- a/Ghidra/Features/Base/src/test/java/ghidra/app/util/bin/format/dwarf/expression/DWARFExpressionEvaluatorTest.java
        +++ b/Ghidra/Features/Base/src/test/java/ghidra/app/util/bin/format/dwarf/expression/DWARFExpressionEvaluatorTest.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.
        @@ -345,7 +345,7 @@ public class DWARFExpressionEvaluatorTest extends DWARFTestBase {
         	/**
         	 * Test to ensure that endless loops or excessive runtime are prevented by
         	 * {@link DWARFExpressionEvaluator#setMaxStepCount(int) maxStepCount}
        -	 * 

        + * * @throws IOException */ @Test(timeout = 10000) @@ -367,7 +367,7 @@ public class DWARFExpressionEvaluatorTest extends DWARFTestBase { /** * Test to ensure that endless loops are ended when the thread is interrupted. - *

        + * * @throws IOException */ @Test(timeout = 10000) diff --git a/Ghidra/Features/Base/src/test/java/ghidra/program/model/data/StructureDataTypeTest.java b/Ghidra/Features/Base/src/test/java/ghidra/program/model/data/StructureDataTypeTest.java index 4273fe014b..edd9f38e03 100644 --- a/Ghidra/Features/Base/src/test/java/ghidra/program/model/data/StructureDataTypeTest.java +++ b/Ghidra/Features/Base/src/test/java/ghidra/program/model/data/StructureDataTypeTest.java @@ -24,9 +24,6 @@ import org.junit.*; import generic.test.AbstractGenericTest; -/** - * - */ public class StructureDataTypeTest extends AbstractGenericTest { private Structure struct; diff --git a/Ghidra/Features/Base/src/test/java/ghidra/program/model/data/UnionDataTypeTest.java b/Ghidra/Features/Base/src/test/java/ghidra/program/model/data/UnionDataTypeTest.java index 96d1848021..306e97e44c 100644 --- a/Ghidra/Features/Base/src/test/java/ghidra/program/model/data/UnionDataTypeTest.java +++ b/Ghidra/Features/Base/src/test/java/ghidra/program/model/data/UnionDataTypeTest.java @@ -23,9 +23,6 @@ import com.google.common.collect.Sets; import generic.test.AbstractGenericTest; -/** - * - */ public class UnionDataTypeTest extends AbstractGenericTest { private Union union; diff --git a/Ghidra/Features/Base/src/test/java/ghidra/util/PropertyFileTest.java b/Ghidra/Features/Base/src/test/java/ghidra/util/PropertyFileTest.java index d294d9d984..6597d69576 100644 --- a/Ghidra/Features/Base/src/test/java/ghidra/util/PropertyFileTest.java +++ b/Ghidra/Features/Base/src/test/java/ghidra/util/PropertyFileTest.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. @@ -15,8 +15,7 @@ */ package ghidra.util; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertTrue; +import static org.junit.Assert.*; import java.io.File; import java.net.URLDecoder; @@ -26,9 +25,6 @@ import org.junit.Test; import generic.test.AbstractGenericTest; -/** - * - */ public class PropertyFileTest extends AbstractGenericTest { private static String NAME = "Test"; diff --git a/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/format/ByteBlockAccessException.java b/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/format/ByteBlockAccessException.java index 125365e76d..4ff14b362c 100644 --- a/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/format/ByteBlockAccessException.java +++ b/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/format/ByteBlockAccessException.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. @@ -25,19 +24,19 @@ import ghidra.util.exception.UsrException; */ public class ByteBlockAccessException extends UsrException { /** - *

        Constructs an ByteBlockAccessException with no detail message.

        - */ + *

        Constructs an ByteBlockAccessException with no detail message. + */ public ByteBlockAccessException() { super(); } /** - *

        Constructs an ByteBlockAccessException with the specified - * detail message.

        - * - * @param message The message. - */ + *

        Constructs an ByteBlockAccessException with the specified + * detail message. + * + * @param message The message. + */ public ByteBlockAccessException(String message) { super(message); } diff --git a/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/format/ByteBlockRange.java b/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/format/ByteBlockRange.java index d1f5909887..3648c490d9 100644 --- a/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/format/ByteBlockRange.java +++ b/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/format/ByteBlockRange.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. @@ -62,7 +61,7 @@ public class ByteBlockRange { /** * Indicates whether some other object is "equal to" this one. *

        - * The equals method for class Object implements + * The {@code equals} method for class Object implements * the most discriminating possible equivalence relation on objects; * that is, for any reference values x and y, * this method returns true if and only if x and @@ -97,7 +96,6 @@ public class ByteBlockRange { * Returns a hash code value for the object. This method is * supported for the benefit of hashtables such as those provided by * java.util.Hashtable. - *

        * * @return a hash code value for this object. */ diff --git a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/margin/LayoutPixelIndexMap.java b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/margin/LayoutPixelIndexMap.java index faac1d4020..b07f7b1a1d 100644 --- a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/margin/LayoutPixelIndexMap.java +++ b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/margin/LayoutPixelIndexMap.java @@ -49,7 +49,7 @@ public interface LayoutPixelIndexMap { * coordinate. In essence, this maps from vertical position, relative to the main panel's * viewport, to layout index. This accounts for scrolling and non-uniform height among the * layouts. - *

        + * * @implNote Clients should avoid frequent calls to this method. Even though it can be * implemented easily in log time, an invocation for every pixel or line of pixels * painted could still be unnecessarily expensive. It should only be necessary to call 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 df62938fec..c7b528c02c 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 @@ -38,7 +38,6 @@ import utility.function.Dummy; *

      • For non-blocking usage, simply call * {@link #process(Iterator, Consumer)}, passing the consumer of the results.
      • *
      - *

      * * @param The input data needed by the supplied {@link QCallback} * @param The result data (can be the same as {@code I} if there is no result) returned @@ -133,7 +132,7 @@ public class DecompilerConcurrentQ { /** * Calls dispose on the queue being processed. Further, the call will block for up to - * timeoutSeconds while waiting for the queue to finish processing. + * {@code timeoutSeconds} while waiting for the queue to finish processing. * * @param timeoutSeconds the number of seconds to wait for the disposed queue to finish * processing diff --git a/Ghidra/Features/DecompilerDependent/src/main/java/ghidra/app/extension/datatype/finder/DecompilerReference.java b/Ghidra/Features/DecompilerDependent/src/main/java/ghidra/app/extension/datatype/finder/DecompilerReference.java index c84f2ea7ef..21649c4d7d 100644 --- a/Ghidra/Features/DecompilerDependent/src/main/java/ghidra/app/extension/datatype/finder/DecompilerReference.java +++ b/Ghidra/Features/DecompilerDependent/src/main/java/ghidra/app/extension/datatype/finder/DecompilerReference.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. @@ -49,7 +49,7 @@ public abstract class DecompilerReference { /** * Scan this reference for any data type matches. *

      - * The fieldName is optional. If not included, then only data type matches will + * The {@code fieldName} is optional. If not included, then only data type matches will * be sought. If it is included, then a match is only included when it is a reference * to the given data type where that type is being accessed by the given field name. * diff --git a/Ghidra/Features/DecompilerDependent/src/main/java/ghidra/app/plugin/core/decompiler/taint/AbstractTaintState.java b/Ghidra/Features/DecompilerDependent/src/main/java/ghidra/app/plugin/core/decompiler/taint/AbstractTaintState.java index 725821c531..e8f8b41f37 100644 --- a/Ghidra/Features/DecompilerDependent/src/main/java/ghidra/app/plugin/core/decompiler/taint/AbstractTaintState.java +++ b/Ghidra/Features/DecompilerDependent/src/main/java/ghidra/app/plugin/core/decompiler/taint/AbstractTaintState.java @@ -166,7 +166,6 @@ public abstract class AbstractTaintState implements TaintState { * The artifacts (e.g., sources) that are used in the datalog query are those * selected by the user via the menu. * - *

      * @param queryTextFile - file containing the query * @return success * @throws Exception - on write diff --git a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/android/xml/AndroidXmlFileSystem.java b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/android/xml/AndroidXmlFileSystem.java index 018c0c12b8..565928f8d5 100644 --- a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/android/xml/AndroidXmlFileSystem.java +++ b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/android/xml/AndroidXmlFileSystem.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. @@ -31,7 +31,6 @@ import ghidra.util.task.TaskMonitor; * This is a {@link GFileSystem} that provides a single file, which is the text version * of a binary android xml file. *

      - * * NOTE: most of this code was hijacked from AXMLPrinter.java class! * */ diff --git a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/gzip/GZipFileSystem.java b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/gzip/GZipFileSystem.java index d515ca331e..55d8f914c8 100644 --- a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/gzip/GZipFileSystem.java +++ b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/gzip/GZipFileSystem.java @@ -39,8 +39,6 @@ import ghidra.util.task.UnknownProgressWrappingTaskMonitor; *

      * If the filename can be recovered from the embedded metadata, it will be used as the * name of the singleton file, otherwise the name "gzip_decompressed" will be used. - *

      - * */ @FileSystemInfo(type = "gzip", description = "GZIP", priority = FileSystemInfo.PRIORITY_LOW, factory = GZipFileSystemFactory.class) public class GZipFileSystem implements GFileSystem { diff --git a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/ios/dmg/DmgClientFileSystemFactory.java b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/ios/dmg/DmgClientFileSystemFactory.java index baacafefe0..2535225a3e 100644 --- a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/ios/dmg/DmgClientFileSystemFactory.java +++ b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/ios/dmg/DmgClientFileSystemFactory.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. @@ -15,10 +15,9 @@ */ package ghidra.file.formats.ios.dmg; -import java.util.Arrays; - import java.io.File; import java.io.IOException; +import java.util.Arrays; import generic.jar.ResourceFile; import ghidra.app.util.bin.ByteProvider; @@ -34,7 +33,6 @@ import ghidra.util.task.TaskMonitor; /** * Handles probing for and creating {@link DmgClientFileSystem} instances. - *

      */ public class DmgClientFileSystemFactory implements GFileSystemFactoryByteProvider, GFileSystemProbeByteProvider { diff --git a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/ios/dmg/DmgDecryptorStream.java b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/ios/dmg/DmgDecryptorStream.java index 6d088c0552..80db50b49e 100644 --- a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/ios/dmg/DmgDecryptorStream.java +++ b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/ios/dmg/DmgDecryptorStream.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. @@ -67,7 +67,7 @@ public class DmgDecryptorStream extends InputStream { * The crypto keys for the DMG file are found by using the name of the container file * this DMG is embedded in (ie. the name of the .ipsw) and the name of this dmg file to * query the {@link CryptoKeyFactory}. - *

      + * * @param containerName Name of the containing .ipsw file * @param dmgName Name of this DMG file * @param provider stream to be wrapped. Will be closed when this stream is closed. diff --git a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/ios/ipsw/IpswFileSystem.java b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/ios/ipsw/IpswFileSystem.java index f0c8aed2b1..a9dc62ba06 100644 --- a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/ios/ipsw/IpswFileSystem.java +++ b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/ios/ipsw/IpswFileSystem.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. @@ -33,7 +33,6 @@ import ghidra.util.task.TaskMonitor; * IPSW is really just a ZIP file. *

      * This implementation is currently unused (isValid always returns false). - *

      */ @FileSystemInfo(type = "ipsw", description = "iOS Firmware (IPSW)", factory = GFileSystemBaseFactory.class) public class IpswFileSystem extends GFileSystemBase { diff --git a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/sevenzip/SevenZipCustomInitializer.java b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/sevenzip/SevenZipCustomInitializer.java index 4effc00bce..793aeaafae 100644 --- a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/sevenzip/SevenZipCustomInitializer.java +++ b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/sevenzip/SevenZipCustomInitializer.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. @@ -15,11 +15,10 @@ */ package ghidra.file.formats.sevenzip; +import java.io.*; import java.util.*; import java.util.stream.Collectors; -import java.io.*; - import ghidra.framework.Application; import net.sf.sevenzipjbinding.SevenZip; import net.sf.sevenzipjbinding.SevenZipNativeInitializationException; @@ -48,7 +47,6 @@ public class SevenZipCustomInitializer { * is okay. *

      * Most likely cause of failure is running on an unsupported platform. - *

      * * @throws SevenZipNativeInitializationException */ diff --git a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/sevenzip/SevenZipFileSystem.java b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/sevenzip/SevenZipFileSystem.java index b14faee9e9..ccb73044a2 100644 --- a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/sevenzip/SevenZipFileSystem.java +++ b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/sevenzip/SevenZipFileSystem.java @@ -340,7 +340,6 @@ public class SevenZipFileSystem extends AbstractFileSystem * 3) lots of write()s, and then 4) setOperationResult(). *

      * This class writes the extracted bytes to the FileCache. - *

      */ private class SZExtractCallback implements IArchiveExtractCallback, ISequentialOutStream, ICryptoGetTextPassword, diff --git a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/sevenzip/SevenZipFileSystemFactory.java b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/sevenzip/SevenZipFileSystemFactory.java index 86b7d7782b..01111d74a9 100644 --- a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/sevenzip/SevenZipFileSystemFactory.java +++ b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/sevenzip/SevenZipFileSystemFactory.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. @@ -15,9 +15,8 @@ */ package ghidra.file.formats.sevenzip; -import java.util.List; - import java.io.IOException; +import java.util.List; import ghidra.app.util.bin.ByteProvider; import ghidra.app.util.recognizer.*; @@ -83,7 +82,6 @@ public class SevenZipFileSystemFactory /** * Returns true if the native libraries for 7zip were initialized. - *

      * * @return boolean true if 7zip dlls/libs/etc were successfully initialized */ diff --git a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/sparseimage/SparseImageDecompressor.java b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/sparseimage/SparseImageDecompressor.java index 356a9c0f95..93a2f2f6dc 100644 --- a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/sparseimage/SparseImageDecompressor.java +++ b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/sparseimage/SparseImageDecompressor.java @@ -114,7 +114,7 @@ public class SparseImageDecompressor { /** * Processes an embedded crc checkvalue, throwing an exception of the current crc * does not match the stored crc. - *

      + * * @throws IOException if crc bad */ private void processCrcChunk() throws IOException { @@ -128,7 +128,7 @@ public class SparseImageDecompressor { /** * Writes a chunk of blocks are are zero filled. - *

      + * * @param blocks number of blocks to write * @param monitor {@link TaskMonitor} to watch * @throws IOException if error writing @@ -154,7 +154,7 @@ public class SparseImageDecompressor { *

      * The values in srcPattern are copied into destArray, repeating from the beginning * of srcPattern as many times as necessary to fill destArray. - *

      + * * @param srcPattern byte array with source pattern * @param destArray byte array destination */ @@ -170,7 +170,7 @@ public class SparseImageDecompressor { /** * Writes a chunk of blocks that are defined by a repeated pattern of 4 bytes. - *

      + * * @param blocks number of blocks to write * @param monitor {@link TaskMonitor} to monitor * @throws IOException if error when writing or reading @@ -200,7 +200,7 @@ public class SparseImageDecompressor { /** * Writes a chunk of blocks are are read from the source file. - *

      + * * @param blocks number of blocks to copy * @param monitor {@link TaskMonitor} to monitor * @throws IOException if error when reading or writing diff --git a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/tar/TarFileSystem.java b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/tar/TarFileSystem.java index 448bfec7a0..79cc942a61 100644 --- a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/tar/TarFileSystem.java +++ b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/tar/TarFileSystem.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,7 +34,6 @@ import ghidra.util.task.TaskMonitor; *

      * The factory supports detecting both compressed (gz) and uncompressed tar files, * and keys both on the tar filename extension as well as the data in the file. - *

      */ @FileSystemInfo(type = "tar", description = "TAR", priority = FileSystemInfo.PRIORITY_HIGH, factory = TarFileSystemFactory.class) public class TarFileSystem extends AbstractFileSystem { diff --git a/Ghidra/Features/FunctionGraph/src/main/java/ghidra/app/plugin/core/functiongraph/graph/layout/flowchart/AbstractFlowChartLayout.java b/Ghidra/Features/FunctionGraph/src/main/java/ghidra/app/plugin/core/functiongraph/graph/layout/flowchart/AbstractFlowChartLayout.java index 176fc6fcf5..9cc92c4d0a 100644 --- a/Ghidra/Features/FunctionGraph/src/main/java/ghidra/app/plugin/core/functiongraph/graph/layout/flowchart/AbstractFlowChartLayout.java +++ b/Ghidra/Features/FunctionGraph/src/main/java/ghidra/app/plugin/core/functiongraph/graph/layout/flowchart/AbstractFlowChartLayout.java @@ -46,7 +46,6 @@ import ghidra.util.exception.CancelledException; * Once the vertices are place in the grid, edge articulations are computed so that edges are * routed orthogonally using an {@link OrthogonalEdgeRouter}. *

      - * * To position the vertices and edges in layout space, it uses an * {@link OrthogonalGridToLayoutMapper} to size the grid and map grid points to layout points. * diff --git a/Ghidra/Features/FunctionGraph/src/main/java/ghidra/app/plugin/core/functiongraph/graph/vertex/ListingGraphComponentPanel.java b/Ghidra/Features/FunctionGraph/src/main/java/ghidra/app/plugin/core/functiongraph/graph/vertex/ListingGraphComponentPanel.java index 3e1988f215..2a3db590de 100644 --- a/Ghidra/Features/FunctionGraph/src/main/java/ghidra/app/plugin/core/functiongraph/graph/vertex/ListingGraphComponentPanel.java +++ b/Ghidra/Features/FunctionGraph/src/main/java/ghidra/app/plugin/core/functiongraph/graph/vertex/ListingGraphComponentPanel.java @@ -4,18 +4,16 @@ * 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. * See the License for the specific language governing permissions and * limitations under the License. */ -/** - * - */ + package ghidra.app.plugin.core.functiongraph.graph.vertex; import java.awt.*; diff --git a/Ghidra/Features/FunctionID/ghidra_scripts/MSLibBatchImportGenerator.java b/Ghidra/Features/FunctionID/ghidra_scripts/MSLibBatchImportGenerator.java index ec16f1a0e8..d80024d311 100644 --- a/Ghidra/Features/FunctionID/ghidra_scripts/MSLibBatchImportGenerator.java +++ b/Ghidra/Features/FunctionID/ghidra_scripts/MSLibBatchImportGenerator.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. @@ -147,7 +147,7 @@ public class MSLibBatchImportGenerator extends GhidraScript { * of the filename. If it ends in 'd', and a base library with the same name minus the * 'd' is in the directory, the library is determined to be a debug library. All others * are standard libraries. - *

      + * * @param standardLibs * @param debugLibs * @param directory @@ -202,7 +202,7 @@ public class MSLibBatchImportGenerator extends GhidraScript { /** * Converts a file's path into forward-slash form. - *

      + * * @param f * @return */ diff --git a/Ghidra/Features/GhidraServer/src/main/java/ghidra/server/security/AuthenticationModule.java b/Ghidra/Features/GhidraServer/src/main/java/ghidra/server/security/AuthenticationModule.java index 1e7a1ba664..7d355fcc56 100644 --- a/Ghidra/Features/GhidraServer/src/main/java/ghidra/server/security/AuthenticationModule.java +++ b/Ghidra/Features/GhidraServer/src/main/java/ghidra/server/security/AuthenticationModule.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,7 +38,7 @@ public interface AuthenticationModule { *

    • The authentication callback array may contain callback instances other than * the ones your module specified in its {@link #getAuthenticationCallbacks()}
    • * - *

      + * * @param userMgr Ghidra server user manager * @param subject unauthenticated user ID (must be used if name callback not provided/allowed) * @param callbacks authentication callbacks @@ -57,7 +57,7 @@ public interface AuthenticationModule { /** * Allows this AuthenticationModule to deny default anonymous login steps. - *

      + * * @return true if a separate AnonymousCallback is allowed and may be * added to the array returned by getAuthenticationCallbacks. * @see #getAuthenticationCallbacks() diff --git a/Ghidra/Features/GhidraServer/src/main/java/ghidra/server/security/JAASAuthenticationModule.java b/Ghidra/Features/GhidraServer/src/main/java/ghidra/server/security/JAASAuthenticationModule.java index 8dfafb8d5f..c23242a811 100644 --- a/Ghidra/Features/GhidraServer/src/main/java/ghidra/server/security/JAASAuthenticationModule.java +++ b/Ghidra/Features/GhidraServer/src/main/java/ghidra/server/security/JAASAuthenticationModule.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,8 +39,6 @@ import ghidra.server.UserManager; * This implementation only supports JAAS LoginModules that use Name and Password callbacks, * and ignores any customization in the name and password callbacks in favor of its own * callbacks. - *

      - * */ public class JAASAuthenticationModule implements AuthenticationModule { diff --git a/Ghidra/Features/GhidraServer/src/main/java/ghidra/server/security/Krb5ActiveDirectoryAuthenticationModule.java b/Ghidra/Features/GhidraServer/src/main/java/ghidra/server/security/Krb5ActiveDirectoryAuthenticationModule.java index 369a2b8a9c..ed1152aa47 100644 --- a/Ghidra/Features/GhidraServer/src/main/java/ghidra/server/security/Krb5ActiveDirectoryAuthenticationModule.java +++ b/Ghidra/Features/GhidraServer/src/main/java/ghidra/server/security/Krb5ActiveDirectoryAuthenticationModule.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. @@ -52,7 +52,6 @@ public class Krb5ActiveDirectoryAuthenticationModule implements AuthenticationMo /** * Creates a new {@link Krb5ActiveDirectoryAuthenticationModule} instance. - *

      * * @param domainName the Active Directory domain name (ie. "yourdomain.tld") * @param allowUserToSpecifyName flag, if true will include a {@link NameCallback} in the diff --git a/Ghidra/Features/GraphFunctionCalls/src/main/java/functioncalls/graph/FcgLevel.java b/Ghidra/Features/GraphFunctionCalls/src/main/java/functioncalls/graph/FcgLevel.java index 72995e69c5..775b9396e0 100644 --- a/Ghidra/Features/GraphFunctionCalls/src/main/java/functioncalls/graph/FcgLevel.java +++ b/Ghidra/Features/GraphFunctionCalls/src/main/java/functioncalls/graph/FcgLevel.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. @@ -15,8 +15,7 @@ */ package functioncalls.graph; -import static functioncalls.graph.FcgDirection.IN_AND_OUT; -import static functioncalls.graph.FcgDirection.OUT; +import static functioncalls.graph.FcgDirection.*; /** * A container class that represents a {@link FunctionCallGraph} level, or row. A level @@ -115,7 +114,7 @@ public class FcgLevel implements Comparable { /** * Returns true if this level is the immediate predecessor of the given other level. * - *

      The source level is the parent of the first level in either direction. + *

      The {@code source} level is the parent of the first level in either direction. * * @param other the other level that is a potential child level * @return true if this level is the immediate predecessor of the given other level diff --git a/Ghidra/Features/GraphFunctionCalls/src/main/java/functioncalls/graph/job/BowTieExpandVerticesJob.java b/Ghidra/Features/GraphFunctionCalls/src/main/java/functioncalls/graph/job/BowTieExpandVerticesJob.java index e322fccc17..2f8397f6ca 100644 --- a/Ghidra/Features/GraphFunctionCalls/src/main/java/functioncalls/graph/job/BowTieExpandVerticesJob.java +++ b/Ghidra/Features/GraphFunctionCalls/src/main/java/functioncalls/graph/job/BowTieExpandVerticesJob.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 ghidra.util.Msg; * done in {@link #arrangeNewVertices()}. * *

      This class is handed a group of edges to processes. In this group there are vertices that - * do not need to be arranged, referred to as the existing vertices. This + * do not need to be arranged, referred to as the {@code existing} vertices. This * classes uses {@link VertexCollection} to find and store the new vertices that need * to be arranged. */ diff --git a/Ghidra/Features/GraphServices/src/main/java/ghidra/graph/visualization/GraphRenderer.java b/Ghidra/Features/GraphServices/src/main/java/ghidra/graph/visualization/GraphRenderer.java index 4c9ae2a441..42eee92673 100644 --- a/Ghidra/Features/GraphServices/src/main/java/ghidra/graph/visualization/GraphRenderer.java +++ b/Ghidra/Features/GraphServices/src/main/java/ghidra/graph/visualization/GraphRenderer.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,7 +34,7 @@ public interface GraphRenderer { * it calls back to this renderer to get the vertex and edge data/functions that it needs * to render a graph. This is how the GraphRender can inject is display style into the graph * display. - *

      + * * @param viewer the {@link VisualizationViewer} */ public void initializeViewer(VisualizationViewer viewer); diff --git a/Ghidra/Features/MicrosoftCodeAnalyzer/src/main/java/ghidra/app/cmd/data/rtti/Rtti1Model.java b/Ghidra/Features/MicrosoftCodeAnalyzer/src/main/java/ghidra/app/cmd/data/rtti/Rtti1Model.java index 17b0c1f8da..81226812d5 100644 --- a/Ghidra/Features/MicrosoftCodeAnalyzer/src/main/java/ghidra/app/cmd/data/rtti/Rtti1Model.java +++ b/Ghidra/Features/MicrosoftCodeAnalyzer/src/main/java/ghidra/app/cmd/data/rtti/Rtti1Model.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,7 +35,6 @@ import ghidra.program.model.mem.*; * BaseClassDescriptor structure. *

      * Fields for this RunTimeTypeInformation structure can be found on http://www.openrce.org - *

      *

        * struct BaseClassDescriptor {
        *     4byte_ptr_or_disp pTypeDescriptor; // ref to TypeDescriptor (RTTI 0) for class
      @@ -45,7 +44,6 @@ import ghidra.program.model.mem.*;
        *     4byte_ptr_or_disp pClassHierarchyDescriptor; // ref to ClassHierarchyDescriptor (RTTI 3) for class
        * }
        * 
      - *

      *

        * struct pmd {
        *     int mdisp; // member displacement
      diff --git a/Ghidra/Features/MicrosoftCodeAnalyzer/src/main/java/ghidra/app/cmd/data/rtti/Rtti3Model.java b/Ghidra/Features/MicrosoftCodeAnalyzer/src/main/java/ghidra/app/cmd/data/rtti/Rtti3Model.java
      index be9b4f8415..a7e25d4345 100644
      --- a/Ghidra/Features/MicrosoftCodeAnalyzer/src/main/java/ghidra/app/cmd/data/rtti/Rtti3Model.java
      +++ b/Ghidra/Features/MicrosoftCodeAnalyzer/src/main/java/ghidra/app/cmd/data/rtti/Rtti3Model.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,7 +35,6 @@ import ghidra.util.Msg;
        * ClassHierarchyDescriptor structure.
        * 

      * Fields for this RunTimeTypeInformation structure can be found on http://www.openrce.org - *

      *

        * struct ClassHierarchyDescriptor {
        *     dword signature;
      diff --git a/Ghidra/Features/MicrosoftCodeAnalyzer/src/main/java/ghidra/app/cmd/data/rtti/Rtti4Model.java b/Ghidra/Features/MicrosoftCodeAnalyzer/src/main/java/ghidra/app/cmd/data/rtti/Rtti4Model.java
      index 29c533e9cc..be38b072d1 100644
      --- a/Ghidra/Features/MicrosoftCodeAnalyzer/src/main/java/ghidra/app/cmd/data/rtti/Rtti4Model.java
      +++ b/Ghidra/Features/MicrosoftCodeAnalyzer/src/main/java/ghidra/app/cmd/data/rtti/Rtti4Model.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.
      @@ -32,7 +32,6 @@ import ghidra.program.model.listing.Program;
        * CompleteObjectLocator structure.
        * 

      * Fields for this RunTimeTypeInformation structure can be found on http://www.openrce.org - *

      *

        * struct CompleteObjectLocator {
        *     dword signature;
      diff --git a/Ghidra/Features/MicrosoftCodeAnalyzer/src/main/java/ghidra/app/cmd/data/rtti/VfTableModel.java b/Ghidra/Features/MicrosoftCodeAnalyzer/src/main/java/ghidra/app/cmd/data/rtti/VfTableModel.java
      index 62b0accf6e..ebf4e0e1b0 100644
      --- a/Ghidra/Features/MicrosoftCodeAnalyzer/src/main/java/ghidra/app/cmd/data/rtti/VfTableModel.java
      +++ b/Ghidra/Features/MicrosoftCodeAnalyzer/src/main/java/ghidra/app/cmd/data/rtti/VfTableModel.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.
      @@ -32,7 +32,6 @@ import ghidra.program.model.listing.Program;
        * VF Table
        * 

      * Info for the association of this data can be found on http://www.openrce.org - *

      */ public class VfTableModel extends AbstractCreateDataTypeModel { diff --git a/Ghidra/Features/MicrosoftDmang/src/main/java/mdemangler/MDType.java b/Ghidra/Features/MicrosoftDmang/src/main/java/mdemangler/MDType.java index b0d3e60130..f82ebdb2ba 100644 --- a/Ghidra/Features/MicrosoftDmang/src/main/java/mdemangler/MDType.java +++ b/Ghidra/Features/MicrosoftDmang/src/main/java/mdemangler/MDType.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. @@ -15,9 +15,6 @@ */ package mdemangler; -/** - * - */ public class MDType extends MDParsableItem { private String name = ""; // temporary until Object is inherited from? diff --git a/Ghidra/Features/MicrosoftDmang/src/main/java/mdemangler/typeinfo/MDTypeInfo.java b/Ghidra/Features/MicrosoftDmang/src/main/java/mdemangler/typeinfo/MDTypeInfo.java index 1e95b02013..50929ed12f 100644 --- a/Ghidra/Features/MicrosoftDmang/src/main/java/mdemangler/typeinfo/MDTypeInfo.java +++ b/Ghidra/Features/MicrosoftDmang/src/main/java/mdemangler/typeinfo/MDTypeInfo.java @@ -18,9 +18,6 @@ package mdemangler.typeinfo; import mdemangler.*; import mdemangler.naming.MDNameModifier; -/** - * - */ public class MDTypeInfo extends MDParsableItem implements MDNameModifier { private static final String PRIVATE = "private: "; private static final String PROTECTED = "protected: "; diff --git a/Ghidra/Features/PDB/src/main/java/ghidra/app/util/bin/format/pdb2/pdbreader/msf/AbstractMsf.java b/Ghidra/Features/PDB/src/main/java/ghidra/app/util/bin/format/pdb2/pdbreader/msf/AbstractMsf.java index c6327006b1..3342568686 100644 --- a/Ghidra/Features/PDB/src/main/java/ghidra/app/util/bin/format/pdb2/pdbreader/msf/AbstractMsf.java +++ b/Ghidra/Features/PDB/src/main/java/ghidra/app/util/bin/format/pdb2/pdbreader/msf/AbstractMsf.java @@ -97,7 +97,7 @@ import ghidra.util.task.TaskMonitor; * version of stream 0 is what was persisted in the header. So after the StreamTable * has been deserialized from the directory stream, the stream 0 information in the * StreamTable gets overwritten with the stream 0 that we had already obtained. - *

      + * * @see MsfFileReader * @see MsfStream * @see MsfDirectoryStream diff --git a/Ghidra/Features/PDB/src/main/java/ghidra/app/util/bin/format/pdb2/pdbreader/msf/Msf.java b/Ghidra/Features/PDB/src/main/java/ghidra/app/util/bin/format/pdb2/pdbreader/msf/Msf.java index 8c19a30249..69ddff93ea 100644 --- a/Ghidra/Features/PDB/src/main/java/ghidra/app/util/bin/format/pdb2/pdbreader/msf/Msf.java +++ b/Ghidra/Features/PDB/src/main/java/ghidra/app/util/bin/format/pdb2/pdbreader/msf/Msf.java @@ -96,7 +96,7 @@ import ghidra.util.task.TaskMonitor; * version of stream 0 is what was persisted in the header. So after the StreamTable * has been deserialized from the directory stream, the stream 0 information in the * StreamTable gets overwritten with the stream 0 that we had already obtained. - *

      + * * @see MsfFileReader * @see MsfStream * @see MsfDirectoryStream diff --git a/Ghidra/Features/PDB/src/main/java/pdb/PdbUtils.java b/Ghidra/Features/PDB/src/main/java/pdb/PdbUtils.java index d7ae121cb8..dd8c0661b3 100644 --- a/Ghidra/Features/PDB/src/main/java/pdb/PdbUtils.java +++ b/Ghidra/Features/PDB/src/main/java/pdb/PdbUtils.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,7 +34,6 @@ public class PdbUtils { /** * Attempts to extract {@link PdbIdentifiers} from the specified file, which * can be either a pdb or pdb.xml file. - *

      * * @param file File to examine * @param monitor {@link TaskMonitor}to allow cancel and progress diff --git a/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/HttpSymbolServer.java b/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/HttpSymbolServer.java index 32210e8692..e424ed8ca5 100644 --- a/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/HttpSymbolServer.java +++ b/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/HttpSymbolServer.java @@ -37,8 +37,6 @@ import pdb.symbolserver.SymbolServer.MutableTrust; /** * A {@link SymbolServer} that is accessed via HTTP. - *

      - * */ public class HttpSymbolServer extends AbstractSymbolServer implements MutableTrust { private static final String GHIDRA_USER_AGENT = "Ghidra_HttpSymbolServer_client"; diff --git a/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/LocalSymbolStore.java b/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/LocalSymbolStore.java index 1e43e51910..266fa7ba23 100644 --- a/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/LocalSymbolStore.java +++ b/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/LocalSymbolStore.java @@ -28,7 +28,6 @@ import utilities.util.FileUtilities; * Stores Pdb symbol files in a local directory. *

      * This is both a {@link SymbolServer} and a {@link SymbolStore} - *

      */ public class LocalSymbolStore extends AbstractSymbolServer implements SymbolStore { private static final String ADMIN_DIRNAME = "000admin"; // per MS custom @@ -52,7 +51,6 @@ public class LocalSymbolStore extends AbstractSymbolServer implements SymbolStor /** * Creates a (hopefully) MS-compatible symbol server directory location. - *

      * * @param rootDir Directory location of the new symbol store * @param indexLevel the 'level' of the storage directory. Typical directories diff --git a/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/SameDirSymbolStore.java b/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/SameDirSymbolStore.java index 0303bcc4bb..0e3678628d 100644 --- a/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/SameDirSymbolStore.java +++ b/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/SameDirSymbolStore.java @@ -27,8 +27,6 @@ import pdb.symbolserver.SymbolServer.StatusRequiresContext; /** * A Pdb symbol server / symbol store, similar to the {@link LocalSymbolStore}, * but limited to searching just the single directory that the original executable is located in. - *

      - * */ public class SameDirSymbolStore implements SymbolStore, StatusRequiresContext { diff --git a/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/SymbolServer.java b/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/SymbolServer.java index ec988ba59e..adec2f2673 100644 --- a/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/SymbolServer.java +++ b/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/SymbolServer.java @@ -124,7 +124,6 @@ public interface SymbolServer { /** * Returns a location description string of a specific file contained in this symbol server. - *

      * * @param filename raw path and name of a file in this server * (typically from {@link SymbolFileLocation#getPath()} diff --git a/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/SymbolServerService.java b/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/SymbolServerService.java index c5c8fa7d3b..0c67127c09 100644 --- a/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/SymbolServerService.java +++ b/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/SymbolServerService.java @@ -47,7 +47,7 @@ public class SymbolServerService { /** * Creates a new SymbolServerService instance. - *

      + * * @param symbolStore a {@link SymbolStore} - where all remote files are placed when * downloaded. Also treated as a SymbolServer and searched first * @param symbolServers a list of {@link SymbolServer symbol servers} - searched in order @@ -110,7 +110,6 @@ public class SymbolServerService { *

      * Use {@link SymbolFileLocation#isExactMatch(SymbolFileInfo)} to test elements in the * result list for exactness. - *

      * * @param symbolFileInfo Pdb file info to search for * @param findOptions set of {@link FindOption} to control the search. diff --git a/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/SymbolStore.java b/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/SymbolStore.java index 229bc78b37..9dfa45612a 100644 --- a/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/SymbolStore.java +++ b/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/SymbolStore.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,6 @@ public interface SymbolStore extends SymbolServer { * Returns the 'admin' directory of this SymbolStore, which allows files created here * to be efficiently {@link #giveFile(SymbolFileInfo, File, String, TaskMonitor) given} * to the store. - *

      * * @return directory */ @@ -38,7 +37,6 @@ public interface SymbolStore extends SymbolServer { /** * Returns an absolute {@link File} instance based on the specified relative path * to a file inside the symbol store. - *

      * * @param path relative local path * @return absolute {@link File} based on the specified relative path @@ -65,7 +63,6 @@ public interface SymbolStore extends SymbolServer { /** * Places the contents of the stream into a file in this SymbolStore. - *

      * * @param symbolFileInfo {@link SymbolFileInfo} bag of information about the file * @param symbolServerInputStream the stream to ingest diff --git a/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/ui/ConfigPdbDialog.java b/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/ui/ConfigPdbDialog.java index c6fb0b10c0..c9829e64c0 100644 --- a/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/ui/ConfigPdbDialog.java +++ b/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/ui/ConfigPdbDialog.java @@ -642,7 +642,6 @@ public class ConfigPdbDialog extends DialogComponentProvider { /** * Returns true if the given file path is a directory that contains no files. - *

      * * @param directory path to a location on the file system * @return true if is a directory and it contains no files diff --git a/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/ui/FilePromptDialog.java b/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/ui/FilePromptDialog.java index b99e2df4b6..f0dfa3ab25 100644 --- a/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/ui/FilePromptDialog.java +++ b/Ghidra/Features/PDB/src/main/java/pdb/symbolserver/ui/FilePromptDialog.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. @@ -58,7 +58,6 @@ class FilePromptDialog extends DialogComponentProvider { /** * Prompts the user to entry the path to a file and/or directory, * or to pick it using a browser dialog. - *

      * * @param title the dialog title * @param prompt HTML enabled prompt diff --git a/Ghidra/Features/ProgramDiff/src/main/java/ghidra/app/plugin/core/diff/DiffControllerListener.java b/Ghidra/Features/ProgramDiff/src/main/java/ghidra/app/plugin/core/diff/DiffControllerListener.java index 48178a3bc3..7a116574cd 100644 --- a/Ghidra/Features/ProgramDiff/src/main/java/ghidra/app/plugin/core/diff/DiffControllerListener.java +++ b/Ghidra/Features/ProgramDiff/src/main/java/ghidra/app/plugin/core/diff/DiffControllerListener.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. @@ -18,9 +17,6 @@ package ghidra.app.plugin.core.diff; import ghidra.program.model.address.Address; -/** - * - */ public interface DiffControllerListener { public abstract void diffLocationChanged(DiffController diffControl, diff --git a/Ghidra/Features/Sarif/src/main/java/sarif/managers/FunctionsSarifMgr.java b/Ghidra/Features/Sarif/src/main/java/sarif/managers/FunctionsSarifMgr.java index 2c56988a65..92208bdd10 100644 --- a/Ghidra/Features/Sarif/src/main/java/sarif/managers/FunctionsSarifMgr.java +++ b/Ghidra/Features/Sarif/src/main/java/sarif/managers/FunctionsSarifMgr.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. @@ -16,10 +16,7 @@ package sarif.managers; import java.io.IOException; -import java.util.ArrayList; -import java.util.List; -import java.util.Map; -import java.util.Set; +import java.util.*; import javax.swing.Icon; @@ -32,42 +29,15 @@ import ghidra.app.util.NamespaceUtils; import ghidra.app.util.SymbolPath; import ghidra.app.util.importer.MessageLog; import ghidra.program.database.function.OverlappingFunctionException; -import ghidra.program.model.address.Address; -import ghidra.program.model.address.AddressFormatException; -import ghidra.program.model.address.AddressOverflowException; -import ghidra.program.model.address.AddressSet; -import ghidra.program.model.address.AddressSetView; -import ghidra.program.model.data.BuiltInDataTypeManager; -import ghidra.program.model.data.CategoryPath; -import ghidra.program.model.data.DataType; -import ghidra.program.model.data.DataTypeManager; -import ghidra.program.model.data.Undefined; +import ghidra.program.model.address.*; +import ghidra.program.model.data.*; import ghidra.program.model.lang.Register; -import ghidra.program.model.listing.BookmarkManager; -import ghidra.program.model.listing.BookmarkType; -import ghidra.program.model.listing.Function; +import ghidra.program.model.listing.*; import ghidra.program.model.listing.Function.FunctionUpdateType; -import ghidra.program.model.listing.FunctionIterator; -import ghidra.program.model.listing.Library; -import ghidra.program.model.listing.LocalVariableImpl; -import ghidra.program.model.listing.ParameterImpl; -import ghidra.program.model.listing.Program; -import ghidra.program.model.listing.ProgramContext; -import ghidra.program.model.listing.ReturnParameterImpl; -import ghidra.program.model.listing.StackFrame; -import ghidra.program.model.listing.Variable; -import ghidra.program.model.listing.VariableStorage; -import ghidra.program.model.listing.VariableUtilities; import ghidra.program.model.pcode.Varnode; -import ghidra.program.model.symbol.Namespace; -import ghidra.program.model.symbol.SourceType; -import ghidra.program.model.symbol.Symbol; -import ghidra.program.model.symbol.SymbolTable; -import ghidra.program.model.symbol.SymbolType; +import ghidra.program.model.symbol.*; import ghidra.util.Msg; -import ghidra.util.exception.CancelledException; -import ghidra.util.exception.DuplicateNameException; -import ghidra.util.exception.InvalidInputException; +import ghidra.util.exception.*; import ghidra.util.task.TaskLauncher; import ghidra.util.task.TaskMonitor; import sarif.SarifProgramOptions; @@ -144,7 +114,6 @@ public class FunctionsSarifMgr extends SarifMgr { * <!ELEMENT FUNCTION (RETURN_TYPE?, ADDRESS_RANGE*, REGULAR_CMT?, REPEATABLE_CMT?, TYPEINFO_CMT?, STACK_FRAME?, REGISTER_VAR*)> * *

      - *

      * * @param result the parser * @param overwriteConflicts true to overwrite any conflicts diff --git a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/main/VTMarkupItem.java b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/main/VTMarkupItem.java index e88225f997..51857f53d4 100644 --- a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/main/VTMarkupItem.java +++ b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/main/VTMarkupItem.java @@ -82,7 +82,7 @@ public interface VTMarkupItem { * The {@link #getDestinationAddressSource()} will return {@link #USER_DEFINED_ADDRESS_SOURCE} * when a valid destination address is set via this method. *

      - * To clear the destination address you may pass null to this method. + * To clear the destination address you may pass {@code null} to this method. * * @param address the new destination address for the item. * @throws IllegalStateException if this method is called on an applied markup item (you diff --git a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/gui/provider/matchtable/VTMatchTableProvider.java b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/gui/provider/matchtable/VTMatchTableProvider.java index de3f99e5f5..9f51e72e06 100644 --- a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/gui/provider/matchtable/VTMatchTableProvider.java +++ b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/gui/provider/matchtable/VTMatchTableProvider.java @@ -975,7 +975,7 @@ public class VTMatchTableProvider extends ComponentProviderAdapter * location, even if the item is moved or removed. *

      * Creating this object will cancel the default behavior. Calling - * restoreSelection will set the new selection, depending upon the + * {@code restoreSelection} will set the new selection, depending upon the * conditions described above. */ private class SelectionOverrideMemento { diff --git a/Ghidra/Framework/DB/src/main/java/db/KeyToRecordIterator.java b/Ghidra/Framework/DB/src/main/java/db/KeyToRecordIterator.java index c5de983d1f..454fe2f6b3 100644 --- a/Ghidra/Framework/DB/src/main/java/db/KeyToRecordIterator.java +++ b/Ghidra/Framework/DB/src/main/java/db/KeyToRecordIterator.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,9 +18,6 @@ package db; import java.io.IOException; import java.util.NoSuchElementException; -/** - * - */ public class KeyToRecordIterator implements RecordIterator { private DBFieldIterator keyIter; diff --git a/Ghidra/Framework/DB/src/test/java/db/DBTestUtils.java b/Ghidra/Framework/DB/src/test/java/db/DBTestUtils.java index b052e94062..213aa81d2e 100644 --- a/Ghidra/Framework/DB/src/test/java/db/DBTestUtils.java +++ b/Ghidra/Framework/DB/src/test/java/db/DBTestUtils.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,6 @@ import ghidra.framework.Application; import ghidra.util.exception.CancelledException; import ghidra.util.task.TaskMonitor; -/** - * - */ public class DBTestUtils { // Schema Types diff --git a/Ghidra/Framework/Docking/src/main/java/docking/DockingUtils.java b/Ghidra/Framework/Docking/src/main/java/docking/DockingUtils.java index b2e8c24ad6..9c509d86a0 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/DockingUtils.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/DockingUtils.java @@ -78,10 +78,10 @@ import resources.ResourceManager; * (ie. when displaying an error to the user about a bad file, don't put the filename * value at the start of the string, but instead put a quote or some other delimiter to prevent * html mode). - *

      + * *

      Recommended Ghidra UI Components:

      - *

      - * + * + *
      * * * diff --git a/Ghidra/Framework/Docking/src/main/java/docking/DockingWindowManager.java b/Ghidra/Framework/Docking/src/main/java/docking/DockingWindowManager.java index 9f7750d0e0..e4089284d9 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/DockingWindowManager.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/DockingWindowManager.java @@ -2228,7 +2228,6 @@ public class DockingWindowManager implements PropertyChangeListener, Placeholder * be grouped with a specific set of actions. *

      * The default group for a cascaded submenu is the name of the submenu. - *

      * * @param menuPath menu name path where the last element corresponds to the specified group * name. diff --git a/Ghidra/Framework/Docking/src/main/java/docking/Tool.java b/Ghidra/Framework/Docking/src/main/java/docking/Tool.java index f8b399dfc4..785aec7623 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/Tool.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/Tool.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. @@ -124,7 +124,6 @@ public interface Tool extends ServiceProvider { * be grouped with a specific set of actions. *

      * The default group for a cascaded submenu is the name of the submenu. - *

      * * @param menuPath menu name path where the last element corresponds to the specified group * name. diff --git a/Ghidra/Framework/Docking/src/main/java/docking/action/DockingAction.java b/Ghidra/Framework/Docking/src/main/java/docking/action/DockingAction.java index ef34637905..a7e833bfab 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/action/DockingAction.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/action/DockingAction.java @@ -691,7 +691,7 @@ public abstract class DockingAction implements DockingActionIf { *

      * If this is set, then the action will only be added to windows that have providers * that can produce an ActionContext that is appropriate for this action. - *

      + * * @param addToWindowContextClass the ActionContext class required to be producible by a * provider that is hosted in that window before this action is added to that * window. @@ -703,7 +703,7 @@ public abstract class DockingAction implements DockingActionIf { /** * Tells this action to add itself to all windows - *

      + * * @param b to add to all windows or not */ public void setAddToAllWindows(boolean b) { 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 475a8ed4ad..d69a9ef98b 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 @@ -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. @@ -606,8 +606,7 @@ public abstract class AbstractActionBuilder - * - * The default is that the action will only appear in the main window. + * The default is that the action will only appear in the main window. * * @param when use the {@link When} enum to specify the windowing behavior * of the action. @@ -651,7 +650,7 @@ public abstract class AbstractActionBuilder * For more details on how the action context system works, see {@link ActionContext}. - *

      + * * @param newActionContextClass the more specific ActionContext type. * @param The new ActionContext type (as determined by the newActionContextClass) that * the returned builder will have. @@ -697,7 +696,7 @@ public abstract class AbstractActionBuilder * For more details on how the action context system works, see {@link ActionContext}. - *

      + * * @param newActionContextClass the more specific ActionContext type. * @param The new ActionContext type (as determined by the newActionContextClass) that * the returned builder will have. diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/GComponent.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/GComponent.java index 0242cdd149..715396501f 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/GComponent.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/GComponent.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. @@ -52,7 +52,7 @@ public interface GComponent { * Helper function that logs a warning about a string text that looks like it has HTML text. *

      * Use this when working with a string in a label that has already disabled HTML rendering. - *

      + * * @param text string to test for HTML and warn about */ public static void warnAboutHtmlText(String text) { diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/MultiLineLabel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/MultiLineLabel.java index a174cd81f9..704ff3cca8 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/MultiLineLabel.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/MultiLineLabel.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,7 +30,6 @@ import utilities.util.reflection.ReflectionUtilities; * label. Calculates the resizing and centering characteristics. *

      * Not affected by HTML formatting. - *

      */ public class MultiLineLabel extends JPanel { diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/SelectFromListDialog.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/SelectFromListDialog.java index 2f6f77bb51..34233dcca9 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/SelectFromListDialog.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/SelectFromListDialog.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 ghidra.util.SystemUtilities; /** * Dialog that presents the user with a list of strings and returns the object * associated with the user-picked element. - *

      + * * @param opaque object type that will be selected by the user. */ public class SelectFromListDialog extends DialogComponentProvider { diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/checkbox/GCheckBox.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/checkbox/GCheckBox.java index 5e08fe495e..402c4ab58b 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/checkbox/GCheckBox.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/checkbox/GCheckBox.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,7 +23,7 @@ import docking.widgets.GComponent; * A {@link JCheckBox} that has HTML rendering disabled. *

      * See also: - *

      Native ComponentRecommended Component
      {@link JLabel}{@link GLabel}
      {@link GDLabel}
      {@link GHtmlLabel}
      {@link GDHtmlLabel}
      {@link GIconLabel}
      {@link JCheckBox}{@link GCheckBox}
      {@link GHtmlCheckBox}
      + *
      * * * @@ -35,7 +35,6 @@ public class GCheckBox extends JCheckBox implements GComponent { * Creates a check box with no text or icon, with HTML rendering disabled. *

      * See {@link JCheckBox#JCheckBox()} - *

      */ public GCheckBox() { super(); @@ -46,7 +45,6 @@ public class GCheckBox extends JCheckBox implements GComponent { * Creates a check box with an icon, with HTML rendering disabled. *

      * See {@link JCheckBox#JCheckBox(Icon)} - *

      * * @param icon image to display */ @@ -59,7 +57,6 @@ public class GCheckBox extends JCheckBox implements GComponent { * Creates a check box with an icon and initial selected state, with HTML rendering disabled. *

      * See {@link JCheckBox#JCheckBox(Icon, boolean)} - *

      * * @param icon image to display * @param selected initial selection state, true means selected @@ -73,7 +70,6 @@ public class GCheckBox extends JCheckBox implements GComponent { * Creates a check box with the specified text, with HTML rendering disabled. *

      * See {@link JCheckBox#JCheckBox(String)} - *

      * * @param text text of the check box */ @@ -87,7 +83,6 @@ public class GCheckBox extends JCheckBox implements GComponent { * Action supplied, with HTML rendering disabled. *

      * See {@link JCheckBox#JCheckBox(Action)} - *

      * * @param a {@code Action} used to specify the new check box */ diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/checkbox/GHtmlCheckBox.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/checkbox/GHtmlCheckBox.java index 3431008622..b7331e6631 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/checkbox/GHtmlCheckBox.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/checkbox/GHtmlCheckBox.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,7 +23,7 @@ import docking.widgets.GComponent; * A {@link JCheckBox} that allows HTML rendering. *

      * See also: - *

      ClassHTML renderingDescription
      {@link GCheckBox}NOHTML disabled JCheckBox
      {@link GHtmlCheckBox}YESHTML allowed JCheckBox
      + *
      * * * @@ -35,7 +35,6 @@ public class GHtmlCheckBox extends JCheckBox implements GComponent { * Creates a check box with no text or icon, with HTML rendering allowed. *

      * See {@link JCheckBox#JCheckBox()} - *

      */ public GHtmlCheckBox() { super(); @@ -45,7 +44,6 @@ public class GHtmlCheckBox extends JCheckBox implements GComponent { * Creates a check box with an icon, with HTML rendering allowed. *

      * See {@link JCheckBox#JCheckBox(Icon)} - *

      * * @param icon image to display */ @@ -57,7 +55,6 @@ public class GHtmlCheckBox extends JCheckBox implements GComponent { * Creates a check box with an icon and initial selected state, with HTML rendering allowed. *

      * See {@link JCheckBox#JCheckBox(Icon, boolean)} - *

      * * @param icon image to display * @param selected initial selection state, true means selected @@ -70,7 +67,6 @@ public class GHtmlCheckBox extends JCheckBox implements GComponent { * Creates a check box with the specified text, with HTML rendering allowed. *

      * See {@link JCheckBox#JCheckBox(String)} - *

      * * @param text text of the check box */ @@ -83,7 +79,6 @@ public class GHtmlCheckBox extends JCheckBox implements GComponent { * Action supplied, with HTML rendering allowed. *

      * See {@link JCheckBox#JCheckBox(Action)} - *

      * * @param a {@code Action} used to specify the new check box */ diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/combobox/GComboBox.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/combobox/GComboBox.java index bf23fbf519..6c5a32ce5d 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/combobox/GComboBox.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/combobox/GComboBox.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,7 +34,6 @@ public class GComboBox extends JComboBox implements GComponent { * Creates an empty combobox with a default data model. *

      * See {@link JComboBox#JComboBox()} - *

      */ public GComboBox() { super(); @@ -45,7 +44,7 @@ public class GComboBox extends JComboBox implements GComponent { * Creates a combobox using the specified model. *

      * See {@link JComboBox#JComboBox(ComboBoxModel)} - *

      + * * @param aModel the {@link ComboBoxModel} of generic type {@code E} */ public GComboBox(ComboBoxModel aModel) { @@ -57,7 +56,7 @@ public class GComboBox extends JComboBox implements GComponent { * Creates a combobox using the specified items. *

      * See {@link JComboBox#JComboBox(Object[])} - *

      + * * @param items array of objects of generic type {@code E} to insert into the combo box */ public GComboBox(E[] items) { @@ -69,7 +68,7 @@ public class GComboBox extends JComboBox implements GComponent { * Creates a combobox using the specified items. *

      * See {@link JComboBox#JComboBox(Vector)} - *

      + * * @param items a vector containing objects of generic type {@code E} to insert into the combo box */ public GComboBox(Vector items) { diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/InputDialog.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/InputDialog.java index e461cb0d87..0690104cd8 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/InputDialog.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/InputDialog.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,7 +47,6 @@ public class InputDialog extends DialogComponentProvider { * by the specified label. The user should check the value of "isCanceled()" to know whether or * not the user canceled the operation. Otherwise, use the "getValue()" or "getValues()" to get * the value(s) entered by the user. Use the tool's "showDialog()" to display the dialog. - *

      * * @param dialogTitle used as the name of the dialog's title bar * @param label value to use for the label of the text field @@ -61,7 +60,6 @@ public class InputDialog extends DialogComponentProvider { * specified label. The user should check the value of "isCanceled()" to know whether or not the * user canceled the operation. Otherwise, use the "getValue()" or "getValues()" to get the * value(s) entered by the user. Use the tool's "showDialog()" to display the dialog. - *

      * * @param dialogTitle used as the name of the dialog's title bar * @param label value to use for the label of the text field @@ -76,7 +74,6 @@ public class InputDialog extends DialogComponentProvider { * specified label. The user should check the value of "isCanceled()" to know whether or not the * user canceled the operation. Otherwise, use the "getValue()" or "getValues()" to get the * value(s) entered by the user. Use the tool's "showDialog()" to display the dialog. - *

      * * @param dialogTitle used as the name of the dialog's title bar * @param label value to use for the label of the text field @@ -93,7 +90,6 @@ public class InputDialog extends DialogComponentProvider { * specified label. The user should check the value of "isCanceled()" to know whether or not the * user canceled the operation. Otherwise, use the "getValue()" or "getValues()" to get the * value(s) entered by the user. Use the tool's "showDialog()" to display the dialog. - *

      * * @param dialogTitle used as the name of the dialog's title bar * @param label value to use for the label of the text field @@ -109,7 +105,6 @@ public class InputDialog extends DialogComponentProvider { * specified label. The user should check the value of "isCanceled()" to know whether or not the * user canceled the operation. Otherwise, use the "getValue()" or "getValues()" to get the * value(s) entered by the user. Use the tool's "showDialog()" to display the dialog. - *

      * * @param dialogTitle used as the name of the dialog's title bar * @param labels values to use for the labels of the text fields @@ -124,7 +119,6 @@ public class InputDialog extends DialogComponentProvider { * specified label. The user should check the value of "isCanceled()" to know whether or not the * user canceled the operation. Otherwise, use the "getValue()" or "getValues()" to get the * value(s) entered by the user. Use the tool's "showDialog()" to display the dialog. - *

      * * @param dialogTitle used as the name of the dialog's title bar * @param labels values to use for the labels of the text fields diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/MultiLineMessageDialog.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/MultiLineMessageDialog.java index 0be25f9e50..05d65e6218 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/MultiLineMessageDialog.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/MultiLineMessageDialog.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. @@ -52,7 +52,7 @@ public class MultiLineMessageDialog extends DialogComponentProvider { * 6 characters of the string are <html>). *

      * This method will not return until the user presses the OK button. - *

      + * * @param parent - parent component or null * @param title - dialog title * @param shortMessage - short message that appears above the main message. diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/ReadTextDialog.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/ReadTextDialog.java index 3f15479912..de1e53bc1d 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/ReadTextDialog.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/ReadTextDialog.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. @@ -67,9 +67,6 @@ public class ReadTextDialog extends DialogComponentProvider { close(); } - /** - * - */ private JPanel createWorkPanel(String text) { workPanel = new JPanel(new BorderLayout()); diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/internal/TestBigLayoutModel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/internal/TestBigLayoutModel.java index c7ec9a4254..c2caa8ecc6 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/internal/TestBigLayoutModel.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/internal/TestBigLayoutModel.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. @@ -43,9 +43,6 @@ public class TestBigLayoutModel implements LayoutModel { private int startBigSizes = 0; private int endBigSizes = -1; - /** - * - */ public TestBigLayoutModel(FontMetrics fm, String name, BigInteger numIndexes) { this.fm = fm; this.name = name; diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/filechooser/LocalFileChooserModel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/filechooser/LocalFileChooserModel.java index 70b6e050cf..847bcd42b2 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/filechooser/LocalFileChooserModel.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/filechooser/LocalFileChooserModel.java @@ -292,7 +292,7 @@ public class LocalFileChooserModel implements GhidraFileChooserModel { /** * Return a description string for a file system root. Avoid slow calls (such as * {@link FileSystemView#getSystemDisplayName(File)}. - *

      + * * @param root file location * @return formatted description string, example "Local Drive (C:)" */ @@ -323,7 +323,7 @@ public class LocalFileChooserModel implements GhidraFileChooserModel { /** * Return a description string for a root location. - *

      + * * @param root location to get description string * @return string such as "Local Disk (C:)", "Network Drive (R:)" */ diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GDHtmlLabel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GDHtmlLabel.java index 9158910feb..9e5ce4c432 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GDHtmlLabel.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GDHtmlLabel.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,9 +27,8 @@ import docking.widgets.checkbox.GHtmlCheckBox; * Clients do not need to prefix label text with "<html>", as is required for a standard * JLabel. *

      - * * See also: - *

      ClassHTML renderingDescription
      {@link GCheckBox}NOHTML disabled JCheckBox
      {@link GHtmlCheckBox}YESHTML allowed JCheckBox
      + *
      * * * @@ -48,7 +47,6 @@ public class GDHtmlLabel extends AbstractHtmlLabel { * alignment, with HTML rendering allowed. *

      * See {@link JLabel#JLabel()}. - *

      */ public GDHtmlLabel() { } @@ -58,7 +56,7 @@ public class GDHtmlLabel extends AbstractHtmlLabel { * alignment, with HTML rendering allowed. *

      * See {@link JLabel#JLabel(String)}. - *

      + * * @param text string to be displayed by the label */ public GDHtmlLabel(String text) { diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GDLabel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GDLabel.java index ec12e5e983..616df9054f 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GDLabel.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GDLabel.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. @@ -25,7 +25,7 @@ import docking.widgets.checkbox.GHtmlCheckBox; * A 'dynamic' label (the text can be changed), with HTML rendering disabled. *

      * See also: - *

      ClassMutable textHTML renderingDescription
      {@link GLabel}ImmutableNONon-html unchangeable label
      {@link GDLabel}MutableNONon-html changeable label
      + *
      * * * @@ -44,7 +44,6 @@ public class GDLabel extends JLabel implements GComponent { * alignment, with HTML rendering disabled. *

      * See {@link JLabel#JLabel()}. - *

      */ public GDLabel() { super(); @@ -56,7 +55,7 @@ public class GDLabel extends JLabel implements GComponent { * alignment, with HTML rendering disabled. *

      * See {@link JLabel#JLabel(String)}. - *

      + * * @param text non-html string to be displayed by the label */ public GDLabel(String text) { @@ -69,7 +68,7 @@ public class GDLabel extends JLabel implements GComponent { * with HTML rendering disabled. *

      * See {@link JLabel#JLabel(String, int)}. - *

      + * * @param text non-html string to be displayed by the label * @param horizontalAlignment One of * {@link SwingConstants#LEFT}, @@ -88,7 +87,6 @@ public class GDLabel extends JLabel implements GComponent { * with HTML rendering disabled. *

      * See {@link JLabel#JLabel(String, Icon, int)}. - *

      * * @param text non-html string to be displayed by the label * @param icon image to be displayed by the label diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GHtmlLabel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GHtmlLabel.java index 502a6a93bd..cd9e1e2eb5 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GHtmlLabel.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GHtmlLabel.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. @@ -33,7 +33,7 @@ import utilities.util.reflection.ReflectionUtilities; * *

      * See also: - *

      ClassMutable textHTML renderingDescription
      {@link GLabel}ImmutableNONon-html unchangeable label
      {@link GDLabel}MutableNONon-html changeable label
      + *
      * * * @@ -52,7 +52,6 @@ public class GHtmlLabel extends AbstractHtmlLabel { * horizontal alignment, with HTML rendering allowed. *

      * See {@link JLabel#JLabel()}. - *

      */ public GHtmlLabel() { } @@ -62,7 +61,7 @@ public class GHtmlLabel extends AbstractHtmlLabel { * horizontal alignment, with HTML rendering allowed. *

      * See {@link JLabel#JLabel(String)}. - *

      + * * @param text string to be displayed by the label */ public GHtmlLabel(String text) { @@ -77,7 +76,7 @@ public class GHtmlLabel extends AbstractHtmlLabel { *

      * If there are calls to setText() after the initial value has been set by the constructor, a * warning will be printed in the log. - *

      + * * @param text string this label will display */ @Deprecated diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GIconLabel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GIconLabel.java index be56868950..42357e818b 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GIconLabel.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GIconLabel.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 utilities.util.reflection.ReflectionUtilities; * A label that only contains an image and no text. *

      * See also: - *

      ClassMutable textHTML renderingDescription
      {@link GLabel}ImmutableNONon-html unchangeable label
      {@link GDLabel}MutableNONon-html changeable label
      + *
      * * * @@ -48,7 +48,6 @@ public class GIconLabel extends GLabel implements GComponent { * alignment, with HTML rendering disabled. *

      * See {@link JLabel#JLabel()}. - *

      */ public GIconLabel() { super(); @@ -59,7 +58,7 @@ public class GIconLabel extends GLabel implements GComponent { * with HTML rendering disabled. *

      * See {@link JLabel#JLabel(Icon)}. - *

      + * * @param image icon to be displayed by the label */ public GIconLabel(Icon image) { @@ -71,7 +70,7 @@ public class GIconLabel extends GLabel implements GComponent { * with HTML rendering disabled. *

      * See {@link JLabel#JLabel(Icon, int)}. - *

      + * * @param image icon to be displayed by the label * @param horizontalAlignment One of * {@link SwingConstants#LEFT}, @@ -91,7 +90,7 @@ public class GIconLabel extends GLabel implements GComponent { *

      * If there are calls to setText() with any non-null or non-empty value, a * warning will be printed in the log. - *

      + * * @param text string this label will NOT display */ @Deprecated diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GLabel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GLabel.java index 3e744c0fee..f3c683a555 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GLabel.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GLabel.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 utilities.util.reflection.ReflectionUtilities; * An immutable label (the text can NOT be changed), with HTML rendering disabled. *

      * See also: - *

      ClassMutable textHTML renderingDescription
      {@link GLabel}ImmutableNONon-html unchangeable label
      {@link GDLabel}MutableNONon-html changeable label
      + *
      * * * @@ -48,7 +48,6 @@ public class GLabel extends JLabel implements GComponent { * alignment, with HTML rendering disabled. *

      * See {@link JLabel#JLabel()}. - *

      */ public GLabel() { super(); @@ -60,7 +59,7 @@ public class GLabel extends JLabel implements GComponent { * alignment, with HTML rendering disabled. *

      * See {@link JLabel#JLabel(String)}. - *

      + * * @param text non-html string to be displayed by the label */ public GLabel(String text) { @@ -73,7 +72,7 @@ public class GLabel extends JLabel implements GComponent { * with HTML rendering disabled. *

      * See {@link JLabel#JLabel(String, int)}. - *

      + * * @param text non-html string to be displayed by the label * @param horizontalAlignment One of * {@link SwingConstants#LEFT}, @@ -92,7 +91,6 @@ public class GLabel extends JLabel implements GComponent { * with HTML rendering disabled. *

      * See {@link JLabel#JLabel(String, Icon, int)}. - *

      * * @param text non-html string to be displayed by the label * @param icon image to be displayed by the label @@ -142,7 +140,7 @@ public class GLabel extends JLabel implements GComponent { *

      * If there are calls to setText() after the initial value has been set by the constructor, a * warning will be printed in the log. - *

      + * * @param text string this label will display */ @Deprecated diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/list/GList.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/list/GList.java index 788202891d..0dad2f8ce1 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/list/GList.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/list/GList.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. @@ -32,7 +32,6 @@ import docking.widgets.GComponent; * list element and the selection will automatically navigate to it. *

      * HTML rendering is disabled by default. - *

      * * @param the row type of the list */ diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/shapes/PopupWindowPlacer.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/shapes/PopupWindowPlacer.java index 5ea6f442c9..4475c82ba0 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/shapes/PopupWindowPlacer.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/shapes/PopupWindowPlacer.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. @@ -99,7 +99,6 @@ import ghidra.util.exception.AssertException; * * *

      - * * These cells are shown in their nominal placement locations (where they touch the inner bounds, * marked with an X). However we will shift these locations by particular amounts so that these * locations still fit within the outer bounds. For instance, if we allow the BOTTOM cell diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/shapes/PopupWindowPlacerBuilder.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/shapes/PopupWindowPlacerBuilder.java index 1079a6e391..6f8abfeedc 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/shapes/PopupWindowPlacerBuilder.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/shapes/PopupWindowPlacerBuilder.java @@ -45,7 +45,6 @@ import docking.widgets.shapes.PopupWindowPlacer.*; * Each edge placer takes a variable number of Location arguments. These arguments work in the * same way for each method, though some arguments are not valid for some edges; for instance, * Location.TOP is only valid for left and right edges. - *

      * *

      Two or More Location Arguments

      * @@ -56,7 +55,6 @@ import docking.widgets.shapes.PopupWindowPlacer.*; * the second argument specifies the nominal placement cell and the third argument specifies how * far the solution is allowed to shift. To specify a "no-shift" solution, one specifies the same * placement cell twice (e.g., rightEdge(Location.TOP, Location.TOP)). - *

      * *

      One Location Argument

      * @@ -67,14 +65,12 @@ import docking.widgets.shapes.PopupWindowPlacer.*; * rightEdge(Location.TOP, Location.CENTER). When the single argument is * Location.CENTER, two attempts are built, the first being the BOTTOM or RIGHT cell * and the second being the TOP or LEFT cell. - *

      * *

      No Arguments

      * *

      * When no arguments are specified, two arguments to the underlying placer are automatically set * to BOTTOM or RIGHT for the first and TOP or LEFT for the second. - *

      * *

      Examples

      * diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/ConfigurableColumnTableModel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/ConfigurableColumnTableModel.java index a678f30935..204a3ed2b0 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/ConfigurableColumnTableModel.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/ConfigurableColumnTableModel.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. @@ -71,7 +71,6 @@ public interface ConfigurableColumnTableModel extends TableModel { * Returns the header cell renderer for the given column * @param columnIndex the index of the column * @return the renderer - * @return */ public TableCellRenderer getHeaderRenderer(int columnIndex); } diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableFilterPanel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableFilterPanel.java index 8ab0f190e7..aa09704008 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableFilterPanel.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableFilterPanel.java @@ -67,8 +67,8 @@ import utility.function.Callback; * Important Usage Notes *
        *
      • You must translate row values retrieved from the table using - * this panel.
      • - *

        + * this panel. + * * 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 * code snippet below will give the incorrect value: @@ -84,18 +84,17 @@ import utility.function.Callback; * int modelRowNumber = tableFilterPanel.getModelRow( selectedRowNumber ); // see {@link #getModelRow(int)} * * + * * *

      • This class may set a new model on the given table, which can affect how tables are sized.
      • - *

        - * If {@link JTable#getAutoCreateColumnsFromModel()} returns true, then the columns will - * be recreated and resized when this class is constructed. + * + *

      • If {@link JTable#getAutoCreateColumnsFromModel()} returns true, then the columns will + * be recreated and resized when this class is constructed.
      • *
      • The {@link TableFilter} used by this class will be passed the empty string ("") when * {@link TableFilter#acceptsRow(Object)} is called.
      • *
      • You cannot rely on {@link JTable#getRowCount()} to access all of the table data, - * since the data may be filtered.
      • - *

        - * To get a row count that is always all of the model's data, call - * {@link #getUnfilteredRowCount()}. + * since the data may be filtered. To get a row count that is always all of the model's \ + * data, call {@link #getUnfilteredRowCount()}. *

      * * @param the row object type for this given table and model diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableWidget.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableWidget.java index 530f24b88f..3ad662413d 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableWidget.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableWidget.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. @@ -89,7 +89,6 @@ public class GTableWidget extends JPanel { * in sizes that you did not set. So, the best way to use this method is to set the * actual preferred size for your small columns and then set a very large size (400 or so) * for your columns that can be any size. - *

      * * @param widths the widths to apply */ diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constraint/ColumnTypeMapper.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constraint/ColumnTypeMapper.java index f3377deb18..ee7afd82b5 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constraint/ColumnTypeMapper.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constraint/ColumnTypeMapper.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,7 +39,7 @@ import utilities.util.reflection.ReflectionUtilities; * want more than that, you could instead create a new {@link ColumnConstraint} that filters on * more attributes of a Person. See {@link NumberColumnConstraintProvider} for an example * of how to create these ColumnConstraints and their associated editors. - *

      + * * @param The column type that has no inherent {@link ColumnConstraint} for filtering that * column type. * @param The column type to map to that already has {@link ColumnConstraint}s defined diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constraint/dialog/ColumnFilterArchiveDialog.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constraint/dialog/ColumnFilterArchiveDialog.java index c9de6cdf51..0381103879 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constraint/dialog/ColumnFilterArchiveDialog.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constraint/dialog/ColumnFilterArchiveDialog.java @@ -4,18 +4,16 @@ * 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. * See the License for the specific language governing permissions and * limitations under the License. */ -/** - * - */ + package docking.widgets.table.constraint.dialog; import java.awt.*; diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/DataLoadingConstraintEditor.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/DataLoadingConstraintEditor.java index 2f1fd7c31c..845c7e96fb 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/DataLoadingConstraintEditor.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/DataLoadingConstraintEditor.java @@ -4,18 +4,16 @@ * 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. * See the License for the specific language governing permissions and * limitations under the License. */ -/** - * - */ + package docking.widgets.table.constrainteditor; import java.awt.*; @@ -132,7 +130,7 @@ public abstract class DataLoadingConstraintEditor extends AbstractColumnConst /** * {@inheritDoc} - *

      + * * @see DataLoadingConstraintEditor#buildDelegateDetailEditor() */ @Override diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/DateSpinner.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/DateSpinner.java index a828825d0d..eb3828eb7a 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/DateSpinner.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/DateSpinner.java @@ -4,18 +4,16 @@ * 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. * See the License for the specific language governing permissions and * limitations under the License. */ -/** - * - */ + package docking.widgets.table.constrainteditor; import java.awt.event.KeyAdapter; 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 41bfd6a670..64e3ecfddd 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 @@ -42,7 +42,6 @@ public class LocalDateSpinnerModel extends AbstractSpinnerModel { *

    • {@link Calendar#MONTH}
    • *
    • {@link Calendar#DAY_OF_MONTH}
    • * - *

      */ public LocalDateSpinnerModel(LocalDate value, LocalDate minDate, LocalDate maxDate, int calendarField) { @@ -132,8 +131,6 @@ public class LocalDateSpinnerModel extends AbstractSpinnerModel { *

    • {@link Calendar#MONTH}
    • *
    • {@link Calendar#DAY_OF_MONTH}
    • * - *

      - * */ public void setCalendarField(int calendarField) { checkIsValidCalendarField(calendarField); diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableData.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableData.java index 0ff84a193c..1e93a0c8ab 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableData.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableData.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. @@ -197,7 +197,7 @@ public class TableData implements Iterable { } /** - * Adds the new value to the data at the appropriate location based on the sort + * Adds the new {@code value} to the data at the appropriate location based on the sort * * @param value the row Object to insert */ diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/textfield/LocalDateTextField.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/textfield/LocalDateTextField.java index fb190f0e6e..06fcbbfb14 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/textfield/LocalDateTextField.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/textfield/LocalDateTextField.java @@ -4,18 +4,16 @@ * 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. * See the License for the specific language governing permissions and * limitations under the License. */ -/** - * - */ + package docking.widgets.textfield; import java.awt.*; diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTree.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTree.java index f02f630aec..011768e1ef 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTree.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTree.java @@ -1393,7 +1393,6 @@ public class GTree extends JPanel implements BusyListener { /** * Used to run simple GTree tasks that can be expressed as a {@link MonitoredRunnable} (or a * lambda taking a {@link TaskMonitor}). - *

      * * @param runnableTask {@link TaskMonitor} to watch and update with progress. */ diff --git a/Ghidra/Framework/Docking/src/main/java/docking/wizard/WizardModel.java b/Ghidra/Framework/Docking/src/main/java/docking/wizard/WizardModel.java index 9572f4926b..026efeab6a 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/wizard/WizardModel.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/wizard/WizardModel.java @@ -37,7 +37,7 @@ import javax.swing.JComponent; *

    • One or more classes that extend {@link WizardStep}
      *
    • A data class that holds that data being collected by this wizard.
      * - *

      + * * Subclasses must at a minimum implement two methods. *

        *
      1. AddWizardSteps() - This is where the model defines the ordered list of @@ -46,7 +46,7 @@ import javax.swing.JComponent; * will be called when the user presses the Finish button and all the panels have * had a chance to update the wizard data object.
      2. *
      - *

      + * * Optionally, there are several additional methods clients may want to override. *

        *
      1. dispose() - This will be called when the wizard is completed or cancelled and this is @@ -66,6 +66,7 @@ import javax.swing.JComponent; *
      2. getPreferredSize() - By default, this will return a preferred size that is the biggest * width and height of all the preferred sizes of the step panels. Override this to * simply specify the preferred size of the dialog.
      3. + *
      * * @param the data object for this wizard */ diff --git a/Ghidra/Framework/Docking/src/test/java/docking/widgets/fieldpanel/FieldSelectionTest.java b/Ghidra/Framework/Docking/src/test/java/docking/widgets/fieldpanel/FieldSelectionTest.java index 72e38a9807..8caa87d485 100644 --- a/Ghidra/Framework/Docking/src/test/java/docking/widgets/fieldpanel/FieldSelectionTest.java +++ b/Ghidra/Framework/Docking/src/test/java/docking/widgets/fieldpanel/FieldSelectionTest.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,6 @@ import docking.widgets.fieldpanel.support.*; import generic.test.AbstractGenericTest; import ghidra.framework.options.SaveState; -/** - * - */ public class FieldSelectionTest extends AbstractGenericTest { /** diff --git a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/analysis/JitAllocationModel.java b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/analysis/JitAllocationModel.java index 68540bd57e..370a13aeb3 100644 --- a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/analysis/JitAllocationModel.java +++ b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/analysis/JitAllocationModel.java @@ -15,8 +15,7 @@ */ package ghidra.pcode.emu.jit.analysis; -import static ghidra.pcode.emu.jit.analysis.JitVarScopeModel.maxAddr; -import static ghidra.pcode.emu.jit.analysis.JitVarScopeModel.overlapsLeft; +import static ghidra.pcode.emu.jit.analysis.JitVarScopeModel.*; import static org.objectweb.asm.Opcodes.*; import java.math.BigInteger; @@ -85,7 +84,6 @@ import ghidra.program.model.pcode.Varnode; * Several values and variables are at play here. We tabulate the type assignments and resulting * votes: * - *

      *

    • ClassMutable textHTML renderingDescription
      {@link GLabel}ImmutableNONon-html unchangeable label
      {@link GDLabel}MutableNONon-html changeable label
      * * @@ -129,7 +127,6 @@ import ghidra.program.model.pcode.Varnode; * *
      SSA Var
      * - *

      * The registers {@code RCX}, {@code RDX}, and {@code EBX} are trivially allocated as locals of JVM * types {@code double}, {@code double}, and {@code float}, respectively. It is also worth noting * that {@code 0x3f800000} is allocated as a {@code float} constant in the classfile's constant diff --git a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/analysis/JitDataFlowArithmetic.java b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/analysis/JitDataFlowArithmetic.java index ccdcbe9f44..2c576a4d75 100644 --- a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/analysis/JitDataFlowArithmetic.java +++ b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/analysis/JitDataFlowArithmetic.java @@ -358,7 +358,7 @@ public class JitDataFlowArithmetic implements PcodeArithmetic { * {@inheritDoc} * *

      - * We override this to record the {@lnk JitLoadOp load} op into the use-def graph. For our + * We override this to record the {@link JitLoadOp load} op into the use-def graph. For our * {@code inValue}, the {@link JitDataFlowState state} will have just returned the * {@link JitIndirectMemoryVar#INSTANCE dummy indirect} variable definition. We must not "use" * this. Instead, we must take our other parameters to construct the load op and return its diff --git a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/analysis/JitDataFlowUseropLibrary.java b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/analysis/JitDataFlowUseropLibrary.java index 91d6bdd4ff..858ed53eb9 100644 --- a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/analysis/JitDataFlowUseropLibrary.java +++ b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/analysis/JitDataFlowUseropLibrary.java @@ -173,7 +173,7 @@ public class JitDataFlowUseropLibrary implements PcodeUseropLibrary { * of the invocation, not the actual run time invocation. This derives type information * about the userop from the Java method and selects the approparite {@link JitCallOtherOpIf * callother} op to enter into the use-def graph. If an output operand is given, then this - * generates an output notes defined by a {@lnk JitCallOtherDefOp}. Otherwise, it generates + * generates an output notes defined by a {@link JitCallOtherDefOp}. Otherwise, it generates * a (sink) {@link JitCallOtherOp}. * * @implNote When inlining a userop, the decoder leaves the original callother op in place. diff --git a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/analysis/JitVarScopeModel.java b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/analysis/JitVarScopeModel.java index e5431f7b76..19e459a629 100644 --- a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/analysis/JitVarScopeModel.java +++ b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/analysis/JitVarScopeModel.java @@ -135,7 +135,6 @@ import ghidra.util.MathUtilities; * execution follows the error path, we'd rather not birth any of those variables. Thus, we might * like the result of the scope analysis to be: * - *

      * * * @@ -159,7 +158,6 @@ import ghidra.util.MathUtilities; * *
      Block
      * - *

      * This can be achieved rather simply: Define two sets for each block, the upward view and the * downward view. The first corresponds to all varnodes that could be accessed before entering this * block or while in it. The second corresponds to all varnodes that could be access while in this diff --git a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/gen/op/OpGen.java b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/gen/op/OpGen.java index 2288dfcc39..3607703d2e 100644 --- a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/gen/op/OpGen.java +++ b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/gen/op/OpGen.java @@ -40,7 +40,6 @@ import ghidra.program.model.pcode.PcodeOp; * each p-code op, its use-def class, its generator class, and a brief strategy for its bytecode * implementation. * - *

      * * * diff --git a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/gen/var/ValGen.java b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/gen/var/ValGen.java index cd3ca2f570..8dc4d19774 100644 --- a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/gen/var/ValGen.java +++ b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/jit/gen/var/ValGen.java @@ -36,7 +36,6 @@ import ghidra.program.model.pcode.Varnode; * {@link #lookup(JitVal)} and each output operand {@link VarGen#lookup(JitVar)}. The op generator * has already retrieved the {@link JitOp} whose operands are of the {@link JitVal} class. * - *

      *

      P-code Op
      * * diff --git a/Ghidra/Framework/FileSystem/src/test.slow/java/db/buffers/RecoveryFileTest.java b/Ghidra/Framework/FileSystem/src/test.slow/java/db/buffers/RecoveryFileTest.java index 8a6254dfc0..6f539a67c3 100644 --- a/Ghidra/Framework/FileSystem/src/test.slow/java/db/buffers/RecoveryFileTest.java +++ b/Ghidra/Framework/FileSystem/src/test.slow/java/db/buffers/RecoveryFileTest.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,9 +29,6 @@ import ghidra.framework.store.db.PrivateDatabase; import ghidra.util.task.TaskMonitor; import utilities.util.FileUtilities; -/** - * - */ public class RecoveryFileTest extends AbstractGenericTest { private static int BUFFER_SIZE = LocalBufferFile.getRecommendedBufferSize(500); diff --git a/Ghidra/Framework/FileSystem/src/test.slow/java/ghidra/framework/store/local/LockFileTest.java b/Ghidra/Framework/FileSystem/src/test.slow/java/ghidra/framework/store/local/LockFileTest.java index c8122a3e65..a540b5e7ef 100644 --- a/Ghidra/Framework/FileSystem/src/test.slow/java/ghidra/framework/store/local/LockFileTest.java +++ b/Ghidra/Framework/FileSystem/src/test.slow/java/ghidra/framework/store/local/LockFileTest.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. @@ -15,7 +15,7 @@ */ package ghidra.framework.store.local; -import static org.junit.Assert.assertTrue; +import static org.junit.Assert.*; import java.io.File; @@ -24,9 +24,6 @@ import org.junit.*; import generic.test.AbstractGenericTest; import ghidra.util.Msg; -/** - * - */ public class LockFileTest extends AbstractGenericTest { private static final File DIRECTORY = new File(AbstractGenericTest.getTestDirectoryPath()); diff --git a/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQBuilder.java b/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQBuilder.java index e41233be05..309797e1e2 100644 --- a/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQBuilder.java +++ b/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQBuilder.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. @@ -31,7 +31,6 @@ import ghidra.util.task.TaskMonitor; * *

      * Examples: - *

      *

      {@literal
        * QCallback callback = new AbstractQCallback() {
        *     public R process(I item, TaskMonitor monitor) {
      diff --git a/Ghidra/Framework/Generic/src/main/java/generic/test/AbstractGenericTest.java b/Ghidra/Framework/Generic/src/main/java/generic/test/AbstractGenericTest.java
      index 203945711d..7203d20636 100644
      --- a/Ghidra/Framework/Generic/src/main/java/generic/test/AbstractGenericTest.java
      +++ b/Ghidra/Framework/Generic/src/main/java/generic/test/AbstractGenericTest.java
      @@ -15,7 +15,7 @@
        */
       package generic.test;
       
      -import static org.junit.Assert.fail;
      +import static org.junit.Assert.*;
       
       import java.awt.*;
       import java.awt.image.BufferedImage;
      @@ -485,7 +485,6 @@ public abstract class AbstractGenericTest extends AbstractGTest {
       	/**
       	 * Uses reflection to execute the constructor for the given class with the given parameters. The
       	 * new instance of the given class will be returned.
      -	 * 

      * * @param containingClass The class that contains the desired constructor. * @param parameterTypes The parameter types that the constructor takes. This value can diff --git a/Ghidra/Framework/Generic/src/main/java/generic/test/TestUtils.java b/Ghidra/Framework/Generic/src/main/java/generic/test/TestUtils.java index 205afad00e..ffefd98bbf 100644 --- a/Ghidra/Framework/Generic/src/main/java/generic/test/TestUtils.java +++ b/Ghidra/Framework/Generic/src/main/java/generic/test/TestUtils.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. @@ -388,7 +388,6 @@ public class TestUtils { /** * Uses reflection to execute the constructor for the given class with the given parameters. * The new instance of the given class will be returned. - *

      * * @param containingClass The class that contains the desired constructor. * @param parameterTypes The parameter types that the constructor takes. diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/framework/GenericRunInfo.java b/Ghidra/Framework/Generic/src/main/java/ghidra/framework/GenericRunInfo.java index f0b92588e3..d9db76dc2f 100644 --- a/Ghidra/Framework/Generic/src/main/java/ghidra/framework/GenericRunInfo.java +++ b/Ghidra/Framework/Generic/src/main/java/ghidra/framework/GenericRunInfo.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,8 +35,8 @@ public class GenericRunInfo { /** * Get all of the applications's settings directories - * (.application_name_version) for various versions in descending order by the - * modification time. In other words, list.get(0) will be the directory + * ({@code .application_name_version}) for various versions in descending order by the + * modification time. In other words, {@code list.get(0)} will be the directory * with the most recent modification time. If two directories have the same time then the * directories will simply be sorted based on their pathnames as a string. *

      diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/Conv.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/Conv.java index 0a0259a167..322fc795a3 100644 --- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/Conv.java +++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/Conv.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. @@ -118,7 +118,7 @@ public class Conv { *

      * Old and incorrect way to convert bytes to a String by casting their * values to chars. Do not use. Does not seem to be used in current codebase. - *

      + * * @param array * @return * @deprecated Use {@link String#String(byte[], java.nio.charset.Charset) new String(bytes, StandardCharSets.US_ASCII)} diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/DataConverter.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/DataConverter.java index 5a0cc161ee..418e4e2c13 100644 --- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/DataConverter.java +++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/DataConverter.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. @@ -21,8 +21,6 @@ import java.math.BigInteger; /** * Stateless helper classes with static singleton instances that contain methods to convert * Java numeric types to and from their raw form in a byte array. - *

      - * */ public interface DataConverter extends Serializable { @@ -349,7 +347,6 @@ public interface DataConverter extends Serializable { /** * Converts the given value to bytes using the number of least significant bytes * specified by size. - *

      * * @param value value to convert to bytes * @param size number of least significant bytes of value to be written to the byte array diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/NumericUtilities.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/NumericUtilities.java index 7d50e781d5..d297136b50 100644 --- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/NumericUtilities.java +++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/NumericUtilities.java @@ -420,7 +420,6 @@ public final class NumericUtilities { * For example, consider the mask 00001111:01011100, and the value 00001001:00011000. This will * display as {@code X8:[x0x1][10xx]}. To see the correlation, consider the table: *

      Varnode Type
      - * * * * @@ -687,7 +686,6 @@ public final class NumericUtilities { * integer * *
      Display{@code X}
      - * * * * @@ -698,7 +696,7 @@ public final class NumericUtilities { * * * - * + * * * * @@ -733,7 +731,7 @@ public final class NumericUtilities { * * * - * + * * * * @@ -768,7 +766,7 @@ public final class NumericUtilities { * * * - * + * * * * diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/classfinder/ClassJar.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/classfinder/ClassJar.java index 9d7171f7e4..aab723f325 100644 --- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/classfinder/ClassJar.java +++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/classfinder/ClassJar.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. @@ -41,8 +41,8 @@ class ClassJar implements ClassLocation { /** * Pattern for matching jar files in a module lib dir *

      - * The pattern roughly states to accept any path that contains lib or - * build/libs, ending in .jar (non-capturing) and then + * The pattern roughly states to accept any path that contains {@code lib} or + * {@code build/libs}, ending in {@code .jar} (non-capturing) and then * grab that dir's parent and the name of the jar file. */ private static final Pattern ANY_MODULE_LIB_JAR_FILE_PATTERN = diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/exception/NotYetImplementedException.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/exception/NotYetImplementedException.java index beb9a6a079..e97a204d8b 100644 --- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/exception/NotYetImplementedException.java +++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/exception/NotYetImplementedException.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. @@ -27,7 +26,7 @@ package ghidra.util.exception; public class NotYetImplementedException extends RuntimeException { /** - *

      Constructs a NotYetImplementedException with no detail message.

      + *

      Constructs a NotYetImplementedException with no detail message. */ public NotYetImplementedException() { super(); @@ -35,7 +34,7 @@ public class NotYetImplementedException extends RuntimeException { /** *

      Constructs a NotYetImplementedException with the specified - * detail message.

      + * detail message. * * @param message The message. */ diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/AddableLongIntHashtable.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/AddableLongIntHashtable.java index 13f5a2eb28..ecb2a76f09 100644 --- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/AddableLongIntHashtable.java +++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/AddableLongIntHashtable.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. @@ -27,9 +26,6 @@ import ghidra.util.exception.NoValueException; */ public class AddableLongIntHashtable extends LongIntHashtable { - /** - * - */ private static final long serialVersionUID = 1L; public AddableLongIntHashtable(int capacity) { diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/DirectedGraph.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/DirectedGraph.java index 05d7345044..7162946066 100644 --- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/DirectedGraph.java +++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/DirectedGraph.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. @@ -1073,9 +1073,6 @@ public class DirectedGraph { } } - /** - * - */ private void CopyVertexAttributes(DirectedGraph copy) { AttributeManager attm = this.vertexAttributes; AttributeManager copyManager = copy.vertexAttributes(); diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/map/ValueMap.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/map/ValueMap.java index 693f4fe82e..d0490f46d7 100644 --- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/map/ValueMap.java +++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/map/ValueMap.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. @@ -117,7 +117,8 @@ public abstract class ValueMap implements Serializable { /** * Given two indices it indicates whether there is an index in - * that range (inclusive) having the property.

      + * that range (inclusive) having the property. + * * @param start the start of the index range. * @param end the end of the index range. * diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/timer/Watchdog.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/timer/Watchdog.java index 64e46f7977..f7a477308e 100644 --- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/timer/Watchdog.java +++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/timer/Watchdog.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,7 +34,7 @@ public class Watchdog implements Closeable { /** * Creates a watchdog (initially disarmed) that will poll for expiration every * defaultTimeoutMS milliseconds, calling {@code timeoutMethod} when triggered. - *

      + * * @param defaultTimeoutMS number of milliseconds that the watchdog will wait after * being armed before calling the timeout method. * @param timeoutMethod {@link Runnable} functional callback. diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/xml/XmlUtilities.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/xml/XmlUtilities.java index 7706f865f8..685f932208 100644 --- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/xml/XmlUtilities.java +++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/xml/XmlUtilities.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. @@ -15,13 +15,12 @@ */ package ghidra.util.xml; +import java.io.*; +import java.nio.charset.StandardCharsets; import java.util.List; import java.util.regex.Matcher; import java.util.regex.Pattern; -import java.io.*; -import java.nio.charset.StandardCharsets; - import javax.xml.XMLConstants; import javax.xml.parsers.ParserConfigurationException; import javax.xml.parsers.SAXParserFactory; @@ -189,7 +188,6 @@ public class XmlUtilities { /** * Convert a String into a JDOM {@link Element}. - *

      * * @param s * @return @@ -207,7 +205,6 @@ public class XmlUtilities { /** * Writes a JDOM XML {@link Document} to a {@link File}. - *

      * * @param doc JDOM XML {@link Document} to write. * @param dest {@link File} to write to. @@ -223,7 +220,6 @@ public class XmlUtilities { /** * Writes a JDOM XML {@link Document} to a {@link File}, with a prettier * format than {@link #writeDocToFile(Document, File)}. - *

      * * @param doc JDOM XML {@link Document} to write. * @param dest {@link File} to write to. @@ -239,7 +235,6 @@ public class XmlUtilities { /** * Read a File and convert to jdom xml doc. - *

      * * @param f {@link File} to read * @return JDOM {@link Document} @@ -257,7 +252,6 @@ public class XmlUtilities { /** * Read a File and convert to jdom xml doc. - *

      * * @param f {@link ResourceFile} to read * @return JDOM {@link Document} @@ -324,7 +318,6 @@ public class XmlUtilities { /** * Parses the optional specified string as a decimal number, returning its * integer value. - *

      * * @param intStr string with integer digits, or empty or null * @param defaultValue value to return if intStr is missing @@ -340,7 +333,6 @@ public class XmlUtilities { /** * Parses the optional specified string as a decimal number, returning its * integer value, or defaultValue if the string is null. - *

      * * @param intStr string with integer digits, or null. * @param defaultValue value to return if intStr is null. @@ -366,7 +358,6 @@ public class XmlUtilities { /** * Parses the specified string as a decimal number, returning its integer * value. - *

      * * @param intStr String with integer digits * @param minValue minimum value allowed (inclusive) @@ -391,7 +382,6 @@ public class XmlUtilities { /** * Parses the required attribute as a decimal number, returning its integer * value. - *

      * * @param ele JDom element that contains the attribute * @param attrName the name of the xml attribute to parse @@ -415,7 +405,6 @@ public class XmlUtilities { /** * Parses an optional attribute as a decimal number, returning its integer * value, or the defaultValue if the attribute is null. - *

      * * @param ele JDOM element that contains the attribute. * @param attrName the name of the xml attribute to parse. @@ -475,7 +464,6 @@ public class XmlUtilities { * Note, using {@link Long#MIN_VALUE} and/or {@link Long#MAX_VALUE} as lower * and upper bounds is problematic and should be avoided as the range check * will become a NO-OP and always succeed. - *

      * * @param longStr String with integer digits * @param minValue minimum value allowed (inclusive) @@ -504,7 +492,6 @@ public class XmlUtilities { * Note, using {@link Long#MIN_VALUE} and/or {@link Long#MAX_VALUE} as lower * and upper bounds is problematic and should be avoided as the range check * will become a NO-OP and always succeed. - *

      * * @param ele JDom element that contains the attribute * @param attrName the name of the xml attribute to parse @@ -532,7 +519,6 @@ public class XmlUtilities { * Note, using {@link Long#MIN_VALUE} and/or {@link Long#MAX_VALUE} as lower * and upper bounds is problematic and should be avoided as the range check * will become a NO-OP and always succeed. - *

      * * @param ele JDom element that contains the attribute. * @param attrName the name of the xml attribute to parse. @@ -607,7 +593,6 @@ public class XmlUtilities { /** * Throws an {@link IOException} with a verbose explanation if the requested * attribute is not present or is empty. - *

      * * @param ele JDOM {@link Element} that contains the attribute * @param attrName the attribute name diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/xml/ThreadedXmlPullParserImpl.java b/Ghidra/Framework/Generic/src/main/java/ghidra/xml/ThreadedXmlPullParserImpl.java index b7276e50d5..b7abb2740e 100644 --- a/Ghidra/Framework/Generic/src/main/java/ghidra/xml/ThreadedXmlPullParserImpl.java +++ b/Ghidra/Framework/Generic/src/main/java/ghidra/xml/ThreadedXmlPullParserImpl.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. @@ -97,7 +97,6 @@ class ThreadedXmlPullParserImpl extends AbstractXmlPullParser { * contains its own internal validation (an internal dtd specification). For * XML files that use an external dtd file you should call * {@link #XmlParser(File, ErrorHandler, boolean)}. - *

      * * @param input the XML input stream * @param inputName the name of the input stream diff --git a/Ghidra/Framework/Generic/src/test/java/ghidra/util/datastruct/SortedRangeListTest.java b/Ghidra/Framework/Generic/src/test/java/ghidra/util/datastruct/SortedRangeListTest.java index 3ddb5a8192..6572133396 100644 --- a/Ghidra/Framework/Generic/src/test/java/ghidra/util/datastruct/SortedRangeListTest.java +++ b/Ghidra/Framework/Generic/src/test/java/ghidra/util/datastruct/SortedRangeListTest.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. @@ -15,8 +15,7 @@ */ package ghidra.util.datastruct; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertTrue; +import static org.junit.Assert.*; import java.util.Iterator; @@ -28,9 +27,7 @@ import generic.test.AbstractGenericTest; public class SortedRangeListTest extends AbstractGenericTest { private SortedRangeList list; - /** - * - */ + public SortedRangeListTest() { super(); } diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GraphAlgorithms.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GraphAlgorithms.java index 5c849b8f9d..4ed56503aa 100644 --- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GraphAlgorithms.java +++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GraphAlgorithms.java @@ -73,12 +73,12 @@ import util.CollectionUtils; * *

    • * graph density: - *
    • *
        *                        E
        *          Density =  --------
        *                      V(V-1)
        *		
      + * * */ public class GraphAlgorithms { diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/service/graph/GraphDisplayOptions.java b/Ghidra/Framework/Graph/src/main/java/ghidra/service/graph/GraphDisplayOptions.java index a17ec64b69..40819eae2f 100644 --- a/Ghidra/Framework/Graph/src/main/java/ghidra/service/graph/GraphDisplayOptions.java +++ b/Ghidra/Framework/Graph/src/main/java/ghidra/service/graph/GraphDisplayOptions.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. @@ -683,7 +683,7 @@ public class GraphDisplayOptions implements OptionsChangeListener { * be used by plugins or other objects that get instantiated immediately when the tool is * constructed. Otherwise, if the tool exits and this hasn't been called, any saved option * values will be lost. - *

      + * * @param tool The tool to use to register options * @param help the help location to be used by the {@link OptionsDialog} for display/editing * these options diff --git a/Ghidra/Framework/Gui/src/main/java/ghidra/util/HTMLUtilities.java b/Ghidra/Framework/Gui/src/main/java/ghidra/util/HTMLUtilities.java index e8e142266b..e9d7f49de2 100644 --- a/Ghidra/Framework/Gui/src/main/java/ghidra/util/HTMLUtilities.java +++ b/Ghidra/Framework/Gui/src/main/java/ghidra/util/HTMLUtilities.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,7 +35,7 @@ import utilities.util.reflection.ReflectionUtilities; * *

      Many clients use this class to render content as HTML. Below are a few use cases along * with the method that should be used for each. - *

      NumberRadix
       
       
       
      + *
      * * * @@ -539,7 +539,7 @@ public class HTMLUtilities { * *

      For example, consider the following

      * - *

      Use CaseFunctionDescription
      + *
      * * * diff --git a/Ghidra/Framework/Gui/src/main/java/ghidra/util/task/AbstractSwingUpdateManager.java b/Ghidra/Framework/Gui/src/main/java/ghidra/util/task/AbstractSwingUpdateManager.java index cec7216759..ee0a3c3309 100644 --- a/Ghidra/Framework/Gui/src/main/java/ghidra/util/task/AbstractSwingUpdateManager.java +++ b/Ghidra/Framework/Gui/src/main/java/ghidra/util/task/AbstractSwingUpdateManager.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,7 +30,7 @@ import utilities.util.reflection.ReflectionUtilities; * class to keep pushing off internal updates until: 1) the flurry of events has settled down, or * 2) some specified amount of time has expired. *

      - * The various methods dictate when the client will get a callback:

      + * The various methods dictate when the client will get a callback: *

        *
      • {@link #update()} - if this is the first call to update, then do the work * immediately; otherwise, buffer the update request until the diff --git a/Ghidra/Framework/Gui/src/main/java/ghidra/util/task/SwingUpdateManager.java b/Ghidra/Framework/Gui/src/main/java/ghidra/util/task/SwingUpdateManager.java index 5b4293e5ec..5b9da2e1f4 100644 --- a/Ghidra/Framework/Gui/src/main/java/ghidra/util/task/SwingUpdateManager.java +++ b/Ghidra/Framework/Gui/src/main/java/ghidra/util/task/SwingUpdateManager.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,7 +22,7 @@ package ghidra.util.task; * class to keep pushing off internal updates until: 1) the flurry of events has settled down, or * 2) some specified amount of time has expired. *

        - * The various methods dictate when the client will get a callback:

        + * The various methods dictate when the client will get a callback: *

          *
        • {@link #update()} - if this is the first call to update, then do the work * immediately; otherwise, buffer the update request until the diff --git a/Ghidra/Framework/Gui/src/main/java/resources/ResourceManager.java b/Ghidra/Framework/Gui/src/main/java/resources/ResourceManager.java index 8ce414c26c..d34ef15545 100644 --- a/Ghidra/Framework/Gui/src/main/java/resources/ResourceManager.java +++ b/Ghidra/Framework/Gui/src/main/java/resources/ResourceManager.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. @@ -491,7 +491,6 @@ public class ResourceManager { * found from the given path. This differs from {@link #loadImage(String)} in that * loadImage will return the default Icon if one can't be found. Further, loadImage will cache * even the default value, while findIcon only caches resolved icons. - *

          * * @param path the icon to load, e.g., "images/home.gif" * @return the ImageIcon if it exists or null @@ -610,7 +609,7 @@ public class ResourceManager { /** * Load the images specified by filenames; substitutes the default bomb icon * if problems occur trying to load an individual file. - *

          + * * @param filenames vararg list of string filenames (ie. "images/home.gif") * @return list of ImageIcons with each image, problem / missing images replaced with * the default icon. diff --git a/Ghidra/Framework/Help/src/main/java/help/validator/location/HelpModuleCollection.java b/Ghidra/Framework/Help/src/main/java/help/validator/location/HelpModuleCollection.java index b7b653fb29..97f1369f3c 100644 --- a/Ghidra/Framework/Help/src/main/java/help/validator/location/HelpModuleCollection.java +++ b/Ghidra/Framework/Help/src/main/java/help/validator/location/HelpModuleCollection.java @@ -34,7 +34,6 @@ import help.validator.model.*; /** * A class that is meant to hold a single help input directory and 0 or more * external, pre-built help sources (i.e., jar file or directory). - *

          *

            * 						Note
            * 						Note
          diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/FileActionManager.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/FileActionManager.java
          index f21c285d8e..86cdb79d01 100644
          --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/FileActionManager.java
          +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/FileActionManager.java
          @@ -372,7 +372,7 @@ class FileActionManager {
           	 * menu listener for File | Close Project...
           	 * 

          * This method will always save the FrontEndTool and project, but not the data unless - * confirmClose is called. + * {@code confirmClose} is called. * * @param isExiting true if we are closing the project because * Ghidra is exiting diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/ProjectAccessPanel.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/ProjectAccessPanel.java index 7bc1c18d09..a666f324dd 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/ProjectAccessPanel.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/ProjectAccessPanel.java @@ -39,13 +39,11 @@ import util.CollectionUtils; /** * Panel that shows the users for a given repository and the users associated with the current * shared project. There are 3 main sub-panels: - *

          *

            *
          • Known Users Panel: Displays all users in the repository
          • *
          • Button Panel: Provides buttons for adding/removing users from the project
          • *
          • User Access Panel: Displays all users on the project, and their access permissions
          • *
          - *

          * If the current user is an admin, he may change user permissions and add/remove them * from the project. If not, only the User Access Panel will be visible and it will * be read-only. diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTreeClipboardUtils.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTreeClipboardUtils.java index f522152a2a..67e6cebf88 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTreeClipboardUtils.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTreeClipboardUtils.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,6 @@ import ghidra.util.Msg; /** * Manages Ghidra integration with the system clipboard when doing cut/copy/paste * operations on domainFiles and domainFolders in a data tree widget. - *

          */ public class DataTreeClipboardUtils { /** diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/FindCheckoutsTableModel.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/FindCheckoutsTableModel.java index b06ee0bfd7..67a6207b2b 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/FindCheckoutsTableModel.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/FindCheckoutsTableModel.java @@ -4,18 +4,16 @@ * 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. * See the License for the specific language governing permissions and * limitations under the License. */ -/** - * - */ + package ghidra.framework.main.datatree; import java.io.IOException; diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/model/ChunkReader.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/model/ChunkReader.java index 279234e145..87c88d25e9 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/model/ChunkReader.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/model/ChunkReader.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. @@ -72,9 +72,6 @@ public class ChunkReader { return file; } - /** - * - */ public void reload() throws IOException { raf = new RandomAccessFile(file, "r"); reverser = new ReverseLineReader("UTF-8", raf); diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/ViewportUtility.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/ViewportUtility.java index 9105e2f39a..6271ca52e6 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/ViewportUtility.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/ViewportUtility.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. @@ -49,9 +49,6 @@ public class ViewportUtility implements Observer { private FVEventListener eventListener; - /** - * - */ public ViewportUtility(FVEventListener eventListener) { this.eventListener = eventListener; eventListener.addObserver(this); diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataDeleteTask.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataDeleteTask.java index 80052d6631..82f4c2fe57 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataDeleteTask.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataDeleteTask.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,6 @@ import utilities.util.FileUtilities; *

          * This task will show a summary dialog if there were multiple files involved or any errors * encountered. - *

          */ public class ProjectDataDeleteTask extends Task { @@ -274,7 +273,7 @@ public class ProjectDataDeleteTask extends Task { * containing parent folders). *

          * Errors are saved into {@link #foldersToDelete} as the value that the folder maps to. - *

          + * * @param monitor * @throws CancelledException */ @@ -310,7 +309,7 @@ public class ProjectDataDeleteTask extends Task { * Attempts to delete the files listed in {@link #filesToDelete}. *

          * Errors are saved into {@link #filesToDelete} as the value that the file maps to. - *

          + * * @param monitor * @throws CancelledException */ diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/wizard/project/SelectProjectPanel.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/wizard/project/SelectProjectPanel.java index 15bdc85ebb..32d9edb9d9 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/wizard/project/SelectProjectPanel.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/wizard/project/SelectProjectPanel.java @@ -53,8 +53,7 @@ public class SelectProjectPanel extends JPanel { /** * Construct a new panel. - * @param statusChangedCallback - * @param panelManager manager for the "new project" set of panels + * @param statusChangedCallback callback */ public SelectProjectPanel(Callback statusChangedCallback) { super(new PairLayout(10, 10)); diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainObject.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainObject.java index 72c2e8ed2d..b214aee858 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainObject.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainObject.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. @@ -408,7 +408,6 @@ public interface DomainObject { /** * Performs the given callback inside of a transaction. Use this method in place of the more * verbose try/catch/finally semantics. - *

          *

           	 * program.withTransaction("My Description", () -> {
           	 * 	// ... Do something
          @@ -438,7 +437,6 @@ public interface DomainObject {
           	/**
           	 * Calls the given supplier inside of a transaction.  Use this method in place of the more
           	 * verbose try/catch/finally semantics.
          -	 * 

          *

           	 * program.withTransaction("My Description", () -> {
           	 * 	// ... Do something
          diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainObjectListenerBuilder.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainObjectListenerBuilder.java
          index 0cedd2f14e..293858b09a 100644
          --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainObjectListenerBuilder.java
          +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainObjectListenerBuilder.java
          @@ -31,7 +31,6 @@ import utility.function.Callback;
            * the remaining event records. This is can be handled with an {@link #any(EventType...)},  
            * followed by a {@link AnyBuilder#terminate(Callback)} or {@link AnyBuilder#terminate(Consumer)} 
            * if you want the event.
          - * 

          *

            * new DomainObjectListenerBuilder()
            *	.any(DomainObjectEvent.RESTORED).call(() -> refreshAll())
          @@ -51,7 +50,6 @@ import utility.function.Callback;
            * details of the record, only that one of the  given events was fired. This can be handled using 
            * the  {@link #any(EventType...)}, followed by a  call to {@link AnyBuilder#call(Callback)} or
            * {@link AnyBuilder#call(Consumer)}
          - * 

          *

            * new DomainObjectListenerBuilder()
            *	.onAny(ProgramEvent.FUNCTION_CHANGED).call(() -> refreshFunctions())
          @@ -74,7 +72,6 @@ import utility.function.Callback;
            * can be changed by calling {@link #with(Class)}. Once this is called the builder
            * will require that all consumers being passed in will now be typed on that record
            * class. 
          - * 

          *

            * new DomainObjectListenerBuilder()
            *	.each(DomainObjectEvent.PROPERTY_CHANGED).call(r -> processPropertyChanged(r))
          diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ProjectDataUtils.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ProjectDataUtils.java
          index 83fe922ec4..c6d01bd97d 100644
          --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ProjectDataUtils.java
          +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ProjectDataUtils.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.
          @@ -152,7 +152,7 @@ public class ProjectDataUtils {
           	/**
           	 * Returns a Ghidra {@link DomainFolder} with the matching path, creating
           	 * any missing parent folders as needed.
          -	 * 

          + * * @param currentFolder starting {@link DomainFolder}. * @param path relative path to the desired DomainFolder, using forward slashes * as separators. Empty string ok, multiple slashes in a row treated as single slash, @@ -182,7 +182,7 @@ public class ProjectDataUtils { /** * Returns a Ghidra {@link DomainFolder} with the matching path, or null if not found. - *

          + * * @param currentFolder starting {@link DomainFolder}. * @param path relative path to the desired DomainFolder, using forward slashes * as separators. Empty string ok, multiple slashes in a row treated as single slash, diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/Plugin.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/Plugin.java index 955b0eeff5..03b6e65b3b 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/Plugin.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/Plugin.java @@ -37,7 +37,7 @@ import ghidra.util.classfinder.ExtensionPoint; * Plugins expose their features or capabilities to users via menu items and buttons that * the user can click on, and via "service" APIs that other Plugins can programmatically subscribe * to, and via {@link PluginEvent}s that are broadcast. - *

          + * *

          Well formed Plugins:

          *
            *
          • Derive from Plugin (directly or indirectly).
          • @@ -75,13 +75,13 @@ import ghidra.util.classfinder.ExtensionPoint; * (required) *
          • Create Actions (optional)
          • *
          • Register {@link ghidra.framework.options.Options Options} with the - * {@link PluginTool#getOptions(String)}. (optional)

          • + * {@link PluginTool#getOptions(String)}. (optional) * * *
          • Other Plugins are constructed, dependencies evaluated, etc.
            * If your dependencies are not available (i.e., not installed, threw an exception during their * initialization, etc), your Plugin's {@link #dispose()} will be called and then your Plugin - * instance will be discarded.

          • + * instance will be discarded. *
          • Your Plugin's {@link #init()} method is called (when its dependencies are met).
          • *
          • *
              @@ -171,7 +171,6 @@ import ghidra.util.classfinder.ExtensionPoint; * multi-implemented service will either receive a randomly picked instance if using * {@link PluginTool#getService(Class)} or will receive all implementations if using * {@link PluginTool#getServices(Class)}. - *

              * *

              Plugin Events

              *
                @@ -232,7 +231,7 @@ public abstract class Plugin implements ExtensionPoint, PluginEventListener, Ser /** * Construct a new Plugin. - *

                + * * @param tool PluginTool that will host/contain this plugin. */ protected Plugin(PluginTool tool) { @@ -292,7 +291,7 @@ public abstract class Plugin implements ExtensionPoint, PluginEventListener, Ser /** * Returns this plugin's name. - *

                + * * @return String name, derived from simple class name. */ public final String getName() { @@ -326,7 +325,7 @@ public abstract class Plugin implements ExtensionPoint, PluginEventListener, Ser /** * Return classes of data types that this plugin can support. - *

                + * * @return classes of data types that this plugin can support */ public Class[] getSupportedDataTypes() { @@ -335,7 +334,7 @@ public abstract class Plugin implements ExtensionPoint, PluginEventListener, Ser /** * Method called if the plugin supports this domain file. - *

                + * * @param data array of {@link DomainFile}s * @return boolean true if can accept */ @@ -346,7 +345,7 @@ public abstract class Plugin implements ExtensionPoint, PluginEventListener, Ser /** * Request plugin to process URL if supported. Actual processing may be delayed and * interaction with user may occur (e.g., authentication, approval, etc.). - *

                + * * @param url data URL * @return boolean true if this plugin can process URL. */ @@ -356,7 +355,7 @@ public abstract class Plugin implements ExtensionPoint, PluginEventListener, Ser /** * Get the domain files that this plugin has open. - *

                + * * @return array of {@link DomainFile}s that are open by this Plugin. */ public DomainFile[] getData() { @@ -577,7 +576,7 @@ public abstract class Plugin implements ExtensionPoint, PluginEventListener, Ser * with the PluginTool's services. *

                * The {@link #initServices()} handles registering the services queued during the constructor. - *

                + * * @param interfaceClass Class that the service object implements. * @param service Service object instance. * @param dynamicRegister boolean flag that indicates that the service being registered @@ -638,7 +637,7 @@ public abstract class Plugin implements ExtensionPoint, PluginEventListener, Ser /** * Used to register a service dynamically, during runtime, instead of during the Plugin's * constructor. - *

                + * * @param interfaceClass service interface class * @param service service implementation */ @@ -844,7 +843,7 @@ public abstract class Plugin implements ExtensionPoint, PluginEventListener, Ser /** * Returns the static {@link PluginDescription} object that was derived from the * {@link PluginInfo @PluginInfo} annotation at the top of your Plugin. - *

                + * * @return the static/shared {@link PluginDescription} instance that describes this Plugin. */ public final PluginDescription getPluginDescription() { diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/PluginInfo.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/PluginInfo.java index abd8acfc27..fd7bad3681 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/PluginInfo.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/PluginInfo.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. @@ -45,7 +45,7 @@ public @interface PluginInfo { * The {@link PluginStatus} of this plugin: * {@link PluginStatus#STABLE STABLE} , {@link PluginStatus#RELEASED RELEASED}, * {@link PluginStatus#HIDDEN HIDDEN}, {@link PluginStatus#UNSTABLE UNSTABLE} - *

                + * * @return {@link PluginStatus#STABLE STABLE} , {@link PluginStatus#RELEASED RELEASED}, * {@link PluginStatus#HIDDEN HIDDEN}, {@link PluginStatus#UNSTABLE UNSTABLE}, etc. */ @@ -55,14 +55,13 @@ public @interface PluginInfo { * The package name this plugin belongs in. *

                * Use XYZPluginPackage.NAME - *

                + * * @return String package name */ String packageName(); /** * See PluginCategoryNames - *

                *

                  *
                • PluginCategoryNames.COMMON *
                • PluginCategoryNames.SUPPORT diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/ServiceInfo.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/ServiceInfo.java index 141f6d8c0c..21649200d8 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/ServiceInfo.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/ServiceInfo.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. @@ -21,7 +21,6 @@ import java.lang.annotation.*; * Meta-data about a Plugin's Service. *

                  * Example: - *

                  *

                  @ServiceInfo( defaultProvider = MyPlugin.class )
                    * public interface MyService {
                    *  public void foo();
                  @@ -41,7 +40,6 @@ public @interface ServiceInfo {
                   	 * 

                  * Using defaultProviderName = packageX.subPackageY.SomeClass.class.getName() * will not work (value needs to be a constant expression). - *

                  * * @return full package and classname string of the plugin class that provides this service. */ @@ -49,7 +47,7 @@ public @interface ServiceInfo { /** * Sets the class that provides the default implementation of this service. - *

                  + * * @return Class instance of the plugin that provides this service. */ Class[] defaultProvider() default {}; diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/util/PluginDescription.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/util/PluginDescription.java index 72a2638a62..3515ec80b5 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/util/PluginDescription.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/util/PluginDescription.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. @@ -285,7 +285,7 @@ public class PluginDescription implements Comparable { /** * Constructs a new PluginDescription for the given plugin class. - *

                  + * * @deprecated, use {@link PluginInfo @PluginInfo} instead. * * @param pluginClassParam the class of the plugin diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/util/PluginUtils.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/util/PluginUtils.java index d364a0740b..92a690fa93 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/util/PluginUtils.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/util/PluginUtils.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. @@ -115,7 +115,7 @@ public class PluginUtils { /** * Returns the Plugin Class that is specified as being the defaultProvider for a * Service, or null if no default provider is specified. - *

                  + * * @param serviceClass Service interface class * @return Plugin class that provides the specified service */ diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionTableModel.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionTableModel.java index cdd813fc5b..40319abe8d 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionTableModel.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionTableModel.java @@ -36,7 +36,6 @@ import ghidra.util.task.TaskMonitor; /** * Model for the {@link ExtensionTablePanel}. This defines 5 columns for displaying information in * {@link ExtensionDetails} objects: - *

                  *

                    * 		- Installed (checkbox)
                    * 		- Name
                  diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/task/GScheduledTask.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/task/GScheduledTask.java
                  index 56d632f93f..5fa26f4acc 100644
                  --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/task/GScheduledTask.java
                  +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/task/GScheduledTask.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.
                  @@ -20,7 +19,6 @@ package ghidra.framework.task;
                    * Class for tracking scheduled GTasks.  When tasks are scheduled, they are assigned to a GTaskGroup,
                    * given a priority, assigned a one-up ID, given a GTaskMonitor.  This class is used to keep all
                    * that information together.
                  - * 

                  */ public class GScheduledTask implements Comparable { private static long nextID = 1; // Used so that tasks of equal priority are sorted in the order diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/DefaultAssemblyResolvedBackfill.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/DefaultAssemblyResolvedBackfill.java index a296dc6a6a..8b9d2b0df2 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/DefaultAssemblyResolvedBackfill.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/DefaultAssemblyResolvedBackfill.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,9 +40,6 @@ public class DefaultAssemblyResolvedBackfill extends AbstractAssemblyResolution protected final int inslen; protected final int offset; - /** - * @see {@link AssemblyResolution#backfill(PatternExpression, MaskedLong, Map, int, String)} - */ protected DefaultAssemblyResolvedBackfill(AbstractAssemblyResolutionFactory factory, String description, PatternExpression exp, MaskedLong goal, int inslen, int offset) { super(factory, description, null, null); diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/BinaryExpression.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/BinaryExpression.java index 8bc1226b6a..be6aa75be4 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/BinaryExpression.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/BinaryExpression.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. @@ -24,10 +24,6 @@ import ghidra.program.model.mem.MemBuffer; import ghidra.program.model.pcode.PcodeOp; import ghidra.program.model.pcode.Varnode; -/** - * - */ - public class BinaryExpression implements OperandValue, ExpressionValue { public static final int INVALID_OP = -1; public static final int ADD = 0; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Constant.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Constant.java index 687f252259..7506e44aa9 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Constant.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Constant.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. @@ -18,9 +17,6 @@ package ghidra.app.plugin.processors.generic; import ghidra.program.model.mem.MemBuffer; -/** - * - */ public class Constant implements ExpressionValue { private long val; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ConstantTemplate.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ConstantTemplate.java index 08fa0f31e1..b9e7e7ab60 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ConstantTemplate.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ConstantTemplate.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. @@ -20,9 +20,6 @@ import java.util.HashMap; import ghidra.program.model.address.Address; -/** - * - */ public class ConstantTemplate implements Serializable { public static final int REAL = 1; public static final int HANDLE = 2; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ConstructorPcodeTemplate.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ConstructorPcodeTemplate.java index 550a6e601a..feb55406e8 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ConstructorPcodeTemplate.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ConstructorPcodeTemplate.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. @@ -22,15 +21,12 @@ */ package ghidra.app.plugin.processors.generic; -import ghidra.program.model.pcode.PcodeOp; - import java.io.Serializable; import java.util.ArrayList; import java.util.HashMap; -/** - * - */ +import ghidra.program.model.pcode.PcodeOp; + public class ConstructorPcodeTemplate implements Serializable { private HandleTemplate result; private ArrayList pcodeDirectives; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ExpressionTerm.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ExpressionTerm.java index ea24292f49..6071a8ce65 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ExpressionTerm.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ExpressionTerm.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. @@ -15,16 +15,13 @@ */ package ghidra.app.plugin.processors.generic; -import ghidra.program.model.address.AddressSpace; -import ghidra.program.model.mem.MemBuffer; - import java.io.Serializable; import java.util.Hashtable; +import ghidra.program.model.address.AddressSpace; +import ghidra.program.model.mem.MemBuffer; + // TODO needs documentation -/** - * - */ public class ExpressionTerm implements Serializable { private ExpressionValue val; private Offset offset; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ExpressionValue.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ExpressionValue.java index 75b22d1d72..c32361aca6 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ExpressionValue.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ExpressionValue.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. @@ -16,13 +15,10 @@ */ package ghidra.app.plugin.processors.generic; -import ghidra.program.model.mem.*; - import java.io.Serializable; -/** - * - */ +import ghidra.program.model.mem.MemBuffer; + public interface ExpressionValue extends Serializable { long longValue(MemBuffer buf, int offset) throws Exception; int length(MemBuffer buf, int offset) throws Exception; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Handle.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Handle.java index d2442f8499..6b1079bce8 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Handle.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Handle.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. @@ -20,9 +20,6 @@ import java.io.Serializable; import ghidra.program.model.address.AddressSpace; import ghidra.program.model.pcode.Varnode; -/** - * - */ public class Handle implements Serializable { public static final int SPACE = 0; public static final int OFFSET = 1; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/HandleTemplate.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/HandleTemplate.java index 5df20b6020..39a3f6ef7e 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/HandleTemplate.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/HandleTemplate.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. @@ -16,14 +15,11 @@ */ package ghidra.app.plugin.processors.generic; -import ghidra.program.model.pcode.Varnode; - import java.io.Serializable; import java.util.HashMap; -/** - * - */ +import ghidra.program.model.pcode.Varnode; + public class HandleTemplate implements Serializable { // private String name; private VarnodeTemplate ptr; // pointer to data diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Offset.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Offset.java index f0a7184efc..27c35bf35a 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Offset.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Offset.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. @@ -16,14 +15,11 @@ */ package ghidra.app.plugin.processors.generic; -import ghidra.program.model.mem.MemBuffer; - import java.io.Serializable; import java.util.Hashtable; -/** - * - */ +import ghidra.program.model.mem.MemBuffer; + public class Offset implements Serializable { private int offset; private Operand relTo; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/OpTemplate.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/OpTemplate.java index 53031adb03..0766b23973 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/OpTemplate.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/OpTemplate.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. @@ -16,17 +15,14 @@ */ package ghidra.app.plugin.processors.generic; +import java.io.Serializable; +import java.util.HashMap; + import ghidra.program.model.address.Address; import ghidra.program.model.address.AddressFactory; import ghidra.program.model.pcode.PcodeOp; import ghidra.program.model.pcode.Varnode; -import java.io.Serializable; -import java.util.HashMap; - -/** - * - */ public class OpTemplate implements Serializable { private Operand omit; private VarnodeTemplate output; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Operand.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Operand.java index bf90aedd55..f9ea0d67e3 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Operand.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Operand.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. @@ -15,16 +15,13 @@ */ package ghidra.app.plugin.processors.generic; -import ghidra.program.model.mem.MemBuffer; -import ghidra.program.model.pcode.PcodeOp; - import java.io.Serializable; import java.util.ArrayList; import java.util.Hashtable; -/** - * - */ +import ghidra.program.model.mem.MemBuffer; +import ghidra.program.model.pcode.PcodeOp; + public class Operand implements Serializable { private boolean dynamic; private String name; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/OperandValue.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/OperandValue.java index b83eafb897..4adba2b5c6 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/OperandValue.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/OperandValue.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. @@ -15,15 +15,12 @@ */ package ghidra.app.plugin.processors.generic; -import ghidra.program.model.mem.MemBuffer; -import ghidra.program.model.pcode.PcodeOp; - import java.io.Serializable; import java.util.ArrayList; -/** - * - */ +import ghidra.program.model.mem.MemBuffer; +import ghidra.program.model.pcode.PcodeOp; + public interface OperandValue extends Serializable { public int length(MemBuffer buf,int offset) throws Exception; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/SledException.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/SledException.java index ed9f9a61f0..a76314a3c5 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/SledException.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/SledException.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. @@ -36,7 +35,7 @@ public class SledException extends RuntimeException { } /** - *

                  Constructs a SledException with no detail message.

                  + *

                  Constructs a SledException with no detail message. */ public SledException() { super(); @@ -44,7 +43,7 @@ public class SledException extends RuntimeException { /** *

                  Constructs a SledException with the specified - * detail message.

                  + * detail message. * * @param message The message. */ diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/PseudoCodeUnit.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/PseudoCodeUnit.java index 2d9b3f1ce3..d465c7aebc 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/PseudoCodeUnit.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/PseudoCodeUnit.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,6 @@ import ghidra.util.*; import ghidra.util.exception.NoValueException; import ghidra.util.map.TypeMismatchException; -/** - * - */ abstract class PseudoCodeUnit implements CodeUnit { protected Address address; 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 fe274942e0..219b730ee8 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 @@ -26,7 +26,6 @@ import ghidra.program.model.symbol.*; *

                  * For example, if a SymbolPath is constructed with "foo::bar::baz", then "baz" is the * 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".
                  • diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcodeCPort/utils/WeakHashMap2.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcodeCPort/utils/WeakHashMap2.java index dbc31accdf..9c466fbf90 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcodeCPort/utils/WeakHashMap2.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcodeCPort/utils/WeakHashMap2.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. @@ -141,10 +141,10 @@ public class WeakHashMap2 extends AbstractMap { /** * Constructs a new WeakHashMap2 with the same mappings as the - * specified Map. The WeakHashMap2 is created with an + * specified {@code Map}. The {@code WeakHashMap2} is created with an * initial capacity of twice the number of mappings in the specified map * or 11 (whichever is greater), and a default load factor, which is - * 0.75. + * {@code 0.75}. * * @param t the map whose mappings are to be placed in this map. * @since 1.3 diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/ManagerDB.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/ManagerDB.java index db0819274d..dcc6cfb6ef 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/ManagerDB.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/ManagerDB.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. @@ -85,7 +85,6 @@ public interface ManagerDB { /** * Callback from the program after being closed to signal this manager to release memory and resources. - *

                    */ default void dispose() { // default do nothing diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkDB.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkDB.java index 7214396bce..b31726a805 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkDB.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkDB.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,9 +22,6 @@ import ghidra.program.model.address.Address; import ghidra.program.model.listing.Bookmark; import ghidra.program.model.listing.BookmarkType; -/** - * - */ public class BookmarkDB extends DatabaseObject implements Bookmark { private BookmarkDBManager mgr; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkDBAdapterV1.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkDBAdapterV1.java index 31bb32b84b..f2c2b7531b 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkDBAdapterV1.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkDBAdapterV1.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. @@ -15,18 +15,14 @@ */ package ghidra.program.database.bookmark; -import ghidra.program.database.map.AddressMap; -import ghidra.program.model.address.*; -import ghidra.util.exception.VersionException; - import java.io.IOException; import java.util.*; import db.*; +import ghidra.program.database.map.AddressMap; +import ghidra.program.model.address.*; +import ghidra.util.exception.VersionException; -/** - * - */ class BookmarkDBAdapterV1 extends BookmarkDBAdapter { static final int VERSION = 1; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkDBAdapterV2.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkDBAdapterV2.java index bd8432119b..7516912663 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkDBAdapterV2.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkDBAdapterV2.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. @@ -16,13 +15,10 @@ */ package ghidra.program.database.bookmark; +import db.DBHandle; import ghidra.program.database.map.AddressMap; import ghidra.util.exception.VersionException; -import db.DBHandle; -/** - * - */ class BookmarkDBAdapterV2 extends BookmarkDBAdapterV1 { static final int V2_VERSION = 2; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkTypeDBAdapterNoTable.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkTypeDBAdapterNoTable.java index 9f3488c230..51c6a74697 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkTypeDBAdapterNoTable.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkTypeDBAdapterNoTable.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. @@ -20,9 +20,6 @@ import java.io.IOException; import db.DBHandle; import db.DBRecord; -/** - * - */ public class BookmarkTypeDBAdapterNoTable extends BookmarkTypeDBAdapter { private DBRecord[] records = new DBRecord[0]; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/OldBookmark.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/OldBookmark.java index 1496bf424e..35ea8bc477 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/OldBookmark.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/OldBookmark.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. @@ -21,9 +21,6 @@ import ghidra.program.model.listing.Program; import ghidra.util.ObjectStorage; import ghidra.util.Saveable; -/** - * - */ public class OldBookmark implements Saveable { //TODO: This class and its constructors should not be public diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/data/ArrayDBAdapterV0.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/data/ArrayDBAdapterV0.java index 4c913b6efc..9c6dc51aae 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/data/ArrayDBAdapterV0.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/data/ArrayDBAdapterV0.java @@ -20,9 +20,6 @@ import java.io.IOException; import db.*; import ghidra.util.exception.VersionException; -/** - * - */ class ArrayDBAdapterV0 extends ArrayDBAdapter { private static final int VERSION = 0; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/module/ModuleManager.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/module/ModuleManager.java index b47a66758d..fc56aec76c 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/module/ModuleManager.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/module/ModuleManager.java @@ -249,9 +249,6 @@ class ModuleManager { } } - /** - * - */ private void createRootModule() throws IOException { DBRecord rootRecord = moduleAdapter.createModuleRecord(0, getProgram().getName()); ModuleDB root = new ModuleDB(this, moduleCache, rootRecord); diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/oldfunction/OldFunctionDataDB.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/oldfunction/OldFunctionDataDB.java index 69a0094789..befaa3e3a0 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/oldfunction/OldFunctionDataDB.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/oldfunction/OldFunctionDataDB.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,8 +18,8 @@ package ghidra.program.database.oldfunction; import java.io.IOException; import java.util.*; -import db.Field; import db.DBRecord; +import db.Field; import ghidra.program.database.ProgramDB; import ghidra.program.database.map.AddressMap; import ghidra.program.model.address.Address; @@ -32,9 +32,6 @@ import ghidra.util.Msg; import ghidra.util.StringUtilities; import ghidra.util.exception.InvalidInputException; -/** - * - */ class OldFunctionDataDB { private AddressMap addrMap; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/oldfunction/OldFunctionMapDB.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/oldfunction/OldFunctionMapDB.java index ecf55a8ec3..c7f7f0dcf5 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/oldfunction/OldFunctionMapDB.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/oldfunction/OldFunctionMapDB.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,9 +23,6 @@ import ghidra.program.model.address.AddressSetView; import ghidra.util.datastruct.IndexRange; import ghidra.util.datastruct.IndexRangeIterator; -/** - * - */ @SuppressWarnings("deprecation") class OldFunctionMapDB { diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/oldfunction/OldStackFrameDB.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/oldfunction/OldStackFrameDB.java index 89a1020971..35e9e022bf 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/oldfunction/OldStackFrameDB.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/oldfunction/OldStackFrameDB.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,8 +18,8 @@ package ghidra.program.database.oldfunction; import java.io.IOException; import java.util.*; -import db.Field; import db.DBRecord; +import db.Field; import ghidra.program.model.address.AddressOutOfBoundsException; import ghidra.program.model.data.DataType; import ghidra.program.model.listing.*; @@ -27,9 +27,6 @@ import ghidra.program.model.symbol.SourceType; import ghidra.util.Msg; import ghidra.util.exception.InvalidInputException; -/** - * - */ class OldStackFrameDB implements StackFrame { private int localSize; // if local size == 0, size is longest defined local diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/references/RefList.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/references/RefList.java index 2ecfa8d0b3..166d7c5df6 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/references/RefList.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/references/RefList.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. @@ -24,9 +24,6 @@ import ghidra.program.model.symbol.*; import ghidra.util.BigEndianDataConverter; import ghidra.util.DataConverter; -/** - * - */ abstract class RefList extends DatabaseObject { static volatile int BIG_REFLIST_THRESHOLD = 1700; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/symbol/OverlappingNamespaceException.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/symbol/OverlappingNamespaceException.java index e53bee8dc4..c8a1413532 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/symbol/OverlappingNamespaceException.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/symbol/OverlappingNamespaceException.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. @@ -18,9 +17,6 @@ package ghidra.program.database.symbol; import ghidra.program.model.address.Address; -/** - * - */ public class OverlappingNamespaceException extends Exception { private Address start; private Address end; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressFormatException.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressFormatException.java index 90b1713e0c..b499a88e12 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressFormatException.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressFormatException.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. @@ -24,19 +23,19 @@ import ghidra.util.exception.UsrException; */ public class AddressFormatException extends UsrException { /** - *

                    Constructs an AddressFormatException with no detail message.

                    - */ + *

                    Constructs an AddressFormatException with no detail message. + */ public AddressFormatException() { super("Cannot parse string into address."); } /** - *

                    Constructs an AddressFormatException with the specified - * detail message.

                    - * - * @param message A user message. - */ + *

                    Constructs an AddressFormatException with the specified + * detail message. + * + * @param message A user message. + */ public AddressFormatException(String message) { super(message); } diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressObjectMap.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressObjectMap.java index ced7503969..e7e7f8a446 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressObjectMap.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressObjectMap.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. @@ -15,11 +15,11 @@ */ package ghidra.program.model.address; +import java.io.Serializable; + import ghidra.util.datastruct.NoSuchIndexException; import ghidra.util.map.ObjectValueMap; -import java.io.Serializable; - /** * AddressObjectMap maintains a mapping between addresses in the program @@ -159,13 +159,13 @@ public class AddressObjectMap { } /** - * Adds a range to a object. - * Assumes that the range has already been cleared. - *

                    - * @param range the range being added. - * @param objID the id of the object the range is being - * added to. - */ + * Adds a range to a object. + * Assumes that the range has already been cleared. + * + * @param range the range being added. + * @param objID the id of the object the range is being + * added to. + */ private void addRange(Object obj, long start, long end) { try { long next; @@ -285,12 +285,12 @@ public class AddressObjectMap { } /** - * Removes a range from a object. - *

                    - * @param range the range being removed. - * @param objID the id of the object it is being - * removed from. - */ + * Removes a range from a object. + * + * @param range the range being removed. + * @param objID the id of the object it is being + * removed from. + */ private void removeRange(Object obj, long start, long end) { try { long next; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressOutOfBoundsException.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressOutOfBoundsException.java index feaa0e6c1e..b928dbc93a 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressOutOfBoundsException.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressOutOfBoundsException.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. @@ -24,7 +23,7 @@ package ghidra.program.model.address; */ public class AddressOutOfBoundsException extends RuntimeException { /** - *

                    Constructs an AddressOutOfBoundsException with no detail message.

                    + *

                    Constructs an AddressOutOfBoundsException with no detail message. */ public AddressOutOfBoundsException() { super("Address not contained in memory."); @@ -32,7 +31,7 @@ public class AddressOutOfBoundsException extends RuntimeException { /** *

                    Constructs an AddressOutOfBoundsException with the specified - * detail message.

                    + * detail message. * * @param message The message. */ diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressOverflowException.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressOverflowException.java index 096c05eb21..2b72422b80 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressOverflowException.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressOverflowException.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. @@ -25,18 +24,18 @@ import ghidra.util.exception.UsrException; */ public class AddressOverflowException extends UsrException { /** - *

                    Constructs an AddressOverflowException with no detail message.

                    - */ + *

                    Constructs an AddressOverflowException with no detail message. + */ public AddressOverflowException() { super("Displacement would result in an illegal address value."); } /** - *

                    Constructs an AddressOverflowException with the specified - * detail message.

                    - * - * @param message The message. - */ + *

                    Constructs an AddressOverflowException with the specified + * detail message. + * + * @param message The message. + */ public AddressOverflowException(String message) { super(message); } diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressRange.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressRange.java index 9574083408..ab00cd6ddb 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressRange.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressRange.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,7 +23,7 @@ import java.math.BigInteger; * addresses from a minimum address to a maximum * address. The entire range must fall within a * single address space. - *

                    + * * @see AddressRangeImpl * @since 2000-02-16 */ diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressRangeToAddressComparator.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressRangeToAddressComparator.java index c0a329fa29..92c3304a58 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressRangeToAddressComparator.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressRangeToAddressComparator.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. @@ -20,16 +19,15 @@ import java.util.Comparator; /** * Compares an address against an AddressRange. - *

                    */ public class AddressRangeToAddressComparator implements Comparator { /** * Compares an address against an AddressRange. * @param obj1 the first object to compare. Must be an address or an address range. * @param obj2 the second object to compare. Must be an address or an address range. - *

                    - * @return a negative integer, zero, or a positive integer - * if the first argument is less than, equal to, or greater than the second. + * + * @return a negative integer, zero, or a positive integer + * if the first argument is less than, equal to, or greater than the second. */ public int compare(Object obj1, Object obj2) { if(obj1 instanceof AddressRange) { diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressSetCollection.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressSetCollection.java index f592b69f50..4664525a66 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressSetCollection.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressSetCollection.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 AddressSetCollection { /** * Test if the address is contained within any of the addressSets in this collection. - *

                    + * * @param address address to test. * @return true if addr exists in the set, false otherwise. */ diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressSetMapping.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressSetMapping.java index 3f19d43ace..81ab090707 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressSetMapping.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressSetMapping.java @@ -18,10 +18,13 @@ package ghidra.program.model.address; import java.util.*; /** - * Class that provides random access to {@link Address}es in an {@link AddressSet}, based on the index of the address in the set, not the {@link Address#getOffset() address offset value}.

                    + * Class that provides random access to {@link Address}es in an {@link AddressSet}, based on the + * index of the address in the set, not the {@link Address#getOffset() address offset value}. *

                    - * For instance, a {@link AddressSet} containing addresses [0,1,2,3,4,90,91,92,93,94], {@link #getAddress(int) getAddress(1)} will return an {@link Address} with an - * offset value of 1, but {@link #getAddress(int) getAddress(5)} will return an {@link Address} instance with an offset value of 90. + * For instance, a {@link AddressSet} containing addresses [0,1,2,3,4,90,91,92,93,94], + * {@link #getAddress(int) getAddress(1)} will return an {@link Address} with an + * offset value of 1, but {@link #getAddress(int) getAddress(5)} will return an {@link Address} + * instance with an offset value of 90. *

                    * This collapses a sparse address space with holes into a contiguous list of addresses. */ diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressSetView.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressSetView.java index a0ecdf91a7..310ffa292e 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressSetView.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressSetView.java @@ -25,7 +25,7 @@ import java.util.Iterator; public interface AddressSetView extends Iterable { /** * Test if the address is contained within this set. - *

                    + * * @param addr address to test. * @return true if addr exists in the set, false otherwise. */ @@ -35,7 +35,7 @@ public interface AddressSetView extends Iterable { * Test if the given address range is contained in this set. * The specified start and end addresses must form a valid range within * a single {@link AddressSpace}. - *

                    + * * @param start the first address in the range. * @param end the last address in the range. * @return true if entire range is contained within the set, @@ -45,7 +45,7 @@ public interface AddressSetView extends Iterable { /** * Test if the given address set is a subset of this set. - *

                    + * * @param rangeSet the set to test. * @return true if the entire set is contained within this set, * false otherwise. diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/SegmentMismatchException.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/SegmentMismatchException.java index 851673b7ab..680265c998 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/SegmentMismatchException.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/SegmentMismatchException.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. @@ -25,18 +24,18 @@ import ghidra.util.exception.UsrException; */ public class SegmentMismatchException extends UsrException { /** - *

                    Constructs a SegmentMismatchException with no detail message.

                    - */ + *

                    Constructs a SegmentMismatchException with no detail message. + */ public SegmentMismatchException() { super("The segments of the addresses do not match."); } /** - *

                    Constructs a SegmentMismatchException with the specified - * detail message.

                    - * - * @param message The message. - */ + *

                    Constructs a SegmentMismatchException with the specified + * detail message. + * + * @param message The message. + */ public SegmentMismatchException(String message) { super(message); } diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/CodeBlockReferenceImpl.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/CodeBlockReferenceImpl.java index 65837d1756..a1cb6a6d4c 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/CodeBlockReferenceImpl.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/CodeBlockReferenceImpl.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. @@ -32,7 +32,6 @@ import ghidra.util.task.TaskMonitor; *

                    * The referent is the address of the instruction in * the source block that flows to the destination block. - *

                    * * @see ghidra.program.model.block.CodeBlockReference */ diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/MultEntSubIterator.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/MultEntSubIterator.java index d5c7c351aa..b4c246424a 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/MultEntSubIterator.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/MultEntSubIterator.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. @@ -62,7 +61,6 @@ class MultEntSubIterator implements CodeBlockIterator { * Creates a new iterator that will iterate over the * program within a given address range set. All blocks which * overlap the address set will be returned. - *

                    * * @param model the SubroutineModel the iterator will use in its operations. * @param set the address range set which the iterator is to be diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/SimpleBlockIterator.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/SimpleBlockIterator.java index 2e390bedb0..7407739005 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/SimpleBlockIterator.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/SimpleBlockIterator.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. @@ -45,7 +44,6 @@ public class SimpleBlockIterator implements CodeBlockIterator { /** * Creates a new iterator that will iterate over the entire * program starting from its current minimum address. - *

                    * * @param model the BlockModel the iterator will use in its operations. * @param monitor task monitor which allows user to cancel operation. @@ -60,7 +58,6 @@ public class SimpleBlockIterator implements CodeBlockIterator { * Creates a new iterator that will iterate over the * program within a given address range set. All blocks which * overlap the address set will be returned. - *

                    * * @param model the BlockModel the iterator will use in its operations. * @param set the address range set which the iterator is to be diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/SingleEntSubIterator.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/SingleEntSubIterator.java index a03ab0ee6b..be0c1121ed 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/SingleEntSubIterator.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/SingleEntSubIterator.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. @@ -15,13 +15,13 @@ */ package ghidra.program.model.block; +import java.util.LinkedList; + import ghidra.program.model.address.Address; import ghidra.program.model.address.AddressSetView; import ghidra.util.exception.CancelledException; import ghidra.util.task.TaskMonitor; -import java.util.LinkedList; - /** * SingleEntSubIterator is an implementation of * CodeBlockIterator capable of iterating in @@ -79,7 +79,7 @@ public class SingleEntSubIterator implements CodeBlockIterator { * Creates a new iterator that will iterate over the * program within a given address range set. All blocks which * overlap the address set will be returned. - *

                    + * * @param model the BlockModel the iterator will use in its operations. * @param set the address range set which the iterator is to be * restricted to. diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/AbstractStringDataType.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/AbstractStringDataType.java index b342476e73..2ec0729230 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/AbstractStringDataType.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/AbstractStringDataType.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. @@ -15,11 +15,9 @@ */ package ghidra.program.model.data; -import static ghidra.program.model.data.CharsetSettingsDefinition.CHARSET; -import static ghidra.program.model.data.RenderUnicodeSettingsDefinition.RENDER; -import static ghidra.program.model.data.TranslationSettingsDefinition.TRANSLATION; - -import java.nio.charset.CoderResult; +import static ghidra.program.model.data.CharsetSettingsDefinition.*; +import static ghidra.program.model.data.RenderUnicodeSettingsDefinition.*; +import static ghidra.program.model.data.TranslationSettingsDefinition.*; import ghidra.docking.settings.*; import ghidra.program.model.mem.MemBuffer; @@ -33,8 +31,6 @@ import ghidra.program.model.mem.MemBuffer; * {@link #AbstractStringDataType(String, String, String, String, String, String, String, DataType, StringLayoutEnum, DataTypeManager) * AbstractStringDataType.AbstractStringDataType(lots,of,params)} and the * {@link DataType#clone(DataTypeManager) } method. - *

                    - * */ abstract public class AbstractStringDataType extends BuiltIn implements Dynamic, DataTypeWithCharset { @@ -113,7 +109,6 @@ abstract public class AbstractStringDataType extends BuiltIn /** * Protected constructor used by derived types to provide all their datatype details. - *

                    * * @param name Name of this datatype * @param mnemonic Mnemonic of this datatype @@ -175,7 +170,6 @@ abstract public class AbstractStringDataType extends BuiltIn /** * Creates a new {@link StringDataInstance} using the bytes in the supplied MemBuffer and * options provided by this DataType. - *

                    * * @param buf the data. * @param settings the settings to use for the representation. diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/ArrayStringable.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/ArrayStringable.java index fcd3ead30f..81bc9625d9 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/ArrayStringable.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/ArrayStringable.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 @@ public interface ArrayStringable extends DataType { /** * For cases where an array of this type exists, determines if a String value * will be returned. - *

                    + * * @param settings * @return true if array of this type with the specified settings will return * a String value. @@ -88,7 +88,7 @@ public interface ArrayStringable extends DataType { /** * Get the ArrayStringable for a specified data type. Not used on an Array DataType, but * on Array's element's type. - *

                    + * * @param dt data type * @return ArrayStringable object, or null. */ diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/CharsetSettingsDefinition.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/CharsetSettingsDefinition.java index 2381d25487..c804adba0c 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/CharsetSettingsDefinition.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/CharsetSettingsDefinition.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. @@ -49,7 +49,6 @@ public class CharsetSettingsDefinition implements EnumSettingsDefinition { /** * Backward compatibility to map old MBCS (language_index, charset_index) tuples to a * simple charset_name value. - *

                    */ private static Map> languageToCharsetIndexMap = new HashMap<>(); diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/CompositeInternal.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/CompositeInternal.java index 03090b76df..6f88bf81c3 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/CompositeInternal.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/CompositeInternal.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. @@ -139,7 +139,6 @@ public interface CompositeInternal extends Composite { * OrdinalComparator provides ability to compare an Integer ordinal with a * DataTypeComponent object. The ordinal will be consider equal (0) if the component corresponds * to the specified ordinal. - *

                    */ public static class OrdinalComparator implements Comparator { diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/DataTypeManager.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/DataTypeManager.java index 395ece69da..d2e725a171 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/DataTypeManager.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/DataTypeManager.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. @@ -389,7 +389,6 @@ public interface DataTypeManager { /** * Performs the given callback inside of a transaction. Use this method in place of the more * verbose try/catch/finally semantics. - *

                    *

                     	 * program.withTransaction("My Description", () -> {
                     	 * 	// ... Do something
                    @@ -419,7 +418,6 @@ public interface DataTypeManager {
                     	/**
                     	 * Calls the given supplier inside of a transaction.  Use this method in place of the more
                     	 * verbose try/catch/finally semantics.
                    -	 * 

                    *

                     	 * program.withTransaction("My Description", () -> {
                     	 * 	// ... Do something
                    diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/LEB128.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/LEB128.java
                    index 820627b273..c60284d3ba 100644
                    --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/LEB128.java
                    +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/LEB128.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.
                    @@ -71,7 +71,7 @@ public class LEB128 {
                     	 * 'long' type, which is signed.  It is up to the caller to treat the value as unsigned.
                     	 * 

                    * Large integers that use more than 64 bits will cause an IOException to be thrown. - *

                    + * * @param is {@link InputStream} to get bytes from * @param isSigned true if the value is signed * @return long integer value. Caller must treat it as unsigned if isSigned parameter was diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/PascalString255DataType.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/PascalString255DataType.java index 9c96624d63..02e4c1dcad 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/PascalString255DataType.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/PascalString255DataType.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. @@ -19,7 +19,6 @@ package ghidra.program.model.data; * A length-prefixed string {@link DataType} (max 255 bytes) with char size of 1 byte, * user setable {@link CharsetSettingsDefinition charset} (default ASCII), * unbounded (ignores containing field size, relies on embedded length value). - *

                    */ public class PascalString255DataType extends AbstractStringDataType { diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/PascalStringDataType.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/PascalStringDataType.java index c9b151a149..23ea380275 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/PascalStringDataType.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/PascalStringDataType.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. @@ -19,7 +19,6 @@ package ghidra.program.model.data; * A length-prefixed string {@link DataType} (max 64k bytes) with char size of 1 byte, * user setable {@link CharsetSettingsDefinition charset} (default ASCII), * unbounded (ignores containing field size, relies on embedded length value). - *

                    */ public class PascalStringDataType extends AbstractStringDataType { diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/PascalUnicodeDataType.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/PascalUnicodeDataType.java index 5c8cd770e9..a51d32b914 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/PascalUnicodeDataType.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/PascalUnicodeDataType.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. @@ -19,7 +19,6 @@ package ghidra.program.model.data; * A length-prefixed string {@link DataType} (max 64k bytes) with char size of 2 bytes, * {@link CharsetSettingsDefinition UTF-16} charset, unbounded * (ignores containing field size, relies on embedded length value). - *

                    */ public class PascalUnicodeDataType extends AbstractStringDataType { diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringDataInstance.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringDataInstance.java index 5994f07b63..0faa9d09df 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringDataInstance.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringDataInstance.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. @@ -42,7 +42,6 @@ import ghidra.util.*; * bytes in the membuffer into a java native String, and converting the raw String into a formatted * human-readable version, according to the various {@link SettingsDefinition}s attached to the * string data location. - *

                    */ public class StringDataInstance { @@ -72,7 +71,6 @@ public class StringDataInstance { *

                    * Arrays of char-like elements (see {@link ArrayStringable}) are treated as string data types. * The actual data instance needs to be inspected to determine if the array is an actual string. - *

                    * * @param dt DataType to test * @return boolean true if data type is or could be a string @@ -103,7 +101,6 @@ public class StringDataInstance { /** * Returns a string representation of the character(s) contained in the byte array, suitable for * display as a single character, or as a sequence of characters. - *

                    * * @param dataType the {@link DataType} of the element containing the bytes (most likely a * ByteDataType) @@ -150,7 +147,6 @@ public class StringDataInstance { /** * Returns a new {@link StringDataInstance} using the bytes in the data codeunit. - *

                    * * @param data {@link Data} item * @return new {@link StringDataInstance}, never NULL. See {@link #NULL_INSTANCE}. @@ -176,7 +172,6 @@ public class StringDataInstance { /** * Returns a new {@link StringDataInstance} using the bytes in the MemBuffer. - *

                    * * @param dataType {@link DataType} of the bytes in the buffer. * @param buf memory buffer containing the bytes. @@ -907,7 +902,6 @@ public class StringDataInstance { * Returns the value of the stored * {@link TranslationSettingsDefinition#getTranslatedValue(Data) translated settings} * string. - *

                    * * @return previously translated string. */ @@ -928,7 +922,6 @@ public class StringDataInstance { /** * Convert a char value (or sequence of char values) in memory into its canonical unicode * representation, using attached charset and encoding information. - *

                    * * @return String containing the representation of the char. */ @@ -988,7 +981,6 @@ public class StringDataInstance { * {@code byteOffset} from the start of this instance. *

                    * If the requested offset is not valid, StringDataInstance.NULL_INSTANCE is returned. - *

                    * * @param byteOffset number of bytes from start of data instance to start new instance. * @return new StringDataInstance, or StringDataInstance.NULL_INSTANCE if @@ -1011,7 +1003,6 @@ public class StringDataInstance { /** * Create a new {@link StringDataInstance} that points to a portion of this instance, starting * at a character offset (whereever that may be) into the data. - *

                    * * @param offsetChars number of characters from the beginning of the string to start the new * StringDataInstance. @@ -1056,7 +1047,6 @@ public class StringDataInstance { * this type of data. *

                    * I dare myself to type Type one more time. - *

                    * * @return {@link DataType}, defaulting to {@link StringDataType} if no direct match found. */ diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringRenderBuilder.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringRenderBuilder.java index 7106f75ccc..fe8cddd1ab 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringRenderBuilder.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringRenderBuilder.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. @@ -250,7 +250,7 @@ public class StringRenderBuilder { /** * Example (quotes are part of result): {@code "Test\tstring",01,02,"Second\npart",00} - *

                    + * * @return Formatted string */ @Override diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringUTF8DataType.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringUTF8DataType.java index 6069bd3913..8b540b2a8f 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringUTF8DataType.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringUTF8DataType.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. @@ -17,7 +17,6 @@ package ghidra.program.model.data; /** * A fixed-length UTF-8 string {@link DataType}. - *

                    */ public class StringUTF8DataType extends AbstractStringDataType { public static final StringUTF8DataType dataType = new StringUTF8DataType(); diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/Structure.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/Structure.java index 8e363bb0d4..41b896873d 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/Structure.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/Structure.java @@ -195,7 +195,6 @@ public interface Structure extends Composite { * Zero length bitfields may be inserted although they have no real affect when packing disabled. * Only the resulting byte offset within the structure is of significance in * determining its ordinal placement. - *

                    * * @param byteOffset the first byte offset within this structure which corresponds to the first * byte of the specified storage unit identified by its byteWidth. diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/TerminatedStringDataType.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/TerminatedStringDataType.java index 917f202405..be62b6a1cd 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/TerminatedStringDataType.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/TerminatedStringDataType.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,7 +18,6 @@ package ghidra.program.model.data; /** * A null-terminated string {@link DataType} with a user setable * {@link CharsetSettingsDefinition charset} (default ASCII). - *

                    */ public class TerminatedStringDataType extends AbstractStringDataType { diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/TerminatedUnicode32DataType.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/TerminatedUnicode32DataType.java index 1e0b523dc2..d8a4da322c 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/TerminatedUnicode32DataType.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/TerminatedUnicode32DataType.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. @@ -17,7 +17,6 @@ package ghidra.program.model.data; /** * A null-terminated UTF-32 string {@link DataType}. - *

                    */ public class TerminatedUnicode32DataType extends AbstractStringDataType { diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/Unicode32DataType.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/Unicode32DataType.java index 55efb2fadd..e16bd559da 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/Unicode32DataType.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/Unicode32DataType.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. @@ -17,7 +17,6 @@ package ghidra.program.model.data; /** * A fixed-length UTF-32 string {@link DataType}. - *

                    */ public class Unicode32DataType extends AbstractStringDataType { diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/UnicodeDataType.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/UnicodeDataType.java index 199c73a945..6a92374ddc 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/UnicodeDataType.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/UnicodeDataType.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. @@ -17,7 +17,6 @@ package ghidra.program.model.data; /** * A fixed-length UTF-16 string {@link DataType}. - *

                    */ public class UnicodeDataType extends AbstractStringDataType { diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/InsufficientBytesException.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/InsufficientBytesException.java index 4b8bca53cc..eef852dc45 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/InsufficientBytesException.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/InsufficientBytesException.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,7 +25,7 @@ import ghidra.util.exception.UsrException; */ public class InsufficientBytesException extends UsrException { /** - *

                    Constructs an InsufficientBytesException with a default message.

                    + *

                    Constructs an InsufficientBytesException with a default message. */ public InsufficientBytesException() { super("Not enough bytes available to parse a legal instruction"); @@ -34,7 +33,7 @@ public class InsufficientBytesException extends UsrException { /** *

                    Constructs an InsufficientBytesException with the specified - * detail message.

                    + * detail message. * * @param message The message. */ diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/UnknownContextException.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/UnknownContextException.java index 434f51855c..40433bb558 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/UnknownContextException.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/UnknownContextException.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,15 +25,14 @@ import ghidra.util.exception.UsrException; */ public class UnknownContextException extends UsrException { /** - *

                    Constructs an UnknownContextException with a default message.

                    + * Constructs an UnknownContextException with a default message. */ public UnknownContextException() { super("The current processor state is not known for constructing a legal instruction."); } /** - *

                    Constructs an UnknownContextException with the specified - * detail message.

                    + * Constructs an UnknownContextException with the specified detail message. * * @param message The message. */ diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/UnknownDataException.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/UnknownDataException.java index fa29fed99e..cdd845638a 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/UnknownDataException.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/UnknownDataException.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,7 +25,7 @@ import ghidra.util.exception.UsrException; */ public class UnknownDataException extends UsrException { /** - *

                    Constructs an UnknownDataException with a default message.

                    + *

                    Constructs an UnknownDataException with a default message. */ public UnknownDataException() { super("Bytes do not form a legal data item."); @@ -34,7 +33,7 @@ public class UnknownDataException extends UsrException { /** *

                    Constructs an UnknownDataException with the specified - * detail message.

                    + * detail message. * * @param message The message. */ diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/UnknownInstructionException.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/UnknownInstructionException.java index 8ad441bdd9..744da8840c 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/UnknownInstructionException.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/UnknownInstructionException.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,7 +25,7 @@ import ghidra.util.exception.UsrException; */ public class UnknownInstructionException extends UsrException { /** - *

                    Constructs an InsufficientBytesException with a default message.

                    + *

                    Constructs an InsufficientBytesException with a default message. */ public UnknownInstructionException() { super("Bytes do not form a legal instruction."); @@ -34,7 +33,7 @@ public class UnknownInstructionException extends UsrException { /** *

                    Constructs an InsufficientBytesException with the specified - * detail message.

                    + * detail message. * * @param message The message. */ diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/ContextChangeException.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/ContextChangeException.java index 6b36d84e63..2878f1e7cc 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/ContextChangeException.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/ContextChangeException.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. @@ -24,7 +23,7 @@ import ghidra.util.exception.UsrException; */ public class ContextChangeException extends UsrException { /** - *

                    Constructs an ContextChangeException with no detail message.

                    + *

                    Constructs an ContextChangeException with no detail message. */ public ContextChangeException() { super(); @@ -32,7 +31,7 @@ public class ContextChangeException extends UsrException { /** *

                    Constructs an ContextChangeException with the specified - * detail message.

                    + * detail message. * * @param message The message. */ diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Function.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Function.java index 96f5a84c67..6e24ed6ea0 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Function.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Function.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. @@ -63,9 +63,6 @@ public interface Function extends Namespace { * of these parameters. */ DYNAMIC_STORAGE_FORMAL_PARAMS, - /** - * - */ /** * All parameters and return have been specified without storage. * Storage will be computed. Any use of the reserved names 'this' and diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Group.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Group.java index 425c16aa42..102352ef34 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Group.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Group.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. @@ -55,7 +55,7 @@ public interface Group { public void setName(String name) throws DuplicateNameException; /** - * Returns whether this fragment contains the given code unit.

                    + * Returns whether this fragment contains the given code unit. * * @param codeUnit the code unit being tested. * diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Listing.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Listing.java index ac5407e6a8..e299391049 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Listing.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Listing.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. @@ -209,7 +209,6 @@ public interface Listing { * to the next method. An initial call to the previous * method would return the code unit with an address less than the specified * address. - *

                    * * @param addr the start address of the iterator. * @param forward true means get iterator in forward direction @@ -285,7 +284,6 @@ public interface Listing { * to the next method. An initial call to the previous * method would return the instruction with an address less than the * specified address. - *

                    * * @param addr the initial position of the iterator * @param forward true means get iterator in forward direction @@ -359,7 +357,6 @@ public interface Listing { * first Data that would be returned by an initial call to the next * method. An initial call to the previous method would return the * Data with an address less than the specified address. - *

                    * * @param addr the initial position of the iterator * @param forward true means get iterator in forward direction @@ -438,7 +435,6 @@ public interface Listing { * call to the next method. An initial call to the * previous method would return the defined Data with an address * less than the specified address. - *

                    * * @param addr the initial position of the iterator * @param forward true means get iterator in forward direction @@ -735,7 +731,6 @@ public interface Listing { /** * Returns the fragment containing the given address. - *

                    * * @param treeName name of the tree to search * @param addr the address that is contained within a fragment. @@ -746,7 +741,6 @@ public interface Listing { /** * Returns the module with the given name. - *

                    * * @param treeName name of the tree to search * @param name the name of the module to find. @@ -757,7 +751,6 @@ public interface Listing { /** * Returns the fragment with the given name. - *

                    * * @param treeName name of the tree to search * @param name the name of the fragment to find. diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/ProgramFragment.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/ProgramFragment.java index 83aef68899..a340802d1d 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/ProgramFragment.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/ProgramFragment.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. @@ -33,7 +33,7 @@ import ghidra.util.exception.NotFoundException; public interface ProgramFragment extends Group, AddressSetView { /** - * Returns whether this fragment contains the given code unit.

                    + * Returns whether this fragment contains the given code unit. * * @param codeUnit the code unit being tested. * @@ -51,10 +51,10 @@ public interface ProgramFragment extends Group, AddressSetView { * Note that min must the starting address of a code unit * and max must be the ending address of a code unit. * Furthermore every address in the given range must exist in program - * memory.

                    + * memory. * * @param min min address of range specifying the code units to move - * @param max max address of range specifying the code units to move + * @param max max address of range specifying the code units to move * @exception NotFoundException thrown if any address between min * and max (inclusive) does not belong to program memory. */ diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/ProgramModule.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/ProgramModule.java index 8173a748f0..d7773e2c3b 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/ProgramModule.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/ProgramModule.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. @@ -70,7 +70,7 @@ public interface ProgramModule extends Group { /** * Adds the given module as a child of this module. - *

                    + * * @param module the module to be added. * @throws CircularDependencyException thrown if the module being * added is an ancestor of this module. The module structure of @@ -83,7 +83,7 @@ public interface ProgramModule extends Group { /** * Adds the given fragment as a child of this module. - *

                    + * * @exception DuplicateGroupException thrown if the fragment being * added is already a child of this module. */ @@ -92,7 +92,7 @@ public interface ProgramModule extends Group { /** * Creates a new module and makes it a child of this - * module.

                    + * module. * * @param moduleName the name to use for the new module. * @@ -103,7 +103,7 @@ public interface ProgramModule extends Group { public ProgramModule createModule(String moduleName)throws DuplicateNameException; /** - * Creates a new fragment and makes it a child of this module.

                    + * Creates a new fragment and makes it a child of this module. * * @param fragmentName the name to use for the new fragment. * @@ -126,7 +126,7 @@ public interface ProgramModule extends Group { /** * Changes the ordering of this module's children by moving - * the child with the given name to position given by index.

                    + * the child with the given name to position given by index. * * @param name the name of the child to move. * @param index the index to move it to. @@ -145,7 +145,8 @@ public interface ProgramModule extends Group { /** * Returns whether the given module is a descendant of this - * module.

                    + * module. + * * @param module the module to check. * * @return true if the module is a descendant, false otherwise. @@ -154,7 +155,8 @@ public interface ProgramModule extends Group { /** * Returns whether the given fragment is a descendant of this - * module.

                    + * module. + * * @param fragment the fragment to check. * * @return true if the fragment is a descendant, false otherwise. @@ -165,7 +167,7 @@ public interface ProgramModule extends Group { * Returns the minimum address of this module which will be the minimum * address from the set of all fragments which are descendants of this * module. - *

                    + * * @return the minimum address, this will be null if all of the module's * descendant fragments are empty. */ @@ -175,7 +177,7 @@ public interface ProgramModule extends Group { * Returns the maximum address of this module which will be the maximum * address from the set of all fragments which are descendants of this * module. - *

                    + * * @return the maximum address, this will be null if all of the module's * descendant fragments are empty. */ @@ -186,7 +188,7 @@ public interface ProgramModule extends Group { * address of the first descendant fragment which is non-empty. In other * words this returns the first address for this module as defined by * the user ordering of the module's children. - *

                    + * * @return the first address, this will be null if all of the module's * descendant fragments are empty. */ @@ -197,7 +199,7 @@ public interface ProgramModule extends Group { * of the last descendant fragment which is non-empty. In other words this * returns the last address for this module as defined by the user * ordering of the module's children. - *

                    + * * @return the last address, this will be null if all of the module's * descendant fragments are empty. */ diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/StackFrame.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/StackFrame.java index d14038723d..236c0b68de 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/StackFrame.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/StackFrame.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. @@ -34,7 +33,7 @@ import ghidra.util.exception.InvalidInputException; * information (return address, saved registers, etc...). A frame is said to * grow negative if the parameters are referenced with negative offsets from 0, * or positive if the parameters are referenced with negative offsets from 0. - *

                    + * 
                      *
                      *
                      *  Negative Growth
                    diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/StackVariableComparator.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/StackVariableComparator.java
                    index b1e1f5b032..83f21712ac 100644
                    --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/StackVariableComparator.java
                    +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/StackVariableComparator.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.
                    @@ -31,7 +30,7 @@ public class StackVariableComparator implements Comparator {
                     	 * a StackVariable.
                     	 * @param obj1 a StackVariable or Integer
                     	 * @param obj2 a StackVariable or Integer
                    -	 * 

                    + * * @return a negative integer, zero, or a positive integer * if the first argument is less than, equal to, or greater than the second. */ diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/VariableStorage.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/VariableStorage.java index ed45116e23..94ab195608 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/VariableStorage.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/VariableStorage.java @@ -26,7 +26,7 @@ import ghidra.program.util.LanguageTranslator; import ghidra.util.exception.InvalidInputException; /** - * encapsulates the ordered list of storage varnodes which correspond to a + * Encapsulates the ordered list of storage varnodes which correspond to a * function parameter or local variable. For big-endian the first element corresponds * to the most-significant varnode, while for little-endian the first element * corresponds to the least-significant varnode. diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/mem/Memory.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/mem/Memory.java index bbb4afc6f7..a1fdf4cc6d 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/mem/Memory.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/mem/Memory.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. @@ -55,7 +55,6 @@ import ghidra.util.task.TaskMonitor; * memory region where a mapped byte has a value of 0 or 1 only. Byte read/write operations are * passed-through to the corresponding bit within the mapped region. * - *

                    *

                    * Overlay Blocks * An overlay memory block provides the ability to define alternate content for a physical memory diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/mem/MemoryAccessException.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/mem/MemoryAccessException.java index ab87039df8..c64a258ff4 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/mem/MemoryAccessException.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/mem/MemoryAccessException.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. @@ -25,18 +25,18 @@ import ghidra.util.exception.UsrException; public class MemoryAccessException extends UsrException { /** - *

                    Constructs an MemoryAccessException with no detail message.

                    - */ + *

                    Constructs an MemoryAccessException with no detail message. + */ public MemoryAccessException() { super(); } /** - *

                    Constructs an MemoryAccessException with the specified - * detail message.

                    - * - * @param message The message. - */ + *

                    Constructs an MemoryAccessException with the specified + * detail message. + * + * @param message The message. + */ public MemoryAccessException(String message) { super(message); } diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/scalar/ScalarOverflowException.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/scalar/ScalarOverflowException.java index d80f9934a7..b6d97a86a8 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/scalar/ScalarOverflowException.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/scalar/ScalarOverflowException.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. @@ -27,18 +26,18 @@ package ghidra.program.model.scalar; public class ScalarOverflowException extends RuntimeException { /** - *

                    Constructs a ScalarOverflowException with no detail message.

                    - */ + *

                    Constructs a ScalarOverflowException with no detail message. + */ public ScalarOverflowException() { super("Scalar overflow"); } /** - *

                    Constructs a ScalarOverflowException with the specified - * detail message.

                    - * - * @param message The message. - */ + *

                    Constructs a ScalarOverflowException with the specified + * detail message. + * + * @param message The message. + */ public ScalarOverflowException(String message) { super(message); } diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/util/PropertyMap.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/util/PropertyMap.java index 8665196690..0e6a47e2f8 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/util/PropertyMap.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/util/PropertyMap.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,8 @@ public interface PropertyMap { /** * Given two addresses, indicate whether there is an address in - * that range (inclusive) having the property.

                    + * that range (inclusive) having the property. + * * @param start the start of the range. * @param end the end of the range. * @@ -47,9 +48,9 @@ public interface PropertyMap { /** * Indicate whether there is an address within - * the set which exists within this map.

                    + * the set which exists within this map. + * * @param set set of addresses - * * @return boolean true if at least one address in the set * has the property, false otherwise. */ diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/FunctionReturnTypeFieldLocation.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/FunctionReturnTypeFieldLocation.java index f258e36a58..8caf69ed03 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/FunctionReturnTypeFieldLocation.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/FunctionReturnTypeFieldLocation.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. @@ -60,7 +60,8 @@ public class FunctionReturnTypeFieldLocation extends FunctionSignatureFieldLocat } /** - * Construct a new FunctionReturnTypeFieldLocation object that is field based.

                    + * Construct a new FunctionReturnTypeFieldLocation object that is field based. + * * @param program the program of the location * @param functionAddr the function address * @param returnType the function return type String at this location. diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/FunctionSignatureFieldLocation.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/FunctionSignatureFieldLocation.java index 9116b83b38..9e40739e91 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/FunctionSignatureFieldLocation.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/FunctionSignatureFieldLocation.java @@ -31,10 +31,10 @@ public class FunctionSignatureFieldLocation extends FunctionLocation { private String signature; /** - * When true the charOffset is not used to represent character position, but + * When true the {@code charOffset} is not used to represent character position, but * rather the character position is based upon the location of the subfield within the * signature. For example, the start of the function name location may be the character - * position when this flag is true. + * position when this flag is {@code true}. */ private boolean isFieldBasedPoisitioning; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/LabelFieldLocation.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/LabelFieldLocation.java index 95344dccc7..a3299ca8c1 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/LabelFieldLocation.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/LabelFieldLocation.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. @@ -75,7 +75,8 @@ public class LabelFieldLocation extends CodeUnitLocation { } /** - * Construct a new LabelFieldLocation.

                    + * Construct a new LabelFieldLocation. + * * @param program the program of the location. * @param addr address of the location; should not be null * @param label the label String at this location. diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/RegisterFieldLocation.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/RegisterFieldLocation.java index ea0cda6d9a..9145905cce 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/RegisterFieldLocation.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/RegisterFieldLocation.java @@ -4,27 +4,25 @@ * 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. * See the License for the specific language governing permissions and * limitations under the License. */ -/** - * - */ + package ghidra.program.util; +import java.util.Arrays; + import ghidra.framework.options.SaveState; import ghidra.program.model.address.Address; import ghidra.program.model.lang.Register; import ghidra.program.model.listing.Program; -import java.util.Arrays; - /** * ProgramLocation for the Register Field. * diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/RegisterTransitionFieldLocation.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/RegisterTransitionFieldLocation.java index 77b44085f9..eb871a78c5 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/RegisterTransitionFieldLocation.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/RegisterTransitionFieldLocation.java @@ -4,18 +4,16 @@ * 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. * See the License for the specific language governing permissions and * limitations under the License. */ -/** - * - */ + package ghidra.program.util; import ghidra.framework.options.SaveState; diff --git a/Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/program/database/data/UnionDBTest.java b/Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/program/database/data/UnionDBTest.java index fa791969e6..94308bfaa5 100644 --- a/Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/program/database/data/UnionDBTest.java +++ b/Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/program/database/data/UnionDBTest.java @@ -25,9 +25,6 @@ import generic.test.AbstractGenericTest; import ghidra.program.model.data.*; import ghidra.util.task.TaskMonitor; -/** - * - */ public class UnionDBTest extends AbstractGenericTest { private StandAloneDataTypeManager dataMgr; diff --git a/Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/program/model/util/PropertyMapTest.java b/Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/program/model/util/PropertyMapTest.java index 06612c7620..f19025ef84 100644 --- a/Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/program/model/util/PropertyMapTest.java +++ b/Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/program/model/util/PropertyMapTest.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. @@ -21,9 +21,6 @@ import org.junit.Test; import generic.test.AbstractGenericTest; import ghidra.program.model.address.*; -/** - * - */ public class PropertyMapTest extends AbstractGenericTest { AddressSpace space = new GenericAddressSpace("MEM", 32, AddressSpace.TYPE_RAM, 0); diff --git a/Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/sleigh/grammar/FileSearcher.java b/Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/sleigh/grammar/FileSearcher.java index e9a4f25d9a..ef6c7fb601 100644 --- a/Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/sleigh/grammar/FileSearcher.java +++ b/Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/sleigh/grammar/FileSearcher.java @@ -4,18 +4,15 @@ * 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. * See the License for the specific language governing permissions and * limitations under the License. */ -/** - * - */ package ghidra.sleigh.grammar; import java.io.File; diff --git a/Ghidra/Framework/Utility/src/main/java/ghidra/util/NullOutputStream.java b/Ghidra/Framework/Utility/src/main/java/ghidra/util/NullOutputStream.java index 3a96008aed..234ba2bb6f 100644 --- a/Ghidra/Framework/Utility/src/main/java/ghidra/util/NullOutputStream.java +++ b/Ghidra/Framework/Utility/src/main/java/ghidra/util/NullOutputStream.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. @@ -20,7 +20,6 @@ import java.io.OutputStream; /** * A {@link OutputStream} that discards all bytes written to it. - *

                    */ public class NullOutputStream extends OutputStream { 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 b805d279c5..892421dc15 100644 --- a/Ghidra/Framework/Utility/src/main/java/ghidra/util/UserSearchUtils.java +++ b/Ghidra/Framework/Utility/src/main/java/ghidra/util/UserSearchUtils.java @@ -230,7 +230,6 @@ public class UserSearchUtils { * match exactly the given input string. *

                    * This method can be used with {@link Matcher#matches()} or {@link Matcher#find()}. - *

                    * * @param input * the string that you want to your matched strings to exactly match. @@ -261,7 +260,6 @@ public class UserSearchUtils { * all strings that match the given input string. *

                    * This method can be used with {@link Matcher#matches()} or {@link Matcher#find()}. - *

                    * * @param input * the string that you want to your matched strings to exactly match. diff --git a/Ghidra/Framework/Utility/src/main/java/utilities/util/FileUtilities.java b/Ghidra/Framework/Utility/src/main/java/utilities/util/FileUtilities.java index ae5b6c6826..43a513a0f8 100644 --- a/Ghidra/Framework/Utility/src/main/java/utilities/util/FileUtilities.java +++ b/Ghidra/Framework/Utility/src/main/java/utilities/util/FileUtilities.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. @@ -298,7 +298,6 @@ public final class FileUtilities { *

                    * Takes into account race conditions with external threads/processes * creating the same directory at the same time. - *

                    * * @param dir The directory to create. * @return True If the directory exists when this method completes; otherwise, false. @@ -347,7 +346,7 @@ public final class FileUtilities { *

                    * Takes into account race conditions with external threads/processes * creating the same directory at the same time. - *

                    + * * @param dir The directory to create. * @return a reference to the same {@link File} instance that was passed in. * @throws IOException if there was a failure when creating the directory (ie. the @@ -368,7 +367,6 @@ public final class FileUtilities { *

                    * Uses {@link #createDir(File)} to create new directories (which handles * race conditions if other processes are also trying to create the same directory). - *

                    * * @param dir directory path to be created * @return a reference to the same {@link File} instance that was passed in. @@ -681,7 +679,7 @@ public final class FileUtilities { * Returns all of the lines in the file without any newline characters. *

                    * The file is treated as UTF-8 encoded. - *

                    + * * @param file The text file to read in * @return a list of file lines * @throws IOException if an error occurs reading the file @@ -717,7 +715,7 @@ public final class FileUtilities { * Returns all of the lines in the BufferedReader without any newline characters. *

                    * The file is treated as UTF-8 encoded. - *

                    + * * @param url the input stream from which to read * @return a list of file lines * @throws IOException thrown if there was a problem accessing the files @@ -731,7 +729,6 @@ public final class FileUtilities { /** * Returns all of the lines in the given {@link InputStream} without any newline characters. - *

                    * * @param is the input stream from which to read * @return a {@link List} of strings representing the text lines of the file @@ -745,7 +742,7 @@ public final class FileUtilities { * Returns all of the text in the given {@link InputStream}. *

                    * EOL characters are normalized to simple '\n's. - *

                    + * * @param is the input stream from which to read * @return the content as a String * @throws IOException if there are any issues reading the file @@ -764,7 +761,7 @@ public final class FileUtilities { * Returns all of the text in the given {@link File}. *

                    * See {@link #getText(InputStream)} - *

                    + * * @param f the file to read * @return the content as a String * @throws IOException if there are any issues reading the file or file is too large. @@ -1075,7 +1072,7 @@ public final class FileUtilities { *

                    * Querying a filepath that does not exist will result in a 'success' and the caller will * receive the non-existent File instance back. - *

                    + * * @param caseSensitiveFile {@link File} to enforce case-sensitive-ness of the name portion * @return the same {@link File} instance if it points to a file on the filesystem with * the same case, or a NULL if the case does not match. @@ -1114,7 +1111,7 @@ public final class FileUtilities { * If no file is found that matches, the original File instance is returned. *

                    * See also {@link #existsAndIsCaseDependent(ResourceFile)}. - *

                    + * * @param f File instance * @return File instance pointing to a case-insensitive match of the File parameter */ @@ -1158,7 +1155,6 @@ public final class FileUtilities { * Returns the size of the given file as a human readable String. *

                    * See {@link #formatLength(long)} - *

                    * * @param file the file for which to get size * @return the pretty string diff --git a/Ghidra/Processors/ARM/src/main/java/ghidra/app/util/bin/format/coff/relocation/ARM_CoffRelocationHandler.java b/Ghidra/Processors/ARM/src/main/java/ghidra/app/util/bin/format/coff/relocation/ARM_CoffRelocationHandler.java index 4563d95ed9..ee8c335e34 100644 --- a/Ghidra/Processors/ARM/src/main/java/ghidra/app/util/bin/format/coff/relocation/ARM_CoffRelocationHandler.java +++ b/Ghidra/Processors/ARM/src/main/java/ghidra/app/util/bin/format/coff/relocation/ARM_CoffRelocationHandler.java @@ -97,9 +97,6 @@ public class ARM_CoffRelocationHandler implements CoffRelocationHandler { */ public static final short IMAGE_REL_THUMB_BLX23 = 0x0015; - /** - * - */ public static final short IMAGE_REL_ARM_PAIR = 0x0016; @Override diff --git a/Ghidra/Processors/JVM/src/main/java/ghidra/javaclass/format/ClassFileJava.java b/Ghidra/Processors/JVM/src/main/java/ghidra/javaclass/format/ClassFileJava.java index 896e13afad..390e5731c1 100644 --- a/Ghidra/Processors/JVM/src/main/java/ghidra/javaclass/format/ClassFileJava.java +++ b/Ghidra/Processors/JVM/src/main/java/ghidra/javaclass/format/ClassFileJava.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. @@ -136,7 +136,7 @@ public class ClassFileJava implements StructConverter { *

                    * A Java virtual machine implementation can support a class file format of * version v if and only if v lies in some contiguous range Mi.0 ? v ? Mj.m. - *

                    + * * @return the minor version number of this class. */ public short getMinorVersion() { @@ -153,7 +153,7 @@ public class ClassFileJava implements StructConverter { *

                    * A Java virtual machine implementation can support a class file format of * version v if and only if v lies in some contiguous range Mi.0 ? v ? Mj.m. - *

                    + * * @return the major version number of this class. */ public short getMajorVersion() { diff --git a/Ghidra/Processors/JVM/src/main/java/ghidra/javaclass/format/attributes/BootstrapMethods.java b/Ghidra/Processors/JVM/src/main/java/ghidra/javaclass/format/attributes/BootstrapMethods.java index 5cd3f1fefc..3e9003c2f3 100644 --- a/Ghidra/Processors/JVM/src/main/java/ghidra/javaclass/format/attributes/BootstrapMethods.java +++ b/Ghidra/Processors/JVM/src/main/java/ghidra/javaclass/format/attributes/BootstrapMethods.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. @@ -25,7 +25,6 @@ import ghidra.util.exception.DuplicateNameException; /** * * NOTE: THE COMMENT TEXT EXTRACTED FROM JVMS7.PDF - *

                    */ public class BootstrapMethods implements StructConverter { diff --git a/Ghidra/Processors/JVM/src/main/java/ghidra/javaclass/format/attributes/ExceptionHandlerJava.java b/Ghidra/Processors/JVM/src/main/java/ghidra/javaclass/format/attributes/ExceptionHandlerJava.java index ec2fc1f2f7..8219bbeed8 100644 --- a/Ghidra/Processors/JVM/src/main/java/ghidra/javaclass/format/attributes/ExceptionHandlerJava.java +++ b/Ghidra/Processors/JVM/src/main/java/ghidra/javaclass/format/attributes/ExceptionHandlerJava.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. @@ -24,8 +24,6 @@ import ghidra.util.exception.DuplicateNameException; /** * NOTE: THE FOLLOWING TEXT EXTRACTED FROM JVMS7.PDF - *

                    - * */ public class ExceptionHandlerJava implements StructConverter { private short startPC; diff --git a/Ghidra/Processors/JVM/src/main/java/ghidra/javaclass/format/constantpool/AbstractConstantPoolReferenceInfo.java b/Ghidra/Processors/JVM/src/main/java/ghidra/javaclass/format/constantpool/AbstractConstantPoolReferenceInfo.java index e031fc7aba..eb530ab319 100644 --- a/Ghidra/Processors/JVM/src/main/java/ghidra/javaclass/format/constantpool/AbstractConstantPoolReferenceInfo.java +++ b/Ghidra/Processors/JVM/src/main/java/ghidra/javaclass/format/constantpool/AbstractConstantPoolReferenceInfo.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,8 +23,6 @@ import ghidra.util.exception.DuplicateNameException; /** * NOTE: THE FOLLOWING TEXT EXTRACTED FROM JVMS7.PDF - *

                    - * */ public abstract class AbstractConstantPoolReferenceInfo extends AbstractConstantPoolInfoJava { @@ -51,7 +49,7 @@ public abstract class AbstractConstantPoolReferenceInfo extends AbstractConstant *

                    * The class_index item of a CONSTANT_Fieldref_info structure may be either * a class type or an interface type. - *

                    + * * @return a valid index into the constant_pool table */ public int getClassIndex() { @@ -72,7 +70,7 @@ public abstract class AbstractConstantPoolReferenceInfo extends AbstractConstant * with a '<' ('\u003c'), then the name must be the special name , * representing an instance initialization method. The return type of such * a method must be void. - *

                    + * * @return a valid index into the constant_pool table */ public int getNameAndTypeIndex() { diff --git a/Ghidra/Processors/tricore/src/main/java/ghidra/app/util/bin/format/elf/relocation/Tricore_ElfRelocationHandler.java b/Ghidra/Processors/tricore/src/main/java/ghidra/app/util/bin/format/elf/relocation/Tricore_ElfRelocationHandler.java index 0a69a4ca05..38fea3c0c0 100644 --- a/Ghidra/Processors/tricore/src/main/java/ghidra/app/util/bin/format/elf/relocation/Tricore_ElfRelocationHandler.java +++ b/Ghidra/Processors/tricore/src/main/java/ghidra/app/util/bin/format/elf/relocation/Tricore_ElfRelocationHandler.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. @@ -506,9 +506,6 @@ public class Tricore_ElfRelocationHandler return 2; } - /** - * - */ private int relocate_3POS(Memory memory, Address relocationAddress, long rv) throws MemoryAccessException { long mask = 0xfffffff8L; @@ -519,9 +516,6 @@ public class Tricore_ElfRelocationHandler return 4; } - /** - * - */ private int relocate_5POS(Memory memory, Address relocationAddress, long rv) throws MemoryAccessException { long mask = 0xffffffe0L; @@ -532,9 +526,6 @@ public class Tricore_ElfRelocationHandler return 4; } - /** - * - */ private int relocate_5POS2(Memory memory, Address relocationAddress, long rv) throws MemoryAccessException { long mask = 0xffffffe0L; diff --git a/Ghidra/Test/IntegrationTest/src/test.slow/java/ghidra/framework/main/SharedProjectUtil.java b/Ghidra/Test/IntegrationTest/src/test.slow/java/ghidra/framework/main/SharedProjectUtil.java index 2a76ed3a7b..8f85223a5a 100644 --- a/Ghidra/Test/IntegrationTest/src/test.slow/java/ghidra/framework/main/SharedProjectUtil.java +++ b/Ghidra/Test/IntegrationTest/src/test.slow/java/ghidra/framework/main/SharedProjectUtil.java @@ -13,9 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -/** - * - */ + package ghidra.framework.main; import static org.junit.Assert.*; diff --git a/Ghidra/Test/IntegrationTest/src/test.slow/java/ghidra/server/remote/ServerTestUtil.java b/Ghidra/Test/IntegrationTest/src/test.slow/java/ghidra/server/remote/ServerTestUtil.java index accabafa1c..661c2e3c35 100644 --- a/Ghidra/Test/IntegrationTest/src/test.slow/java/ghidra/server/remote/ServerTestUtil.java +++ b/Ghidra/Test/IntegrationTest/src/test.slow/java/ghidra/server/remote/ServerTestUtil.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. @@ -51,9 +51,6 @@ import ghidra.util.task.TaskMonitor; import ghidra.util.timer.GTimer; import utilities.util.FileUtilities; -/** - * - */ public class ServerTestUtil { public static final int GHIDRA_TEST_SERVER_PORT = 14100; diff --git a/gradle/root/distribution.gradle b/gradle/root/distribution.gradle index 046e2fec84..895522d04c 100644 --- a/gradle/root/distribution.gradle +++ b/gradle/root/distribution.gradle @@ -120,13 +120,25 @@ task createJavadocs(type: Javadoc, description: 'Generate javadocs for all proje // find referenced classes. classpath = rootProject.ext.ghidraPath - // generate documentation using html5 + // Generate documentation using html5 options.addBooleanOption("html5", true) - options.addBooleanOption('Xdoclint:none', true) + // Control what warnings appear + options.addBooleanOption('Xdoclint:html', true) + options.addBooleanOption('Xdoclint:syntax', true) + options.addBooleanOption('Xdoclint:reference', true) + //options.addBooleanOption('Xdoclint:accessibility', true) + //options.addBooleanOption('Xdoclint:missing', true) // Some internal packages are not public and need to be exported. options.addMultilineStringsOption("-add-exports").setValue(["java.desktop/sun.awt=ALL-UNNAMED"]) + + // Have to manually add these in for some reason + options.tags = [ + 'apiNote:a:API Notes:', + 'implSpec:a:Implementation Requirements:', + 'implNote:a:Implementation Notes:' + ] } @@ -209,7 +221,7 @@ task createPythonTypeStubs(type: Javadoc, description: 'Generate pyi stubs for a // Set the ghidra flag to enable the creation of the ghidra_builtins pseudo package options.addBooleanOption("ghidra", true) - + // Newer versions of gradle set this to true by default. // The JsonDoclet doesn't have the -notimestamp option so ensure it isn't set. options.setNoTimestamp(false)

      InputOutputRendered as(Without Friendly Encoding)