diff --git a/Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/gadp/DbgEngGadpServer.java b/Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/gadp/DbgEngGadpServer.java index ed4c51c613..fffa0c594c 100644 --- a/Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/gadp/DbgEngGadpServer.java +++ b/Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/gadp/DbgEngGadpServer.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -220,7 +220,7 @@ public interface DbgEngGadpServer extends AutoCloseable { * {@link #terminate()}, or 3) When an error occurs causing the server to terminate * unexpectedly. Otherwise, it returns true. * - * @returns true if the server is currently running. + * @return true if the server is currently running. */ public boolean isRunning(); diff --git a/Ghidra/Debug/Debugger-agent-frida/src/main/java/agent/frida/gadp/FridaGadpServer.java b/Ghidra/Debug/Debugger-agent-frida/src/main/java/agent/frida/gadp/FridaGadpServer.java index 04445b0a0a..5f61e8c381 100644 --- a/Ghidra/Debug/Debugger-agent-frida/src/main/java/agent/frida/gadp/FridaGadpServer.java +++ b/Ghidra/Debug/Debugger-agent-frida/src/main/java/agent/frida/gadp/FridaGadpServer.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -176,7 +176,7 @@ public interface FridaGadpServer extends AutoCloseable { * {@link #terminate()}, or 3) When an error occurs causing the server to terminate * unexpectedly. Otherwise, it returns true. * - * @returns true if the server is currently running. + * @return true if the server is currently running. */ public boolean isRunning(); diff --git a/Ghidra/Debug/Debugger-agent-lldb/src/main/java/agent/lldb/gadp/LldbGadpServer.java b/Ghidra/Debug/Debugger-agent-lldb/src/main/java/agent/lldb/gadp/LldbGadpServer.java index b1337318c0..6ada783934 100644 --- a/Ghidra/Debug/Debugger-agent-lldb/src/main/java/agent/lldb/gadp/LldbGadpServer.java +++ b/Ghidra/Debug/Debugger-agent-lldb/src/main/java/agent/lldb/gadp/LldbGadpServer.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -176,7 +176,7 @@ public interface LldbGadpServer extends AutoCloseable { * {@link #terminate()}, or 3) When an error occurs causing the server to terminate * unexpectedly. Otherwise, it returns true. * - * @returns true if the server is currently running. + * @return true if the server is currently running. */ public boolean isRunning(); diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/rust/demangler/RustDemanglerV0.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/rust/demangler/RustDemanglerV0.java index bfad6d6c6a..81d5d59bf1 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/rust/demangler/RustDemanglerV0.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/rust/demangler/RustDemanglerV0.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in 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,8 @@ import java.util.*; /** * A class that will demangle Rust symbols mangled according to the V0 format. This class * implements the grammar that will translate a mangled string into a demangled one. - * Documentation is {@link "https://rust-lang.github.io/rfcs/2603-rust-symbol-name-mangling-v0.html"} here. + * + * @see 2603-rust-symbol-name-mangling-v0.html */ public class RustDemanglerV0 { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/util/InstructionSearchUtils.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/util/InstructionSearchUtils.java index cf33207eff..c038593908 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/util/InstructionSearchUtils.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/util/InstructionSearchUtils.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -223,7 +223,7 @@ public class InstructionSearchUtils { } /** - * Peforms a bitwise & on the given arrays. + * Performs a bitwise AND on the given arrays. * * @param mask * @param bytes 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 8779b8249e..431feb3b6b 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 @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -181,9 +181,8 @@ public final class ReferenceUtils { * @throws CancelledException if the monitor is cancelled. * @deprecated use {@link #findDataTypeFieldReferences(Accumulator, FieldMatcher, Program, * boolean, TaskMonitor)}. - * @Deprecated(since = "10.2") */ - @Deprecated + @Deprecated(since = "10.2") public static void findDataTypeReferences(Accumulator accumulator, DataType dataType, String fieldName, Program program, TaskMonitor monitor) throws CancelledException { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/osgi/BundleHost.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/osgi/BundleHost.java index b7f6df0631..6633f6d332 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/osgi/BundleHost.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/osgi/BundleHost.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in 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,7 +72,7 @@ public class BundleHost { private List listeners = new CopyOnWriteArrayList<>(); /** - * If a {@link GhidraBundle} hasn't already been added for {@bundleFile}, add it now as a + * If a {@link GhidraBundle} hasn't already been added for {@code bundleFile}, add it now as a * non-system bundle. * *

Enable the bundle. diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/swift/SwiftUtils.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/swift/SwiftUtils.java index d7af019d79..6bb4ad673d 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/swift/SwiftUtils.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/swift/SwiftUtils.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in 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,10 +60,10 @@ public class SwiftUtils { } /** - * Checks if the given {@List} of section names contains a Swift section name + * Checks if the given {@link List} of section names contains a Swift section name * * @param sectionNames The {@link List} of section names to check - * @return True if the given {@List} of section names contains a Swift section name; otherwise, + * @return True if the given {@link List} of section names contains a Swift section name; otherwise, * false */ public static boolean isSwift(List sectionNames) { 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 929064a426..faac1d4020 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 @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in 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 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/FileFormats/src/main/java/ghidra/file/formats/android/art/ArtImageSectionsFactory.java b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/android/art/ArtImageSectionsFactory.java index 710fa6fa2d..8e9e9086bb 100644 --- a/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/android/art/ArtImageSectionsFactory.java +++ b/Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/android/art/ArtImageSectionsFactory.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in 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 final class ArtImageSectionsFactory { * this method will return the appropriate section one. * @param reader the binary reader for the ART file * @param artHeader the ART Header containing the sections - * @returns the ImageSections for the specified ART version + * @return the ImageSections for the specified ART version */ public static ArtImageSections getArtImageSections(BinaryReader reader, ArtHeader artHeader) throws IOException { diff --git a/Ghidra/Framework/DB/src/main/java/db/BTreeNode.java b/Ghidra/Framework/DB/src/main/java/db/BTreeNode.java index 171007cc8b..1c843c4550 100644 --- a/Ghidra/Framework/DB/src/main/java/db/BTreeNode.java +++ b/Ghidra/Framework/DB/src/main/java/db/BTreeNode.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -91,9 +91,8 @@ interface BTreeNode { * @return true if consistency check passed, else false * @param tableName name of table containing this node * @param monitor task monitor - * @throws IOException if IO error occured + * @throws IOException if IO error occurred * @throws CancelledException if task cancelled - * @{@link ThrowsTag} CancelledException */ public boolean isConsistent(String tableName, TaskMonitor monitor) throws IOException, CancelledException; diff --git a/Ghidra/Framework/DB/src/main/java/db/FixedKeyVarRecNode.java b/Ghidra/Framework/DB/src/main/java/db/FixedKeyVarRecNode.java index 3aae93e498..5f6569b2d4 100644 --- a/Ghidra/Framework/DB/src/main/java/db/FixedKeyVarRecNode.java +++ b/Ghidra/Framework/DB/src/main/java/db/FixedKeyVarRecNode.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -224,7 +224,7 @@ class FixedKeyVarRecNode extends FixedKeyRecordNode { /** * Find the index which represents the halfway point within the record data. - * @returns key index. + * @return key index. */ private int getSplitIndex() { diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/EmptyTextField.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/EmptyTextField.java index a0d7006016..8f578c46dd 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/EmptyTextField.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/EmptyTextField.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -56,7 +56,7 @@ public class EmptyTextField implements Field { /** * Returns true if the cursor is allowed past the last character. This * field always returns false since there is no text. - * @returns true if the cursor is allowed past the last character + * @return true if the cursor is allowed past the last character */ public boolean isAllowCursorAtEnd() { return false; diff --git a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/SleighInstructionDecoder.java b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/SleighInstructionDecoder.java index c494c90121..2271de0860 100644 --- a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/SleighInstructionDecoder.java +++ b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/SleighInstructionDecoder.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -56,10 +56,10 @@ public class SleighInstructionDecoder implements InstructionDecoder { /** * Construct a Sleigh instruction decoder * - * @see {@link DefaultPcodeThread#createInstructionDecoder(PcodeExecutorState)} * @param language the language to decoder * @param state the state containing the target program, probably the shared state of the p-code * machine. It must be possible to obtain concrete buffers on this state. + * @see DefaultPcodeThread#createInstructionDecoder(PcodeExecutorState) */ public SleighInstructionDecoder(Language language, PcodeExecutorState state) { this.language = language; diff --git a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/ThreadPcodeExecutorState.java b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/ThreadPcodeExecutorState.java index 75b6be335c..de88b6acfb 100644 --- a/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/ThreadPcodeExecutorState.java +++ b/Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/emu/ThreadPcodeExecutorState.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in 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,9 @@ public class ThreadPcodeExecutorState implements PcodeExecutorState { /** * Create a multiplexed state * - * @see {@link DefaultPcodeThread#DefaultPcodeThread(String, AbstractPcodeMachine)} * @param sharedState the shared part of the state * @param localState the thread-local part of the state + * @see DefaultPcodeThread#DefaultPcodeThread(String, AbstractPcodeMachine) */ public ThreadPcodeExecutorState(PcodeExecutorState sharedState, PcodeExecutorState localState) { diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/AbstractWeakValueMap.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/AbstractWeakValueMap.java index 25c03542d9..707ee9d763 100644 --- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/AbstractWeakValueMap.java +++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/AbstractWeakValueMap.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -308,17 +308,20 @@ public abstract class AbstractWeakValueMap implements Map { /** * Class that provides a {@link Set} view of the entry set of this map that is backed live - * by this map. Its main job is to translate from Map.Entry> to - * Map.Entry. The heavy lifting is done by the EntryIterator. The super class implements - * all the rest of the methods by leveraging the iterator. We implement + * by this map. Its main job is to translate from {@code Map.Entry>} to + * {@code Map.Entry}. The heavy lifting is done by the {@link EntryIterator}. The super + * class implements all the rest of the methods by leveraging the iterator. We implement * contains, remove, and clear as they can be implemented much more efficiently than the * default implementation which iterates over all the values to do those operations. */ private class EntrySet extends AbstractSet> { + + @Override public Iterator> iterator() { return new EntryIterator(); } + @Override public boolean contains(Object o) { if (o instanceof Map.Entry e) { Object key = e.getKey(); @@ -328,6 +331,7 @@ public abstract class AbstractWeakValueMap implements Map { return false; } + @Override public boolean remove(Object o) { if (o instanceof Map.Entry e) { Object key = e.getKey(); @@ -341,10 +345,12 @@ public abstract class AbstractWeakValueMap implements Map { } + @Override public int size() { return AbstractWeakValueMap.this.size(); } + @Override public void clear() { AbstractWeakValueMap.this.clear(); } diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ProjectLocator.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ProjectLocator.java index 8fd1d79f6d..227a4071f1 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ProjectLocator.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ProjectLocator.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -143,23 +143,23 @@ public class ProjectLocator { } /** - * @returns true if this project URL corresponds to a transient project - * (e.g., corresponds to remote Ghidra URL) + * {@return true if this project URL corresponds to a transient project + * (e.g., corresponds to remote Ghidra URL)} */ public boolean isTransient() { return false; } /** - * @returns the URL associated with this local project. If using a temporary transient - * project location this URL should not be used. + * {@return the URL associated with this local project. If using a temporary transient + * project location this URL should not be used.} */ public URL getURL() { return url; } /** - * @returns the name of the project identified by this project info. + * {@return the name of the project identified by this project info.} */ public String getName() { return name; @@ -168,6 +168,7 @@ public class ProjectLocator { /** * Get the location of the project which will contain marker file * ({@link #getMarkerFile()}) and project directory ({@link #getProjectDir()}). + *

* Note: directory may or may not exist. * @return project location directory */ @@ -176,29 +177,28 @@ public class ProjectLocator { } /** - * @returns the project directory + * {@return the project directory} */ public File getProjectDir() { return new File(location, name + PROJECT_DIR_SUFFIX); } /** - * @returns the file that indicates a Ghidra project. + * {@return the file that indicates a Ghidra project.} */ public File getMarkerFile() { return new File(location, name + PROJECT_FILE_SUFFIX); } /** - * @returns project lock file to prevent multiple accesses to the - * same project at once. + * {@return project lock file to prevent multiple accesses to the same project at once.} */ public File getProjectLockFile() { return new File(location, name + LOCK_FILE_SUFFIX); } /** - * @returns the project directory file extension. + * {@return the project directory file extension.} */ public static String getProjectDirExtension() { return PROJECT_DIR_SUFFIX; @@ -230,23 +230,22 @@ public class ProjectLocator { } /** - * @returns the file extension suitable for creating file filters for the file chooser. + * {@return the file extension suitable for creating file filters for the file chooser} */ public static String getProjectExtension() { return PROJECT_FILE_SUFFIX; } /** - * Returns whether the given file is a project directory. + * {@return whether the given file is a project directory.} * @param file file to check - * @return true if the file is a project directory */ public static boolean isProjectDir(File file) { return file.isDirectory() && file.getName().endsWith(PROJECT_DIR_SUFFIX); } /** - * @returns true if project storage exists + * {@return true if project storage exists} */ public boolean exists() { return getMarkerFile().isFile() && getProjectDir().isDirectory(); diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/pcode/AbstractPcodeFormatter.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/pcode/AbstractPcodeFormatter.java index b09254dccf..33380a2ebe 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/pcode/AbstractPcodeFormatter.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/pcode/AbstractPcodeFormatter.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in 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,10 +31,9 @@ import ghidra.util.Msg; * {@link #formatOpTemplate(Appender, OpTpl)}. Otherwise, most formatting logic is implemented by * the appender. * - * @see {@link StringPcodeFormatter} for an example - * @see {@link AbstractAppender} * @param the type of this formatter's output, e.g., {@link String} * @param the type of the appender + * @see AbstractAppender */ public abstract class AbstractPcodeFormatter> implements PcodeFormatter {