yetangitu/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2025-10-04 10:19:23 +02:00
Code Issues Releases Wiki Activity

GP-0: Cleaning up certain types of javadoc errors

Browse source
This commit is contained in:
Ryan Kurtz 2025-01-30 14:33:25 -05:00
parent 6086ba9bfb
commit d23e67a088
411 changed files with 1153 additions and 1864 deletions
Download patch file Download diff file Expand all files Collapse all files

7
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/DefaultAssemblyResolvedBackfill.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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);

8
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/BinaryExpression.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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;

8
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Constant.java
View file

@ -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;

7
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ConstantTemplate.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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;

12
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ConstructorPcodeTemplate.java
View file

@ -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<Object> pcodeDirectives;

13
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ExpressionTerm.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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;

12
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/ExpressionValue.java
View file

@ -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;

7
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Handle.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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;

12
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/HandleTemplate.java
View file

@ -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

12
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Offset.java
View file

@ -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;

14
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/OpTemplate.java
View file

@ -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;

13
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/Operand.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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;

13
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/OperandValue.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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;

9
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/generic/SledException.java
View file

@ -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 {
}
/**
* <p>Constructs a SledException with no detail message.<p>
* <p>Constructs a SledException with no detail message.
*/
public SledException() {
super();
@ -44,7 +43,7 @@ public class SledException extends RuntimeException {
/**
* <p>Constructs a SledException with the specified
* detail message.<p>
* detail message.
*
* @param message The message.
*/

7
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/PseudoCodeUnit.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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;

1
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/SymbolPath.java
View file

@ -26,7 +26,6 @@ import ghidra.program.model.symbol.*;
* <P>
* 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.
* <P>
* <UL>
* <LI>{@link #getName()} will return "baz".</LI>
* <LI>{@link #getParentPath()} will return "foo:bar".</LI>

8
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcodeCPort/utils/WeakHashMap2.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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<K, V> extends AbstractMap<K, V> {
/**
* Constructs a new <code>WeakHashMap2</code> with the same mappings as the
* specified <tt>Map</tt>. The <code>WeakHashMap2</code> 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
* <tt>0.75</tt>.
* {@code 0.75}.
*
* @param t the map whose mappings are to be placed in this map.
* @since 1.3

5
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/ManagerDB.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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.
* <p>
*/
default void dispose() {
// default do nothing

7
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkDB.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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;

14
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkDBAdapterV1.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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;

10
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkDBAdapterV2.java
View file

@ -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;

7
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/BookmarkTypeDBAdapterNoTable.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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];

7
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/bookmark/OldBookmark.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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

3
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/data/ArrayDBAdapterV0.java
View file

@ -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;

3
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/module/ModuleManager.java
View file

@ -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);

9
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/oldfunction/OldFunctionDataDB.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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;

7
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/oldfunction/OldFunctionMapDB.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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 {

9
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/oldfunction/OldStackFrameDB.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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

7
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/references/RefList.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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;

8
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/symbol/OverlappingNamespaceException.java
View file

@ -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;

19
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressFormatException.java
View file

@ -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 {
/**
* <p>Constructs an AddressFormatException with no detail message.<p>
*/
* <p>Constructs an AddressFormatException with no detail message.
*/
public AddressFormatException() {
super("Cannot parse string into address.");
}
/**
* <p>Constructs an AddressFormatException with the specified
* detail message.<p>
*
* @param message A user message.
*/
* <p>Constructs an AddressFormatException with the specified
* detail message.
*
* @param message A user message.
*/
public AddressFormatException(String message) {
super(message);
}

34
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressObjectMap.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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;
/**
* <CODE>AddressObjectMap</CODE> 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.
* <P>
* @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.
* <P>
* @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;

9
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressOutOfBoundsException.java
View file

@ -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 {
/**
* <p>Constructs an AddressOutOfBoundsException with no detail message.<p>
* <p>Constructs an AddressOutOfBoundsException with no detail message.
*/
public AddressOutOfBoundsException() {
super("Address not contained in memory.");
@ -32,7 +31,7 @@ public class AddressOutOfBoundsException extends RuntimeException {
/**
* <p>Constructs an AddressOutOfBoundsException with the specified
* detail message.<p>
* detail message.
*
* @param message The message.
*/

19
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressOverflowException.java
View file

@ -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 {
/**
* <p>Constructs an AddressOverflowException with no detail message.<p>
*/
* <p>Constructs an AddressOverflowException with no detail message.
*/
public AddressOverflowException() {
super("Displacement would result in an illegal address value.");
}
/**
* <p>Constructs an AddressOverflowException with the specified
* detail message.<p>
*
* @param message The message.
*/
* <p>Constructs an AddressOverflowException with the specified
* detail message.
*
* @param message The message.
*/
public AddressOverflowException(String message) {
super(message);
}

6
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressRange.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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.
* <P>
*
* @see AddressRangeImpl
* @since 2000-02-16
*/

12
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressRangeToAddressComparator.java
View file

@ -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.
* <P>
*/
public class AddressRangeToAddressComparator implements Comparator<Object> {
/**
* 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.
* <P>
* @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) {

6
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressSetCollection.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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.
* <P>
*
* @param address address to test.
* @return true if addr exists in the set, false otherwise.
*/

9
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressSetMapping.java
View file

@ -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}.<p>
* 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}.
* <p>
* 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.
* <p>
* This collapses a sparse address space with holes into a contiguous list of addresses.
*/

6
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressSetView.java
View file

@ -25,7 +25,7 @@ import java.util.Iterator;
public interface AddressSetView extends Iterable<AddressRange> {
/**
* Test if the address is contained within this set.
* <P>
*
* @param addr address to test.
* @return true if addr exists in the set, false otherwise.
*/
@ -35,7 +35,7 @@ public interface AddressSetView extends Iterable<AddressRange> {
* 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}.
* <P>
*
* @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<AddressRange> {
/**
* Test if the given address set is a subset of this set.
* <P>
*
* @param rangeSet the set to test.
* @return true if the entire set is contained within this set,
* false otherwise.

19
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/SegmentMismatchException.java
View file

@ -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 {
/**
* <p>Constructs a SegmentMismatchException with no detail message.<p>
*/
* <p>Constructs a SegmentMismatchException with no detail message.
*/
public SegmentMismatchException() {
super("The segments of the addresses do not match.");
}
/**
* <p>Constructs a SegmentMismatchException with the specified
* detail message.<p>
*
* @param message The message.
*/
* <p>Constructs a SegmentMismatchException with the specified
* detail message.
*
* @param message The message.
*/
public SegmentMismatchException(String message) {
super(message);
}

5
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/CodeBlockReferenceImpl.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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;
* <P>
* The <CODE>referent</CODE> is the address of the instruction in
* the source block that flows to the destination block.
* <P>
*
* @see ghidra.program.model.block.CodeBlockReference
*/

6
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/MultEntSubIterator.java
View file

@ -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.
* <P>
*
* @param model the SubroutineModel the iterator will use in its operations.
* @param set the address range set which the iterator is to be

7
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/SimpleBlockIterator.java
View file

@ -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.
* <P>
*
* @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.
* <P>
*
* @param model the BlockModel the iterator will use in its operations.
* @param set the address range set which the iterator is to be

10
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/block/SingleEntSubIterator.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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;
/**
* <CODE>SingleEntSubIterator</CODE> is an implementation of
* <CODE>CodeBlockIterator</CODE> 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.
* <P>
*
* @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.

16
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/AbstractStringDataType.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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.
* <p>
*
*/
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.
* <p>
*
* @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.
* <p>
*
* @param buf the data.
* @param settings the settings to use for the representation.

8
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/ArrayStringable.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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.
* <p>
*
* @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.
* <p>
*
* @param dt data type
* @return ArrayStringable object, or null.
*/

5
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/CharsetSettingsDefinition.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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.
* <p>
*/
private static Map<Long, List<String>> languageToCharsetIndexMap = new HashMap<>();

5
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/CompositeInternal.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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 {
* <code>OrdinalComparator</code> 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.
* <p>
*/
public static class OrdinalComparator implements Comparator<Object> {

6
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/DataTypeManager.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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.
* <p>
* <pre>
* 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.
* <p>
* <pre>
* program.withTransaction("My Description", () -> {
* // ... Do something

6
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/LEB128.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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.
* <p>
* Large integers that use more than 64 bits will cause an IOException to be thrown.
* <p>
*
* @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

5
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/PascalString255DataType.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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).
* <p>
*/
public class PascalString255DataType extends AbstractStringDataType {

5
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/PascalStringDataType.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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).
* <p>
*/
public class PascalStringDataType extends AbstractStringDataType {

5
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/PascalUnicodeDataType.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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).
* <p>
*/
public class PascalUnicodeDataType extends AbstractStringDataType {

14
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringDataInstance.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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.
* <p>
*/
public class StringDataInstance {
@ -72,7 +71,6 @@ public class StringDataInstance {
* <p>
* 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.
* <p>
*
* @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.
* <p>
*
* @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.
* <p>
*
* @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.
* <p>
*
* @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.
* <p>
*
* @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.
* <p>
*
* @return String containing the representation of the char.
*/
@ -988,7 +981,6 @@ public class StringDataInstance {
* {@code byteOffset} from the start of this instance.
* <p>
* If the requested offset is not valid, StringDataInstance.NULL_INSTANCE is returned.
* <p>
*
* @param byteOffset number of bytes from start of data instance to start new instance.
* @return new StringDataInstance, or <code>StringDataInstance.NULL_INSTANCE</code> 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.
* <p>
*
* @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.
* <p>
* I dare myself to type Type one more time.
* <p>
*
* @return {@link DataType}, defaulting to {@link StringDataType} if no direct match found.
*/

6
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringRenderBuilder.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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}
* <p>
*
* @return Formatted string
*/
@Override

5
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringUTF8DataType.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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}.
* <p>
*/
public class StringUTF8DataType extends AbstractStringDataType {
public static final StringUTF8DataType dataType = new StringUTF8DataType();

1
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/Structure.java
View file

@ -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.
* <p>
*
* @param byteOffset the first byte offset within this structure which corresponds to the first
* byte of the specified storage unit identified by its byteWidth.

5
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/TerminatedStringDataType.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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).
* <p>
*/
public class TerminatedStringDataType extends AbstractStringDataType {

5
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/TerminatedUnicode32DataType.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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}.
* <p>
*/
public class TerminatedUnicode32DataType extends AbstractStringDataType {

5
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/Unicode32DataType.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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}.
* <p>
*/
public class Unicode32DataType extends AbstractStringDataType {

5
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/UnicodeDataType.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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}.
* <p>
*/
public class UnicodeDataType extends AbstractStringDataType {

9
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/InsufficientBytesException.java
View file

@ -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 {
/**
* <p>Constructs an InsufficientBytesException with a default message.<p>
* <p>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 {
/**
* <p>Constructs an InsufficientBytesException with the specified
* detail message.<p>
* detail message.
*
* @param message The message.
*/

10
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/UnknownContextException.java
View file

@ -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 {
/**
* <p>Constructs an UnknownContextException with a default message.<p>
* Constructs an UnknownContextException with a default message.
*/
public UnknownContextException() {
super("The current processor state is not known for constructing a legal instruction.");
}
/**
* <p>Constructs an UnknownContextException with the specified
* detail message.<p>
* Constructs an UnknownContextException with the specified detail message.
*
* @param message The message.
*/

9
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/UnknownDataException.java
View file

@ -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 {
/**
* <p>Constructs an UnknownDataException with a default message.<p>
* <p>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 {
/**
* <p>Constructs an UnknownDataException with the specified
* detail message.<p>
* detail message.
*
* @param message The message.
*/

9
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/UnknownInstructionException.java
View file

@ -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 {
/**
* <p>Constructs an InsufficientBytesException with a default message.<p>
* <p>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 {
/**
* <p>Constructs an InsufficientBytesException with the specified
* detail message.<p>
* detail message.
*
* @param message The message.
*/

9
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/ContextChangeException.java
View file

@ -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 {
/**
* <p>Constructs an ContextChangeException with no detail message.<p>
* <p>Constructs an ContextChangeException with no detail message.
*/
public ContextChangeException() {
super();
@ -32,7 +31,7 @@ public class ContextChangeException extends UsrException {
/**
* <p>Constructs an ContextChangeException with the specified
* detail message.<p>
* detail message.
*
* @param message The message.
*/

7
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Function.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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

6
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Group.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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.<P>
* Returns whether this fragment contains the given code unit.
*
* @param codeUnit the code unit being tested.
*

11
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Listing.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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 <code>next</code> method. An initial call to the <code>previous</code>
* method would return the code unit with an address less than the specified
* address.
* <p>
*
* @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 <code>next</code> method. An initial call to the <code>previous</code>
* method would return the instruction with an address less than the
* specified address.
* <p>
*
* @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 <code>next</code>
* method. An initial call to the <code>previous</code> method would return the
* Data with an address less than the specified address.
* <p>
*
* @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 <code>next</code> method. An initial call to the
* <code>previous</code> method would return the defined Data with an address
* less than the specified address.
* <p>
*
* @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.
* <P>
*
* @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.
* <P>
*
* @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.
* <P>
*
* @param treeName name of the tree to search
* @param name the name of the fragment to find.

10
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/ProgramFragment.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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.<P>
* 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 <CODE>min</CODE> must the starting address of a code unit
* and <CODE>max</CODE> must be the ending address of a code unit.
* Furthermore every address in the given range must exist in program
* memory.<P>
* 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 <CODE>min</CODE>
* and <CODE>max</CODE> (inclusive) does not belong to program memory.
*/

28
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/ProgramModule.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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.
* <P>
*
* @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.
* <P>
*
* @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.<P>
* 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.<P>
* 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.<P>
* 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.<P>
* 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.<P>
* 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.
* <P>
*
* @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.
* <P>
*
* @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.
* <P>
*
* @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.
* <P>
*
* @return the last address, this will be null if all of the module's
* descendant fragments are empty.
*/

7
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/StackFrame.java
View file

@ -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.
* <p> <pre>
* <pre>
*
*
* Negative Growth

7
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/StackVariableComparator.java
View file

@ -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<Object> {
* a StackVariable.
* @param obj1 a StackVariable or Integer
* @param obj2 a StackVariable or Integer
* <P>
*
* @return a negative integer, zero, or a positive integer
* if the first argument is less than, equal to, or greater than the second.
*/

2
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/VariableStorage.java
View file

@ -26,7 +26,7 @@ import ghidra.program.util.LanguageTranslator;
import ghidra.util.exception.InvalidInputException;
/**
* <code></code> 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.

5
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/mem/Memory.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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.</li>
* </ul>
* </p>
* <p>
* <u>Overlay Blocks</u>
* An overlay memory block provides the ability to define alternate content for a physical memory

18
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/mem/MemoryAccessException.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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
{
/**
* <p>Constructs an MemoryAccessException with no detail message.<p>
*/
* <p>Constructs an MemoryAccessException with no detail message.
*/
public MemoryAccessException() {
super();
}
/**
* <p>Constructs an MemoryAccessException with the specified
* detail message.<p>
*
* @param message The message.
*/
* <p>Constructs an MemoryAccessException with the specified
* detail message.
*
* @param message The message.
*/
public MemoryAccessException(String message) {
super(message);
}

19
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/scalar/ScalarOverflowException.java
View file

@ -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 {
/**
* <p>Constructs a ScalarOverflowException with no detail message.<p>
*/
* <p>Constructs a ScalarOverflowException with no detail message.
*/
public ScalarOverflowException() {
super("Scalar overflow");
}
/**
* <p>Constructs a ScalarOverflowException with the specified
* detail message.<p>
*
* @param message The message.
*/
* <p>Constructs a ScalarOverflowException with the specified
* detail message.
*
* @param message The message.
*/
public ScalarOverflowException(String message) {
super(message);
}

11
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/util/PropertyMap.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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<T> {
/**
* Given two addresses, indicate whether there is an address in
* that range (inclusive) having the property.<p>
* 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<T> {
/**
* Indicate whether there is an address within
* the set which exists within this map.<p>
* 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.
*/

7
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/FunctionReturnTypeFieldLocation.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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.<P>
* 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.

4
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/FunctionSignatureFieldLocation.java
View file

@ -31,10 +31,10 @@ public class FunctionSignatureFieldLocation extends FunctionLocation {
private String signature;
/**
* When true the <tt>charOffset</tt> 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 <tt>true</tt>.
* position when this flag is {@code true}.
*/
private boolean isFieldBasedPoisitioning;

7
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/LabelFieldLocation.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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.<P>
* 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.

12
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/RegisterFieldLocation.java
View file

@ -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.
*

8
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/RegisterTransitionFieldLocation.java
View file

@ -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;

3
Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/program/database/data/UnionDBTest.java
View file

@ -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;

7
Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/program/model/util/PropertyMapTest.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in 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);

7
Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/sleigh/grammar/FileSearcher.java
View file

@ -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;