mirror of
https://github.com/overcuriousity/autopsy-flatpak.git
synced 2025-07-06 21:00:22 +00:00
Fixed doxygen warnings
This commit is contained in:
Ann Priestman
parent
11dc167025
commit
bed8774a7f
@ -264,6 +264,7 @@ public class CommandLineIngestManager {
|
||||
* Passes the data source for the current job through a data source
|
||||
* processor that adds it to the case database.
|
||||
*
|
||||
* @param caseForJob The case
|
||||
* @param dataSource The data source.
|
||||
*
|
||||
* @throws
|
||||
|
||||
@ -50,6 +50,7 @@ public class CommonAttributeValueNode extends DisplayableItemNode {
|
||||
* Create a Match node whose children will all have this object in common.
|
||||
*
|
||||
* @param data the common feature, and the children
|
||||
* @param type the data type
|
||||
*/
|
||||
public CommonAttributeValueNode(CommonAttributeValue data, CorrelationAttributeInstance.Type type) {
|
||||
super(Children.create(
|
||||
|
||||
@ -52,8 +52,9 @@ public final class InstanceCountNode extends DisplayableItemNode {
|
||||
* Create a node with the given number of instances, and the given selection
|
||||
* of metadata.
|
||||
*
|
||||
* @param instanceCount
|
||||
* @param attributeValues
|
||||
* @param instanceCount the number of instances
|
||||
* @param attributeValues the attribute list
|
||||
* @param type the data type
|
||||
*/
|
||||
@NbBundle.Messages({
|
||||
"InstanceCountNode.displayName=Exists in %s data sources (%s)"
|
||||
|
||||
@ -59,6 +59,7 @@ public class CommSnapShotReportWriter extends UiSnapShotReportWriter {
|
||||
* @param reportName The name of the report.
|
||||
* @param generationDate The generation Date of the report.
|
||||
* @param snapshot A snapshot of the view to include in the report.
|
||||
* @param filter The communications filter
|
||||
*/
|
||||
public CommSnapShotReportWriter(Case currentCase, Path reportFolderPath, String reportName, Date generationDate, BufferedImage snapshot, CommunicationsFilter filter) {
|
||||
|
||||
|
||||
@ -47,6 +47,7 @@ public class AddDataSourceCallback extends DataSourceProcessorCallback {
|
||||
* @param caseForJob The case for the current job.
|
||||
* @param dataSourceInfo The data source
|
||||
* @param taskId The task id to associate with ingest job events.
|
||||
* @param lock The DSP lock
|
||||
*/
|
||||
public AddDataSourceCallback(Case caseForJob, AutoIngestDataSource dataSourceInfo, UUID taskId, Object lock) {
|
||||
this.caseForJob = caseForJob;
|
||||
|
||||
@ -41,6 +41,8 @@ public class DataSourceProcessorUtility {
|
||||
* AutoIngestDataSourceProcessor interface are used.
|
||||
*
|
||||
* @param dataSourcePath Full path to the data source
|
||||
* @param processorCandidates Possible DSPs that can handle the data source
|
||||
*
|
||||
* @return Hash map of all DSPs that can process the data source along with
|
||||
* their confidence score
|
||||
* @throws
|
||||
|
||||
@ -518,7 +518,7 @@ public class CreatePortableCaseModule implements GeneralReportModule {
|
||||
* Get the artifact type ID in the portable case and create new artifact type if needed.
|
||||
* For built-in artifacts this will be the same as the original.
|
||||
*
|
||||
* @param oldArtifactTypeId The artifact type ID in the current case
|
||||
* @param oldArtifact The artifact in the current case
|
||||
*
|
||||
* @return The corresponding artifact type ID in the portable case
|
||||
*/
|
||||
@ -541,7 +541,7 @@ public class CreatePortableCaseModule implements GeneralReportModule {
|
||||
* Get the attribute type ID in the portable case and create new attribute type if needed.
|
||||
* For built-in attributes this will be the same as the original.
|
||||
*
|
||||
* @param oldAttributeTypeId The attribute type ID in the current case
|
||||
* @param oldAttribute The attribute in the current case
|
||||
*
|
||||
* @return The corresponding attribute type in the portable case
|
||||
*/
|
||||
|
||||
@ -248,7 +248,7 @@ public final class CaseUcoFormatExporter {
|
||||
* @param selectedDataSourceId Object ID of the data source
|
||||
* @param caseTraceId CASE-UCO trace ID object for the Autopsy case entry
|
||||
* @param skCase SleuthkitCase object
|
||||
* @param catalog JsonGenerator object
|
||||
* @param jsonGenerator JsonGenerator object
|
||||
* @return
|
||||
* @throws TskCoreException
|
||||
* @throws SQLException
|
||||
|
||||
@ -62,8 +62,6 @@ public abstract class UiSnapShotReportWriter {
|
||||
* report.
|
||||
* @param reportName The name of the report.
|
||||
* @param generationDate The generation Date of the report.
|
||||
* @param snapshot A snapshot of the view to include in the
|
||||
* report.
|
||||
*/
|
||||
protected UiSnapShotReportWriter(Case currentCase, Path reportFolderPath, String reportName, Date generationDate) {
|
||||
this.currentCase = currentCase;
|
||||
|
||||
@ -29,7 +29,7 @@ import org.sleuthkit.datamodel.Report;
|
||||
/**
|
||||
* Factory for creating TextExtractors given a Content instance
|
||||
*
|
||||
* See {@link org.sleuthkit.autopsy.textextractors.textextractorconfigs} for
|
||||
* See {@link org.sleuthkit.autopsy.textextractors.configs} for
|
||||
* available extractor configuration options.
|
||||
*
|
||||
* @see org.openide.util.Lookup
|
||||
@ -40,7 +40,7 @@ public class TextExtractorFactory {
|
||||
* Returns a TextExtractor containing the Content text. Configuration files
|
||||
* can be added to the Lookup.
|
||||
*
|
||||
* See {@link org.sleuthkit.autopsy.textextractors.textextractorconfigs} for
|
||||
* See {@link org.sleuthkit.autopsy.textextractors.configs} for
|
||||
* available extractor configuration options.
|
||||
*
|
||||
* @param content Content source that will be read from
|
||||
@ -124,7 +124,7 @@ public class TextExtractorFactory {
|
||||
* getExtractor(Content, Lookup).
|
||||
*
|
||||
* Configure this extractor with the StringsConfig in
|
||||
* {@link org.sleuthkit.autopsy.textextractors.textextractorconfigs}
|
||||
* {@link org.sleuthkit.autopsy.textextractors.configs}
|
||||
*
|
||||
* @param content Content source to read from
|
||||
* @param context Contains extraction configurations for certain file types
|
||||
|
||||
@ -815,8 +815,8 @@ final class MultiCaseKeywordSearchPanel extends javax.swing.JPanel implements Ex
|
||||
/**
|
||||
* Constructs a thread that performs a keyword search of cases
|
||||
*
|
||||
* @param caseNames The names of the cases to search.
|
||||
* @param query The keyword search query to perform.
|
||||
* @param caseNodes The cases to search.
|
||||
* @param searchQuery The keyword search query to perform.
|
||||
*/
|
||||
private SearchThread(Collection<CaseNodeData> caseNodes, SearchQuery searchQuery) {
|
||||
this.caseNodes = caseNodes;
|
||||
|
||||
@ -70,7 +70,7 @@ public final class BinaryCookieReader implements Iterable<Cookie> {
|
||||
* the file is a binarycookie file. This function does not keep the file
|
||||
* open.
|
||||
*
|
||||
* @param file binarycookie file
|
||||
* @param cookieFile binarycookie file
|
||||
* @return An instance of the reader
|
||||
* @throws FileNotFoundException
|
||||
* @throws IOException
|
||||
|
||||
@ -292,7 +292,7 @@ final class ExtractZoneIdentifier extends Extract {
|
||||
|
||||
/**
|
||||
* Wrapper class for information in the :ZoneIdentifier file. The
|
||||
* Zone.Identifier file has a simple format of <i>key<i>=<i>value<i>. There
|
||||
* Zone.Identifier file has a simple format of \<i\>key\<i\>=\<i\>value\<i\>. There
|
||||
* are four known keys: ZoneId, ReferrerUrl, HostUrl, and
|
||||
* LastWriterPackageFamilyName. Not all browsers will put all values in the
|
||||
* file, in fact most will only supply the ZoneId. Only Edge supplies the
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user