mstoeck3/autopsy-flatpak
1
0
Fork 0
mirror of https://github.com/overcuriousity/autopsy-flatpak.git synced 2025-07-12 16:06:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed comments

Browse Source
This commit is contained in:
U-BASIS\dsmyda 2018-12-14 10:13:42 -05:00
parent 8efce2a827
commit 3ea88c7797
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Core/src/org/sleuthkit/autopsy/textreaders/TextReaders.java
View File

@ -31,8 +31,8 @@ import org.sleuthkit.datamodel.Report;
/** /**
* Factory for creating Readers given a Content instance * Factory for creating Readers given a Content instance
* *
* See {@link org.sleuthkit.autopsy.textextractors.textreaderconfigs} for * See {@link org.sleuthkit.autopsy.textreaders.textreaderconfigs} for available
* available Reader configuration options. * Reader configuration options.
* *
* @see org.openide.util.Lookup * @see org.openide.util.Lookup
*/ */
@ -42,7 +42,7 @@ public class TextReaders {
* Returns a reader containing the Content text. Configuration files can be * Returns a reader containing the Content text. Configuration files can be
* added to the Lookup. * added to the Lookup.
* *
* See {@link org.sleuthkit.autopsy.textextractors.textreaderconfigs} for * See {@link org.sleuthkit.autopsy.textreaders.textreaderconfigs} for
* available Reader configuration options. * available Reader configuration options.
* *
* @param content Content source that will be read from * @param content Content source that will be read from
@ -50,9 +50,9 @@ public class TextReaders {
* *
* @return Reader containing file text * @return Reader containing file text
* *
* @throws NoTextReaderFound Encountered when there is no Reader found for * @throws NoTextReaderFound Encountered when there is no Reader found for
* the given content type or there was an error while * the given content type or there was an error
* creating the reader. * while creating the reader.
* *
* @see org.openide.util.Lookup * @see org.openide.util.Lookup
*/ */
@ -100,9 +100,9 @@ public class TextReaders {
* @return Reader containing file text * @return Reader containing file text
* *
* @throws NoTextReaderFound Encountered when there is no Reader was found * @throws NoTextReaderFound Encountered when there is no Reader was found
for the given content type. Use * for the given content type. Use
getStringsReader(Content,Lookup) method * getStringsReader(Content,Lookup) method
instead. * instead.
*/ */
public static Reader getReader(Content content) public static Reader getReader(Content content)
throws NoTextReaderFound { throws NoTextReaderFound {
@ -115,6 +115,9 @@ public class TextReaders {
* no reader was found using getReader(Content) or getReader(Content, * no reader was found using getReader(Content) or getReader(Content,
* Lookup). * Lookup).
* *
* Configure this reader with the StringsConfig in
* {@link org.sleuthkit.autopsy.textreaders.textreaderconfigs}
*
* @param content Content source to read from * @param content Content source to read from
* @param context Contains extraction configurations for certain file types * @param context Contains extraction configurations for certain file types
* *