mirror of
https://github.com/NationalSecurityAgency/ghidra.git
synced 2026-09-28 17:11:11 -09:00
GP-0: Cleaning up certain types of javadoc errors
This commit is contained in:
@@ -4,9 +4,9 @@
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
@@ -20,7 +20,6 @@ import java.io.OutputStream;
|
||||
|
||||
/**
|
||||
* A {@link OutputStream} that discards all bytes written to it.
|
||||
* <p>
|
||||
*/
|
||||
public class NullOutputStream extends OutputStream {
|
||||
|
||||
|
||||
@@ -230,7 +230,6 @@ public class UserSearchUtils {
|
||||
* <b>match exactly</b> the given input string.
|
||||
* <p>
|
||||
* This method can be used with {@link Matcher#matches()} or {@link Matcher#find()}.
|
||||
* <p>
|
||||
*
|
||||
* @param input
|
||||
* the string that you want to your matched strings to exactly match.
|
||||
@@ -261,7 +260,6 @@ public class UserSearchUtils {
|
||||
* all strings that match the given input string.
|
||||
* <p>
|
||||
* This method can be used with {@link Matcher#matches()} or {@link Matcher#find()}.
|
||||
* <p>
|
||||
*
|
||||
* @param input
|
||||
* the string that you want to your matched strings to exactly match.
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
@@ -298,7 +298,6 @@ public final class FileUtilities {
|
||||
* <p>
|
||||
* Takes into account race conditions with external threads/processes
|
||||
* creating the same directory at the same time.
|
||||
* <p>
|
||||
*
|
||||
* @param dir The directory to create.
|
||||
* @return True If the directory exists when this method completes; otherwise, false.
|
||||
@@ -347,7 +346,7 @@ public final class FileUtilities {
|
||||
* <p>
|
||||
* Takes into account race conditions with external threads/processes
|
||||
* creating the same directory at the same time.
|
||||
* <p>
|
||||
*
|
||||
* @param dir The directory to create.
|
||||
* @return a reference to the same {@link File} instance that was passed in.
|
||||
* @throws IOException if there was a failure when creating the directory (ie. the
|
||||
@@ -368,7 +367,6 @@ public final class FileUtilities {
|
||||
* <p>
|
||||
* Uses {@link #createDir(File)} to create new directories (which handles
|
||||
* race conditions if other processes are also trying to create the same directory).
|
||||
* <p>
|
||||
*
|
||||
* @param dir directory path to be created
|
||||
* @return a reference to the same {@link File} instance that was passed in.
|
||||
@@ -681,7 +679,7 @@ public final class FileUtilities {
|
||||
* Returns all of the lines in the file without any newline characters.
|
||||
* <p>
|
||||
* The file is treated as UTF-8 encoded.
|
||||
* <p>
|
||||
*
|
||||
* @param file The text file to read in
|
||||
* @return a list of file lines
|
||||
* @throws IOException if an error occurs reading the file
|
||||
@@ -717,7 +715,7 @@ public final class FileUtilities {
|
||||
* Returns all of the lines in the BufferedReader without any newline characters.
|
||||
* <p>
|
||||
* The file is treated as UTF-8 encoded.
|
||||
* <p>
|
||||
*
|
||||
* @param url the input stream from which to read
|
||||
* @return a list of file lines
|
||||
* @throws IOException thrown if there was a problem accessing the files
|
||||
@@ -731,7 +729,6 @@ public final class FileUtilities {
|
||||
|
||||
/**
|
||||
* Returns all of the lines in the given {@link InputStream} without any newline characters.
|
||||
* <p>
|
||||
*
|
||||
* @param is the input stream from which to read
|
||||
* @return a {@link List} of strings representing the text lines of the file
|
||||
@@ -745,7 +742,7 @@ public final class FileUtilities {
|
||||
* Returns all of the text in the given {@link InputStream}.
|
||||
* <p>
|
||||
* EOL characters are normalized to simple '\n's.
|
||||
* <p>
|
||||
*
|
||||
* @param is the input stream from which to read
|
||||
* @return the content as a String
|
||||
* @throws IOException if there are any issues reading the file
|
||||
@@ -764,7 +761,7 @@ public final class FileUtilities {
|
||||
* Returns all of the text in the given {@link File}.
|
||||
* <p>
|
||||
* See {@link #getText(InputStream)}
|
||||
* <p>
|
||||
*
|
||||
* @param f the file to read
|
||||
* @return the content as a String
|
||||
* @throws IOException if there are any issues reading the file or file is too large.
|
||||
@@ -1075,7 +1072,7 @@ public final class FileUtilities {
|
||||
* <p>
|
||||
* Querying a filepath that does not exist will result in a 'success' and the caller will
|
||||
* receive the non-existent File instance back.
|
||||
* <p>
|
||||
*
|
||||
* @param caseSensitiveFile {@link File} to enforce case-sensitive-ness of the name portion
|
||||
* @return the same {@link File} instance if it points to a file on the filesystem with
|
||||
* the same case, or a NULL if the case does not match.
|
||||
@@ -1114,7 +1111,7 @@ public final class FileUtilities {
|
||||
* If no file is found that matches, the original File instance is returned.
|
||||
* <p>
|
||||
* See also {@link #existsAndIsCaseDependent(ResourceFile)}.
|
||||
* <p>
|
||||
*
|
||||
* @param f File instance
|
||||
* @return File instance pointing to a case-insensitive match of the File parameter
|
||||
*/
|
||||
@@ -1158,7 +1155,6 @@ public final class FileUtilities {
|
||||
* Returns the size of the given file as a human readable String.
|
||||
* <p>
|
||||
* See {@link #formatLength(long)}
|
||||
* <p>
|
||||
*
|
||||
* @param file the file for which to get size
|
||||
* @return the pretty string
|
||||
|
||||
Reference in New Issue
Block a user