Skip to content
Snippets Groups Projects
Commit 37a1a230 authored by Brian Carrier's avatar Brian Carrier
Browse files

Updated Doxygen about object types

parent 2796b7df
No related branches found
No related tags found
No related merge requests found
...@@ -37,18 +37,18 @@ typedef struct sqlite3 sqlite3; ...@@ -37,18 +37,18 @@ typedef struct sqlite3 sqlite3;
/** /**
* Values for the object type value. * Values for the type column in the tsk_objects table.
*/ */
typedef enum { typedef enum {
TSK_DB_OBJECT_TYPE_IMG = 0, TSK_DB_OBJECT_TYPE_IMG = 0, ///< Object is a disk image
TSK_DB_OBJECT_TYPE_VS, TSK_DB_OBJECT_TYPE_VS, ///< Object is a volume system.
TSK_DB_OBJECT_TYPE_VOL, TSK_DB_OBJECT_TYPE_VOL, ///< Object is a volume
TSK_DB_OBJECT_TYPE_FS, TSK_DB_OBJECT_TYPE_FS, ///< Object is a file system
TSK_DB_OBJECT_TYPE_FILE, TSK_DB_OBJECT_TYPE_FILE, ///< Object is a file (exact type can be determined in the tsk_files table via TSK_DB_FILES_TYPE_ENUM)
} TSK_DB_OBJECT_TYPE_ENUM; } TSK_DB_OBJECT_TYPE_ENUM;
/** /**
* Values for the files type column in the files table. * Values for the files type column in the tsk_files table.
*/ */
typedef enum { typedef enum {
TSK_DB_FILES_TYPE_FS = 0, ///< File that can be found in file system tree. TSK_DB_FILES_TYPE_FS = 0, ///< File that can be found in file system tree.
...@@ -63,12 +63,13 @@ typedef enum { ...@@ -63,12 +63,13 @@ typedef enum {
/** /**
* Values for the "known" column of the files table * Values for the "known" column of the tsk_files table
*/ */
typedef enum { typedef enum {
TSK_DB_FILES_KNOWN_UNKNOWN = 0, ///< Not matched against an index TSK_DB_FILES_KNOWN_UNKNOWN = 0, ///< Not matched against an index
TSK_DB_FILES_KNOWN_KNOWN = 1, ///< Match found in NSRL "known" file index TSK_DB_FILES_KNOWN_KNOWN = 1, ///< Match found in a "known" file index (such as NIST NSRL)and could be good or bad.
TSK_DB_FILES_KNOWN_KNOWN_BAD = 2, ///< Match found in "known bad" index TSK_DB_FILES_KNOWN_KNOWN_BAD = 2, ///< Match found in a "known bad" index
TSK_DB_FILES_KNOWN_KNOWN_GOOD = 3, ///< Match found in a "known good" index
} TSK_DB_FILES_KNOWN_ENUM; } TSK_DB_FILES_KNOWN_ENUM;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment