diff --git a/framework/Extraction/CarveExtract.h b/framework/Extraction/CarveExtract.h
index 4f8a14bdfeb9a61c1e7440dfcde687ab8e8c9831..e9f7c09ee6f440d6740e5728f94630f9a2de6107 100755
--- a/framework/Extraction/CarveExtract.h
+++ b/framework/Extraction/CarveExtract.h
@@ -13,11 +13,21 @@
#include "Services/TskImgDB.h"
+/**
+ * Interface for class that will carve a chunk of data.
+ * The design assumption is that the unallocated space has
+ * already been broken up into multiple chunks and the
+ * corresponding information for each chunk is stored in the
+ * ImgDB. The sequence in this class corresponds to the chunk ID
+ */
class TSK_FRAMEWORK_API CarveExtract
{
public:
virtual ~CarveExtract() = 0;
- /* @returns 1 on error */
+ /**
+ * @param sequence Id of chunk to carve
+ * @returns 1 on error
+ */
virtual int processFile(TskImgDB * imgDB, int sequence) = 0;
};
#endif
diff --git a/framework/Extraction/CarvePrep.h b/framework/Extraction/CarvePrep.h
index ee6da462187b3be50629b6d8e2e72568d3b53e11..a290233094274896f808b4c6d08a576eaac88861 100755
--- a/framework/Extraction/CarvePrep.h
+++ b/framework/Extraction/CarvePrep.h
@@ -13,11 +13,23 @@
#include "Services/TskImgDB.h"
+/**
+ * Interface for class that prepares for later carving.
+ * Prep and carving is separate so that the unallocated data to
+ * be carved can be broken up into smaller chunks and different
+ * nodes in a cluster could process each chunk. The prep step
+ * would make the chunks.
+ */
class TSK_FRAMEWORK_API CarvePrep
{
public:
virtual ~CarvePrep(void) = 0;
- /* @returns 1 on error */
+ /**
+ * a_img
+ * a_toSchedule True if the scheduler should be called to queue
+ * up the data or false if it shoudl be processed now.
+ * @returns 1 on error
+ */
virtual int processSectors(TskImgDB * a_img, bool a_toSchedule) = 0;
};
diff --git a/framework/Extraction/TskAutoImpl.h b/framework/Extraction/TskAutoImpl.h
index 5e5021225d43e76a87ccfb0a2e8272a818092dbd..46799710ee7923dd5b51b41d47055a7815dd8aa7 100755
--- a/framework/Extraction/TskAutoImpl.h
+++ b/framework/Extraction/TskAutoImpl.h
@@ -21,8 +21,9 @@
#include <map>
#include <string>
-/** \internal
- * C++ class that implements TskAuto to load file metadata into a database.
+/**
+ * Implements TskAuto and is used to analyze the data in a disk image
+ * and populate TskImgDB with the results.
*/
class TSK_FRAMEWORK_API TSKAutoImpl:public TskAuto {
public:
diff --git a/framework/Extraction/TskImageFile.h b/framework/Extraction/TskImageFile.h
index 132f2bd4bfdd5610e78ac7edf373bdd8c37fd503..ef8fdb23f847fd611151d6fc75d5c95d8e5bcffb 100755
--- a/framework/Extraction/TskImageFile.h
+++ b/framework/Extraction/TskImageFile.h
@@ -21,9 +21,8 @@
#include <vector>
#include <string>
-/// An interface to a disk image.
/**
- * TskImageFile defines an interface for interacting with a disk image.
+ * An interface to a class that allows low-level access to a disk image.
* It supports opening split image files, extracting file system
* information from the image and extracting data for a specific file
* or for a range of sectors.
@@ -35,12 +34,12 @@ class TSK_FRAMEWORK_API TskImageFile
virtual ~TskImageFile();
- /// Open the disk image represented by one or more actual files.
/**
+ * Open the disk image represented by one or more actual files.
* @param imageFiles One or more files that make up the disk image
* @return 0 on success and -1 on error
*/
- virtual int open(const std::vector<std::wstring> &) = 0;
+ virtual int open(const std::vector<std::wstring> &imageFiles) = 0;
// open the images in the DB
virtual int open() = 0;
@@ -112,4 +111,4 @@ class TSK_FRAMEWORK_API TskImageFile
};
-#endif
\ No newline at end of file
+#endif
diff --git a/framework/Extraction/TskImageFileTsk.h b/framework/Extraction/TskImageFileTsk.h
index 8581000763c4b6465b98347a10e6e420b74641a7..56ebf49654893ee188fc57a7f10a26e2947179f8 100755
--- a/framework/Extraction/TskImageFileTsk.h
+++ b/framework/Extraction/TskImageFileTsk.h
@@ -11,7 +11,7 @@
/**
* \file TskImageFile.h
- * An implementation of the TskImageFile class using The Sleuth Kit.
+ * An implementation of the TskImageFile class that uses The Sleuth Kit.
*/
#ifndef _TSK_IMAGEFILETSK_H
#define _TSK_IMAGEFILETSK_H
diff --git a/framework/File/FileManager.cpp b/framework/File/FileManager.cpp
index baee023b7ade295acecbe426227b807c5a43aafd..c3ec3ed5daecfd023c1cf17482136fd3dd9e6e71 100755
--- a/framework/File/FileManager.cpp
+++ b/framework/File/FileManager.cpp
@@ -15,16 +15,10 @@
#include "FileManager.h"
-/**
- *
- */
FileManager::FileManager()
{
}
-/**
- *
- */
FileManager::~FileManager()
{
}
diff --git a/framework/File/TskFile.h b/framework/File/TskFile.h
index 12292061ebff72014a06317088f3cb2c19e0294b..41365ed7394e523368fc2ebe40b6fa9966b1e237 100755
--- a/framework/File/TskFile.h
+++ b/framework/File/TskFile.h
@@ -23,8 +23,12 @@
#include "Services/TskImgDB.h"
/**
- * TskFile represents files that have been identified during
- * file extraction and which may be subject to analysis.
+ * An interface that is used to represent a file. This interface
+ * is used during the analysis of a file and is typically created
+ * based on data in TskImgDB, which was created by CarveExtract
+ * or TskImageFile. Different implementations of this class
+ * may retrieve file content and metadata in different ways.
+ * TskFile objects are obtained from TskFileManager.
*/
class TSK_FRAMEWORK_API TskFile
{
diff --git a/framework/File/TskFileManager.h b/framework/File/TskFileManager.h
index 65b3a5f04bd70463a05f2ec34bf1794c755a5626..c9da3cb4fe8a22fbcf53e50282e0d279adc3db76 100755
--- a/framework/File/TskFileManager.h
+++ b/framework/File/TskFileManager.h
@@ -20,8 +20,7 @@
#include "TskFile.h"
/**
- * TskFileManager is responsible for managing the lifetime
- * of TskFile objects in the system.
+ * Responsible for managing TskFile objects in the system.
*/
class TSK_FRAMEWORK_API TskFileManager
{
@@ -72,4 +71,4 @@ class TSK_FRAMEWORK_API TskFileManager
virtual ~TskFileManager() {};
};
-#endif
\ No newline at end of file
+#endif
diff --git a/framework/File/TskFileManagerImpl.h b/framework/File/TskFileManagerImpl.h
index ea5d415fd600be7501b2fba131b0845f33151dfb..48c5b72e2e2ec36c01efecc01bd264b9d00a2c95 100755
--- a/framework/File/TskFileManagerImpl.h
+++ b/framework/File/TskFileManagerImpl.h
@@ -23,8 +23,9 @@
#include "Poco/File.h"
/**
- * The TSKFileManagerImpl provides an implementation of the TskFileManager
- * interface that stores files based on their file ids.
+ * An implementation of the TskFileManager
+ * interface that stores files in a directory named 'files'
+ * based on their file ids.
*/
class TSK_FRAMEWORK_API TskFileManagerImpl : public TskFileManager
{
diff --git a/framework/File/TskFileTsk.cpp b/framework/File/TskFileTsk.cpp
index 031143902b83a325c5ea6534599eef8bd433f080..66527f6ca5a7c05cdb8481d3c34a6b88209132c8 100755
--- a/framework/File/TskFileTsk.cpp
+++ b/framework/File/TskFileTsk.cpp
@@ -9,7 +9,7 @@
*/
/**
- * \file TskFileTskTsk.cpp
+ * \file TskFileTsk.cpp
* Contains a Sleuthkit and Poco implementation of the TskFileTsk class.
*/
@@ -250,4 +250,4 @@ ssize_t TskFileTsk::read(char *buf, const size_t count)
ssize_t TskFileTsk::read(const int64_t offset, char *buf, const size_t count)
{
return 0;
-}
\ No newline at end of file
+}
diff --git a/framework/Pipeline/TskExecutableModule.h b/framework/Pipeline/TskExecutableModule.h
index 3ac12617b2eb26385239d65d410148da7566368c..1446409c2057bef9202f8d71daad5adc7366c303 100755
--- a/framework/Pipeline/TskExecutableModule.h
+++ b/framework/Pipeline/TskExecutableModule.h
@@ -14,8 +14,8 @@
#include "TskModule.h"
/**
- * An Executable Module supports launching a process to perform
- * some analysis on a File
+ * Supports launching a process via an executable file to perform
+ * some analysis on a TskFile object in a TskPipeline.
*/
class TSK_FRAMEWORK_API TskExecutableModule: public TskModule
{
diff --git a/framework/Pipeline/TskFileAnalysisPipeline.h b/framework/Pipeline/TskFileAnalysisPipeline.h
index 41fccfaa4cf38cca62e170de10c5b5051bf3b966..b1625b27e3cded86b7011d4656b8ef9059b8e71f 100755
--- a/framework/Pipeline/TskFileAnalysisPipeline.h
+++ b/framework/Pipeline/TskFileAnalysisPipeline.h
@@ -23,8 +23,9 @@
#include "TskFileAnalysisPluginModule.h"
/**
- * The File Analysis Pipeline class controls the processing of a File
- * through an ordered list of dynamically configured modules.
+ * Controls the processing of a TskFile
+ * through an ordered list of dynamically configured modules. The
+ * pipeline can contain one or more instances of TskModule.
*/
class TSK_FRAMEWORK_API TskFileAnalysisPipeline : public TskPipeline
{
diff --git a/framework/Pipeline/TskFileAnalysisPluginModule.h b/framework/Pipeline/TskFileAnalysisPluginModule.h
index 0c6f0c5adc0a40cf62cc7fb3e867162e0a8db370..712de47cee9887ea6f6883bc132a18f634c87269 100755
--- a/framework/Pipeline/TskFileAnalysisPluginModule.h
+++ b/framework/Pipeline/TskFileAnalysisPluginModule.h
@@ -16,8 +16,8 @@
#include "Poco/SharedLibrary.h"
/**
- * A Plugin Module supports the loading of custom libraries to perform
- * analysis on a File
+ * Supports the loading of custom dynamic libraries to perform
+ * analysis on a single TskFile
*/
class TSK_FRAMEWORK_API TskFileAnalysisPluginModule: public TskPluginModule
{
diff --git a/framework/Pipeline/TskModule.h b/framework/Pipeline/TskModule.h
index 3e44410a208a3504af0a4e3a333150716fb724cd..12407d56ccd1f98e03a91dbe13a4800f5a600d87 100755
--- a/framework/Pipeline/TskModule.h
+++ b/framework/Pipeline/TskModule.h
@@ -19,8 +19,10 @@
#include "File/TskFile.h"
/**
- * Base class for modules that perform some operation in the
- * context of a Pipeline.
+ * Interface for classes that represent different types of modules
+ * in the pipeline. Example module types include dynamic library
+ * and executables. These modules perform some operation in the
+ * context of a TskPipeline.
*/
class TSK_FRAMEWORK_API TskModule
{
diff --git a/framework/Pipeline/TskPipeline.h b/framework/Pipeline/TskPipeline.h
index 302a578a047f553968decadfe5dab05e104599f1..bface697ed68c0088df99a452be84b5de348dac5 100755
--- a/framework/Pipeline/TskPipeline.h
+++ b/framework/Pipeline/TskPipeline.h
@@ -25,7 +25,7 @@
#include "Poco/DOM/Element.h"
/**
- * The Pipeline class controls the processing of a File
+ * The Pipeline class controls the processing of a TskFile
* through an ordered list of dynamically configured modules.
*/
class TSK_FRAMEWORK_API TskPipeline
diff --git a/framework/Pipeline/TskPipelineManager.h b/framework/Pipeline/TskPipelineManager.h
index 8c2a988308982136b4374154f5e2c99458fc94f6..c945bc823c577e6060867434b80b1c48eebc91eb 100755
--- a/framework/Pipeline/TskPipelineManager.h
+++ b/framework/Pipeline/TskPipelineManager.h
@@ -20,7 +20,7 @@
#include "TskPipeline.h"
/**
- * The TskPipelineManager class is responsible for creation of Pipelines.
+ * Responsible for creation of TskPipelines and TskReportPipelines.
*/
class TSK_FRAMEWORK_API TskPipelineManager
{
@@ -44,4 +44,4 @@ class TSK_FRAMEWORK_API TskPipelineManager
std::vector<TskPipeline *> m_pipelines;
};
-#endif
\ No newline at end of file
+#endif
diff --git a/framework/Pipeline/TskPluginModule.h b/framework/Pipeline/TskPluginModule.h
index cacbc2d2c2a55c4a279cdd0875641ce1d138f6a6..040790b53db28111bfa268cc46da6a13538179f1 100755
--- a/framework/Pipeline/TskPluginModule.h
+++ b/framework/Pipeline/TskPluginModule.h
@@ -16,8 +16,8 @@
#include "Poco/SharedLibrary.h"
/**
- * A Plugin Module supports the loading of custom libraries to perform
- * analysis on a File
+ * Supports the loading of a custom dynamic library to perform
+ * analysis in either a TskPipeline or TskReportPipeline.
*/
class TSK_FRAMEWORK_API TskPluginModule: public TskModule
{
diff --git a/framework/Pipeline/TskReportPipeline.h b/framework/Pipeline/TskReportPipeline.h
index 7ff48e8606ecacda7336cf367e79a960630ffe1c..b5665e77b740c3d2d26ff386d479b1b17e692109 100755
--- a/framework/Pipeline/TskReportPipeline.h
+++ b/framework/Pipeline/TskReportPipeline.h
@@ -22,8 +22,10 @@
#include "TskReportPluginModule.h"
/**
- * The Report Pipeline class controls reporting
- * through an ordered list of dynamically configured modules.
+ * Controls a series of reporting modules that are run
+ * after all of the file-specific analysis modules are run.
+ * The reporting pipeline can contain one or more TskModule
+ * modules.
*/
class TSK_FRAMEWORK_API TskReportPipeline : public TskPipeline
{
diff --git a/framework/Pipeline/TskReportPluginModule.h b/framework/Pipeline/TskReportPluginModule.h
index 38a39ee97edea4f9377c45f35cf4a11ce46a1e1c..41ee6028615cd3c2efcd35c4576f0d21ff5cda61 100755
--- a/framework/Pipeline/TskReportPluginModule.h
+++ b/framework/Pipeline/TskReportPluginModule.h
@@ -16,8 +16,8 @@
#include "Poco/SharedLibrary.h"
/**
- * A Plugin Module supports the loading of custom libraries to perform
- * reporting.
+ * Supports the loading of custom dynamic libraries to perform
+ * reporting and post-processing in a TskReportPipeline.
*/
class TSK_FRAMEWORK_API TskReportPluginModule: public TskPluginModule
{
diff --git a/framework/Services/Log.cpp b/framework/Services/Log.cpp
index 15ec213a9c21dd0213a3754cd28c1762c026b0dd..3218fe98f49a572426a9dde34e18947e36279e27 100755
--- a/framework/Services/Log.cpp
+++ b/framework/Services/Log.cpp
@@ -84,9 +84,9 @@ void Log::log(Channel a_channel, const std::wstring &a_msg)
newtime.tm_mon+1,newtime.tm_mday,newtime.tm_year % 100,
newtime.tm_hour, newtime.tm_min, newtime.tm_sec);
- /* BC: For some unknown reason, when we had this enabled, StegCarver
+ /* BC: For some unknown reason, when we had this enabled, the carver
* would miss files that it would otherwise find. Not sure why. It may have
- * to do with StegCarver producing so much data to stderr that this got in
+ * to do with the carver producing so much data to stderr that this got in
* its way... Disabling since the log should be the primary source of debug
* data anyway. */
//fwprintf(stderr, L"%S %s %s\n", timeStr, level, a_msg);
diff --git a/framework/Services/Log.h b/framework/Services/Log.h
index b3504e2b94364b98c6c3c4cdf5f8288ac6976200..ba61ac9c0754c78c7ce864e179c3b67a5a5fe0c4 100755
--- a/framework/Services/Log.h
+++ b/framework/Services/Log.h
@@ -19,6 +19,12 @@
#define LOGWARN(msg) TskServices::Instance().getLog().logWarn(msg)
#define LOGINFO(msg) TskServices::Instance().getLog().logInfo(msg)
+/**
+ * Logging class to enable the framework, apps that use it, and modules to
+ * log error and warning messages. The default implementation writes
+ * the log messages to a file, but it can be extended by another class.
+ * Can be registered with and retrieved from TskServices.
+ */
class TSK_FRAMEWORK_API Log
{
public:
diff --git a/framework/Services/Scheduler.h b/framework/Services/Scheduler.h
index ab13933c9e5639143ef0b610c07d6acc32f6d661..e2f8c6f6b1afba1b5d7f171d5bb3f780591a8ae4 100755
--- a/framework/Services/Scheduler.h
+++ b/framework/Services/Scheduler.h
@@ -13,6 +13,11 @@
#include "framework_i.h"
+/**
+ * Interface for class that will handle scheduling tasks in a
+ * distributed system / cluster of nodes.
+ * Can be registered with and retrieved from TskServices.
+ */
class TSK_FRAMEWORK_API Scheduler
{
public:
diff --git a/framework/Services/TskBlackboard.h b/framework/Services/TskBlackboard.h
index 3c854380d2594b2cd5557b457a76c2791a40df2a..8f4a034238f2deb38871d9e11f4f733e57ba3535 100755
--- a/framework/Services/TskBlackboard.h
+++ b/framework/Services/TskBlackboard.h
@@ -10,7 +10,9 @@
/**
* \file TskBlackboard.h
- * Contains the interface for the TskBlackboard class.
+ * Interface for class that will implement the black board. The black board
+ * is used to store data from analysis modules. The data is available to
+ * later modules in the pipeline and in the final reporting phase.
*/
#ifndef _TSK_BLACKBOARD_H
@@ -26,6 +28,8 @@ using namespace std;
/**
* An interface for setting and retrieving name/value pairs to the blackboard.
+ * The blackboard is used to store data for use by later modules in the pipeline.
+ * Can be registered with and retrieved from TskServices.
*/
class TSK_FRAMEWORK_API TskBlackboard
{
diff --git a/framework/Services/TskDBBlackboard.h b/framework/Services/TskDBBlackboard.h
index ec8026ab07806b41175e3f98de96881e651563e4..6e3273383c39c24927aab9825b0f02a51378d81f 100755
--- a/framework/Services/TskDBBlackboard.h
+++ b/framework/Services/TskDBBlackboard.h
@@ -23,7 +23,8 @@
#include "Services/TskServices.h"
/**
- * A class for setting and retrieving name/value pairs to the blackboard, using TskImgDB for storage.
+ * An implementation of TskBlackboard that stores the name / value pairs
+ * in the TskImgDB.
*/
class TSK_FRAMEWORK_API TskDBBlackboard : public TskBlackboard
{
diff --git a/framework/Services/TskImgDB.h b/framework/Services/TskImgDB.h
index 93e00b8ffcb3cf9da965c65ed343e34c47f6d6e7..0c67302ff3940cba8de86eae34b39f31d0e6adb3 100755
--- a/framework/Services/TskImgDB.h
+++ b/framework/Services/TskImgDB.h
@@ -9,10 +9,6 @@
* This software is distributed under the Common Public License 1.0
*/
-/**
- * \file TskImgDB.h
- * Interface to the framework data model.
- */
#ifndef _TSK_IMGDB_H
#define _TSK_IMGDB_H
@@ -31,7 +27,9 @@ using namespace std;
typedef uint64_t artifact_t;
-/// TskFileRecord is a database file record
+/**
+ * Contains data from a file record in the database.
+ */
struct TskFileRecord
{
uint64_t fileId;
@@ -58,6 +56,9 @@ struct TskFileRecord
std::string fullPath;
};
+/**
+ * Contains data from a volume/partition record in the database.
+ */
struct TskVolumeInfoRecord
{
int vol_id;
@@ -67,6 +68,9 @@ struct TskVolumeInfoRecord
int flags;
};
+/**
+ * Contains data from a file system record in the database.
+ */
struct TskFsInfoRecord
{
int fs_id;
@@ -87,6 +91,9 @@ struct TskFileTypeRecord
uint64_t count; // count of files with this extension.
};
+/**
+ * Contains data about the module return status for a given file (as recorded in the database)
+ */
struct TskModuleStatus
{
uint64_t file_id;
@@ -94,6 +101,9 @@ struct TskModuleStatus
int status;
};
+/**
+ * Contains data for a blackboard entry for a given file and artifact ID
+ */
struct TskBlackboardRecord
{
artifact_t artifactId;
@@ -115,12 +125,19 @@ struct TskBlackboardRecord
TskBlackboardRecord() {}
};
+/**
+ * Contains data about the current status for an unallocated chunk of data.
+ */
struct TskUnallocImgStatusRecord
{
int unallocImgId;
int status; // UNALLOC_IMG_STATUS
};
+/**
+ * Contains data about the mapping of data in the unallocated chunks back
+ * to their original location in the disk image.
+ */
struct TskAllocUnallocMapRecord
{
int vol_id;
@@ -130,6 +147,9 @@ struct TskAllocUnallocMapRecord
uint64_t orig_img_sect_start;
};
+/**
+ * contains data about the 'unused sectors', which did not have carvable data.
+ */
struct TskUnusedSectorsRecord
{
uint64_t fileId;
@@ -137,9 +157,11 @@ struct TskUnusedSectorsRecord
uint64_t sectLen;
};
-/// TskImgDB is an interface to the framework data model.
/**
- *
+ * Interface for class that implments database storage for an image.
+ * The database will be used to store information about the data
+ * being analyzed.
+ * Can be registered with and retrieved from TskServices.
*/
class TSK_FRAMEWORK_API TskImgDB
{
diff --git a/framework/Services/TskImgDBSqlite.h b/framework/Services/TskImgDBSqlite.h
index f29acb7454870090f43031ba146b96e259881fbf..e620336c53bcc5952a175babdcc6afed66dadb7e 100755
--- a/framework/Services/TskImgDBSqlite.h
+++ b/framework/Services/TskImgDBSqlite.h
@@ -29,7 +29,9 @@ using namespace std;
#include "tsk3/libtsk.h"
#include "tsk3/auto/sqlite3.h"
-/// Framework data access layer the uses SQLite as the back end.
+/**
+ * Implementation of TskImgDB that uses SQLite to store the data.
+ */
class TSK_FRAMEWORK_API TskImgDBSqlite : public TskImgDB
{
public:
diff --git a/framework/Services/TskServices.h b/framework/Services/TskServices.h
index b3be2749381db2c56383e0d5182d45d681882fbd..7216f5af28ec5d63331c51849ee92934b56bf233 100755
--- a/framework/Services/TskServices.h
+++ b/framework/Services/TskServices.h
@@ -18,70 +18,75 @@
#include "Services/TskBlackboard.h"
#include "Services/TskSystemProperties.h"
-// TskServices class provide singleton access to framework services.
+/**
+ * Provices singleton access to many framework services. This is used
+ * to register and access the classes that implement the services.
+ */
class TSK_FRAMEWORK_API TskServices
{
public:
- static TskServices &Instance(); // singleton
+ /**
+ * Singleton interface to return the TskServices instance.
+ */
+ static TskServices &Instance();
- // Return a Log instance. If there is no existing Log, it will be created in the current directory with a timestamp.
- // Return 0 if no Log is created.
+ /** Return a Log instance. If there is no existing Log, it will be created in the current directory with a timestamp.
+ * @returns 0 if no Log is created. */
Log& getLog();
- // Register a log implementation with the framework.
+ /** Register a log implementation with the framework. */
void setLog(Log &log);
- // Register a Scheduler implementation with the framework.
+ /** Register a Scheduler implementation with the framework */
void setScheduler(Scheduler &scheduler);
- // Return the Secheduler instance.
- // Return 0 if no Scheduler was set.
+ /** Return the Secheduler instance.
+ * @returns 0 if no Scheduler was set. */
Scheduler& getScheduler();
- /// Register a TskImgDB implementation with the framework.
- /**
+ /** Register a TskImgDB implementation with the framework.
* @param imgDB The TskImgDB implementation to register
*/
void setImgDB(TskImgDB& imgDB);
- /// Return the registered TskImgDB.
/**
+ * Return the registered TskImgDB.
* @return The registered TskImgDB implementation or NULL
*/
TskImgDB& getImgDB();
- /// Register an TskImageFile implementation with the framework.
/**
- * @param imageFile The TskImageFile implementation to register
+ * Register an TskImageFile implementation with the framework.
+ * @param imgFile The TskImageFile implementation to register
*/
void setImageFile(TskImageFile& imgFile);
- /// Return the registered TskImageFile.
/**
+ * Return the registered TskImageFile.
* @return The registered TskImageFile implementation or NULL
*/
TskImageFile& getImageFile();
- /// Register an TskBlackboard implementation with the framework.
/**
+ * Register an TskBlackboard implementation with the framework.
* @param blackboard The TskBlackboard implementation to register
*/
void setBlackboard(TskBlackboard& blackboard);
- /// Return the registered TskBlackboard.
/**
+ * Return the registered TskBlackboard.
* @return The registered TskBlackboard implementation or NULL
*/
TskBlackboard& getBlackboard();
- /// Register an TskSystemProperties implementation with the framework.
/**
+ * Register an TskSystemProperties implementation with the framework.
* @param systemProperties The TskSystemProperties implementation to register
*/
void setSystemProperties(TskSystemProperties& systemProperties);
- /// Return the registered TskSystemProperties.
/**
+ * Return the registered TskSystemProperties.
* @return The registered TskSystemProperties implementation or NULL
*/
TskSystemProperties& getSystemProperties();
@@ -104,4 +109,4 @@ class TSK_FRAMEWORK_API TskServices
TskBlackboard * m_blackboard;
TskSystemProperties * m_systemProperties;
};
-#endif
\ No newline at end of file
+#endif
diff --git a/framework/Services/TskSystemProperties.h b/framework/Services/TskSystemProperties.h
index 426b0cdc2f0b6ecb4fa79f73a645974a1d8d0ced..cbfe27d2ee63bc62c59d5ae68bec7d3036eb273f 100755
--- a/framework/Services/TskSystemProperties.h
+++ b/framework/Services/TskSystemProperties.h
@@ -24,7 +24,10 @@
#define TSK_SYS_PROP_SET(name, value) TskServices::Instance().getSystemProperties().set((name), (value))
/**
- * An interface for setting and retrieving name/value pairs.
+ * An interface for setting and retrieving system-wide name/value pairs.
+ * Typically used to store system settings so that all modules and
+ * classes can access the settings, which can be set from a config file.
+ * Can be registered with and retrieved from TskServices.
*/
class TSK_FRAMEWORK_API TskSystemProperties
{
@@ -47,4 +50,4 @@ class TSK_FRAMEWORK_API TskSystemProperties
};
-#endif
\ No newline at end of file
+#endif
diff --git a/framework/Services/TskSystemPropertiesImpl.h b/framework/Services/TskSystemPropertiesImpl.h
index 11b8ca075b168b677d9599f5679e2c141fc5a97f..c2603d48aaa073b114bb9edfc70d6e236e47e3b4 100755
--- a/framework/Services/TskSystemPropertiesImpl.h
+++ b/framework/Services/TskSystemPropertiesImpl.h
@@ -26,8 +26,9 @@
#include "Poco/Util/AbstractConfiguration.h"
/**
- * A singleton that wraps a Poco AbstractConfiguration
- * class to set and retrieve name/value pairs.
+ * An implementation of TskSystemProperties that uses Poco
+ * AbstractConfiguration class to set and retrieve name/value
+ * pairs from an XML file.
*/
class TSK_FRAMEWORK_API TskSystemPropertiesImpl : public TskSystemProperties
{
@@ -64,4 +65,4 @@ class TSK_FRAMEWORK_API TskSystemPropertiesImpl : public TskSystemProperties
Poco::Util::AbstractConfiguration * m_abstractConfig;
};
-#endif
\ No newline at end of file
+#endif
diff --git a/framework/Utilities/SectorRuns.cpp b/framework/Utilities/SectorRuns.cpp
index 3ce048bb921124fcb89a66d0216a854250bb6fc1..186761b15bf7441aab9f1de7c455b1f1b6e2528a 100755
--- a/framework/Utilities/SectorRuns.cpp
+++ b/framework/Utilities/SectorRuns.cpp
@@ -118,8 +118,8 @@ int SectorRuns::getVolID() const
/**
* Read data in the current entry into the buffer.
*
- * @param a_offset Sector offset to start reading from (relative to start of current sector run)
- * @param a_len Number of sectors to read
+ * @param a_offsetSect Sector offset to start reading from (relative to start of current sector run)
+ * @param a_lenSect Number of sectors to read
* @param a_buffer Buffer to read into (must be of size a_len * 512 or larger)
* @returns -1 on error or number of sectors read
*/
diff --git a/framework/Utilities/SectorRuns.h b/framework/Utilities/SectorRuns.h
index f58494040155279a86992959e977bcef8a377ce5..a6837a1b1c77acc7f1ac3b44e559f4381684956a 100755
--- a/framework/Utilities/SectorRuns.h
+++ b/framework/Utilities/SectorRuns.h
@@ -13,6 +13,11 @@
#include "framework_i.h"
+/**
+ * Stores a list of runs (which have a starting sector and length).
+ * Can be used to store information about a file, unused areas of an
+ * image, or ...
+ */
class TSK_FRAMEWORK_API SectorRuns
{
public:
diff --git a/framework/Utilities/TskException.h b/framework/Utilities/TskException.h
index f8557ecb0f79ddf412127f7ed92ad14f3b46a22e..bb2c084ae8c25000fbb0213102fa21ddcf4cf2c8 100755
--- a/framework/Utilities/TskException.h
+++ b/framework/Utilities/TskException.h
@@ -21,6 +21,9 @@
#include "framework_i.h"
+/**
+ * Framework exception class
+ */
class TSK_FRAMEWORK_API TskException : public std::exception
{
public:
@@ -134,4 +137,4 @@ TSK_DECLARE_EXCEPTION(TskNullPointerException, TskException)
TSK_DECLARE_EXCEPTION(TskFileNotFoundException, TskFileException)
TSK_DECLARE_EXCEPTION(TskSystemPropertiesException, TskException)
-#endif
\ No newline at end of file
+#endif
diff --git a/framework/Utilities/TskUtilities.h b/framework/Utilities/TskUtilities.h
index 170ea45aa1d79bee0f96ceec7a0ada8b2461904e..f50c1a21cb8cb60c3ff4d878e04aa6c4f7275f4b 100755
--- a/framework/Utilities/TskUtilities.h
+++ b/framework/Utilities/TskUtilities.h
@@ -22,7 +22,8 @@
#include "framework_i.h"
/**
- * An interface containing common utility methods.
+ * Contains commonly needed utility methods. Refer to the poco library
+ * for other commonly needed methods.
*/
class TSK_FRAMEWORK_API TskUtilities
{
diff --git a/framework/Utilities/UnallocRun.h b/framework/Utilities/UnallocRun.h
index e824b3549f42095d4a72b640b9605e9339ed085a..7df657dd6142f573be09b89f51eb3609479a40de 100755
--- a/framework/Utilities/UnallocRun.h
+++ b/framework/Utilities/UnallocRun.h
@@ -13,6 +13,11 @@
#include "framework_i.h"
+/**
+ * Stores information that can map a region in the original disk image
+ * to a region in one of the chunks of unallocated space (as created by
+ * the CarvePrep implementation.
+ */
class TSK_FRAMEWORK_API UnallocRun
{
public:
diff --git a/framework/docs/Doxyfile b/framework/docs/Doxyfile
new file mode 100644
index 0000000000000000000000000000000000000000..706e7a529e39314ce411256cf0ecd83c2ff61748
--- /dev/null
+++ b/framework/docs/Doxyfile
@@ -0,0 +1,1521 @@
+# Doxyfile 1.5.9
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+# All text after a hash (#) is considered a comment and will be ignored
+# The format is:
+# TAG = value [value, ...]
+# For lists items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (" ")
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
+# iconv built into libc) for the transcoding. See
+# http://www.gnu.org/software/libiconv for the list of possible encodings.
+
+DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
+# by quotes) that should identify the project.
+
+PROJECT_NAME = "The Sleuth Kit Framework"
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
+# This could be handy for archiving the generated documentation or
+# if some version control system is used.
+
+PROJECT_NUMBER = ?
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+# base path where the generated documentation will be put.
+# If a relative path is entered, it will be relative to the location
+# where doxygen was started. If left blank the current directory will be used.
+
+OUTPUT_DIRECTORY = ../www/docs
+
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
+# 4096 sub-directories (in 2 levels) under the output directory of each output
+# format and will distribute the generated files over these directories.
+# Enabling this option can be useful when feeding doxygen a huge amount of
+# source files, where putting all generated files in the same directory would
+# otherwise cause performance problems for the file system.
+
+CREATE_SUBDIRS = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# The default language is English, other supported languages are:
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
+# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
+# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
+# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
+# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
+# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
+
+OUTPUT_LANGUAGE = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
+# include brief member descriptions after the members that are listed in
+# the file and class documentation (similar to JavaDoc).
+# Set to NO to disable this.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
+# the brief description of a member or function before the detailed description.
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+
+REPEAT_BRIEF = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator
+# that is used to form the text in various listings. Each string
+# in this list, if found as the leading text of the brief description, will be
+# stripped from the text and the result after processing the whole list, is
+# used as the annotated text. Otherwise, the brief description is used as-is.
+# If left blank, the following values are used ("$name" is automatically
+# replaced with the name of the entity): "The $name class" "The $name widget"
+# "The $name file" "is" "provides" "specifies" "contains"
+# "represents" "a" "an" "the"
+
+ABBREVIATE_BRIEF =
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# Doxygen will generate a detailed section even if there is only a brief
+# description.
+
+ALWAYS_DETAILED_SEC = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
+# path before files name in the file list and in the header files. If set
+# to NO the shortest path that makes the file name unique will be used.
+
+FULL_PATH_NAMES = YES
+
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
+# can be used to strip a user-defined part of the path. Stripping is
+# only done if one of the specified strings matches the left-hand part of
+# the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the
+# path to strip.
+
+STRIP_FROM_PATH =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
+# the path mentioned in the documentation of a class, which tells
+# the reader which header file to include in order to use a class.
+# If left blank only the name of the header file containing the class
+# definition is used. Otherwise one should specify the include paths that
+# are normally passed to the compiler using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
+# (but less readable) file names. This can be useful is your file systems
+# doesn't support long names like on DOS, Mac, or CD-ROM.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
+# will interpret the first line (until the first dot) of a JavaDoc-style
+# comment as the brief description. If set to NO, the JavaDoc
+# comments will behave just like regular Qt-style comments
+# (thus requiring an explicit @brief command for a brief description.)
+
+JAVADOC_AUTOBRIEF = YES
+
+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
+# interpret the first line (until the first dot) of a Qt-style
+# comment as the brief description. If set to NO, the comments
+# will behave just like regular Qt-style comments (thus requiring
+# an explicit \brief command for a brief description.)
+
+QT_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
+# comments) as a brief description. This used to be the default behaviour.
+# The new default is to treat a multi-line C++ comment block as a detailed
+# description. Set this tag to YES if you prefer the old behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# re-implements.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
+# a new page for each member. If set to NO, the documentation of a member will
+# be part of the file/class/namespace that contains it.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
+# Doxygen uses this value to replace tabs by spaces in code fragments.
+
+TAB_SIZE = 8
+
+# This tag can be used to specify a number of aliases that acts
+# as commands in the documentation. An alias has the form "name=value".
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
+# put the command \sideeffect (or @sideeffect) in the documentation, which
+# will result in a user-defined paragraph with heading "Side Effects:".
+# You can put \n's in the value part of an alias to insert newlines.
+
+ALIASES =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
+# sources only. Doxygen will then generate output that is more tailored for C.
+# For instance, some of the names that are used will be different. The list
+# of all members will be omitted, etc.
+
+OPTIMIZE_OUTPUT_FOR_C = NO
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
+# sources only. Doxygen will then generate output that is more tailored for
+# Java. For instance, namespaces will be presented as packages, qualified
+# scopes will look different, etc.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources only. Doxygen will then generate output that is more tailored for
+# Fortran.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for
+# VHDL.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# Doxygen selects the parser to use depending on the extension of the files it parses.
+# With this tag you can assign which parser to use for a given extension.
+# Doxygen has a built-in mapping, but you can override or extend it using this tag.
+# The format is ext=language, where ext is a file extension, and language is one of
+# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
+# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
+# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
+# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
+
+EXTENSION_MAPPING =
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should
+# set this tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
+# func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
+# Doxygen will parse them like normal C++ but will assume all classes use public
+# instead of private inheritance when no explicit protection keyword is present.
+
+SIP_SUPPORT = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate getter
+# and setter methods for a property. Setting this option to YES (the default)
+# will make doxygen to replace the get and set methods by a property in the
+# documentation. This will only work if the methods are indeed getting or
+# setting a simple type. If this is not the case, or you want to show the
+# methods anyway, you should set this option to NO.
+
+IDL_PROPERTY_SUPPORT = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
+# the same type (for instance a group of public functions) to be put as a
+# subgroup of that type (e.g. under the Public Functions section). Set it to
+# NO to prevent subgrouping. Alternatively, this can be done per class using
+# the \nosubgrouping command.
+
+SUBGROUPING = YES
+
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
+# is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically
+# be useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+
+TYPEDEF_HIDES_STRUCT = NO
+
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
+# determine which symbols to keep in memory and which to flush to disk.
+# When the cache is full, less often used symbols will be written to disk.
+# For small to medium size projects (<1000 input files) the default value is
+# probably good enough. For larger projects a too small cache size can cause
+# doxygen to be busy swapping symbols to and from disk most of the time
+# causing a significant performance penality.
+# If the system has enough physical memory increasing the cache will improve the
+# performance by keeping more symbols in memory. Note that the value works on
+# a logarithmic scale so increasing the size by one will rougly double the
+# memory usage. The cache size is given by this formula:
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
+# corresponding to a cache size of 2^16 = 65536 symbols
+
+SYMBOL_CACHE_SIZE = 0
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available.
+# Private class members and static file members will be hidden unless
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL = NO
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE = NO
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
+# will be included in the documentation.
+
+EXTRACT_STATIC = NO
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES = NO
+
+# This flag is only useful for Objective-C code. When set to YES local
+# methods, which are defined in the implementation section but not in
+# the interface are included in the documentation.
+# If set to NO (the default) only methods in the interface are included.
+
+EXTRACT_LOCAL_METHODS = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base
+# name of the file that contains the anonymous namespace. By default
+# anonymous namespace are hidden.
+
+EXTRACT_ANON_NSPACES = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) these members will be included in the
+# various overviews, but no documentation section is generated.
+# This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy.
+# If set to NO (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
+# documentation.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
+# documentation blocks found inside the body of a function.
+# If set to NO (the default) these blocks will be appended to the
+# function's detailed documentation block.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation
+# that is typed after a \internal command is included. If the tag is set
+# to NO (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+INTERNAL_DOCS = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
+# file names in lower-case letters. If set to YES upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# and Mac users are advised to set this option to NO.
+
+CASE_SENSE_NAMES = YES
+
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
+# will show members with their full class and namespace scopes in the
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
+# will sort the (detailed) documentation of file and class members
+# alphabetically by member name. If set to NO the members will appear in
+# declaration order.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
+# brief documentation of file, namespace and class members alphabetically
+# by member name. If set to NO (the default) the members will appear in
+# declaration order.
+
+SORT_BRIEF_DOCS = YES
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
+# hierarchy of group names into alphabetical order. If set to NO (the default)
+# the group names will appear in their defined order.
+
+SORT_GROUP_NAMES = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
+# sorted by fully-qualified names, including namespaces. If set to
+# NO (the default), the class list will be sorted only by class name,
+# not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the
+# alphabetical list.
+
+SORT_BY_SCOPE_NAME = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
+# disable (NO) the todo list. This list is created by putting \todo
+# commands in the documentation.
+
+GENERATE_TODOLIST = NO
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
+# disable (NO) the test list. This list is created by putting \test
+# commands in the documentation.
+
+GENERATE_TESTLIST = NO
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
+# disable (NO) the bug list. This list is created by putting \bug
+# commands in the documentation.
+
+GENERATE_BUGLIST = NO
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
+# disable (NO) the deprecated list. This list is created by putting
+# \deprecated commands in the documentation.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by \if sectionname ... \endif.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or define consists of for it to appear in
+# the documentation. If the initializer consists of more lines than specified
+# here it will be hidden. Use a value of 0 to hide initializers completely.
+# The appearance of the initializer of individual variables and defines in the
+# documentation can be controlled using \showinitializer or \hideinitializer
+# command in the documentation regardless of this setting.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES = YES
+
+# If the sources in your project are distributed over multiple directories
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
+# in the documentation. The default is NO.
+
+SHOW_DIRECTORIES = NO
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
+# This will remove the Files entry from the Quick Index and from the
+# Folder Tree View (if specified). The default is YES.
+
+SHOW_FILES = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
+# Namespaces page.
+# This will remove the Namespaces entry from the Quick Index
+# and from the Folder Tree View (if specified). The default is YES.
+
+SHOW_NAMESPACES = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command <command> <input-file>, where <command> is the value of
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
+# provided by doxygen. Whatever the program writes to standard output
+# is used as the file version. See the manual for examples.
+
+FILE_VERSION_FILTER =
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
+# doxygen. The layout file controls the global structure of the generated output files
+# in an output format independent way. The create the layout file that represents
+# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
+# file name after the option, if omitted DoxygenLayout.xml will be used as the name
+# of the layout file.
+
+LAYOUT_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS = YES
+
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
+# automatically be disabled.
+
+WARN_IF_UNDOCUMENTED = NO
+
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some
+# parameters in a documented function, or documenting parameters that
+# don't exist or using markup commands wrongly.
+
+WARN_IF_DOC_ERROR = YES
+
+# This WARN_NO_PARAMDOC option can be abled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+
+WARN_NO_PARAMDOC = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that
+# doxygen can produce. The string should contain the $file, $line, and $text
+# tags, which will be replaced by the file and line number from which the
+# warning originated and the warning text. Optionally the format may contain
+# $version, which will be replaced by the version of the file (if it could
+# be obtained via FILE_VERSION_FILTER)
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning
+# and error messages should be written. If left blank the output is written
+# to stderr.
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
+# with spaces.
+
+INPUT = framework/docs/main.dox \
+ framework/Extraction \
+ framework/File \
+ framework/Pipeline \
+ framework/Reporting \
+ framework/Services \
+ framework/Utilities
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
+# also the default input encoding. Doxygen uses libiconv (or the iconv built
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
+# the list of possible encodings.
+
+INPUT_ENCODING = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank the following patterns are tested:
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
+
+FILE_PATTERNS = *.c *.cpp \
+ *.h
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
+# should be searched for input files as well. Possible values are YES and NO.
+# If left blank NO is used.
+
+RECURSIVE = NO
+
+# The EXCLUDE tag can be used to specify files and/or directories that should
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
+# directories that are symbolic links (a Unix filesystem feature) are excluded
+# from the input.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+
+EXCLUDE_SYMBOLS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or
+# directories that contain example code fragments that are included (see
+# the \include command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank all files are included.
+
+EXAMPLE_PATTERNS =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude
+# commands irrespective of the value of the RECURSIVE tag.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are included in the documentation (see
+# the \image command).
+
+IMAGE_PATH =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
+# input file. Doxygen will then use the output that the filter program writes
+# to standard output.
+# If FILTER_PATTERNS is specified, this tag will be
+# ignored.
+
+INPUT_FILTER =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis.
+# Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match.
+# The filters are a list of the form:
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
+# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
+# is applied to all files.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
+# be generated. Documented entities will be cross-referenced with these sources.
+# Note: To get rid of all source code in the generated output, make sure also
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C and C++ comments will always remain visible.
+
+STRIP_CODE_COMMENTS = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = YES
+
+# If the REFERENCES_RELATION tag is set to YES
+# then for each documented function all documented entities
+# called/used by that function will be listed.
+
+REFERENCES_RELATION = YES
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
+# link to the source code.
+# Otherwise they will link to the documentation.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code
+# will point to the HTML generated by the htags(1) tool instead of doxygen
+# built-in source browser. The htags tool is part of GNU's global source
+# tagging system (see http://www.gnu.org/software/global/global.html). You
+# will need version 4.8.6 or higher.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
+# will generate a verbatim copy of the header file for each class for
+# which an include is specified. Set to NO to disable this.
+
+VERBATIM_HEADERS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
+# of all compounds will be generated. Enable this if the project
+# contains a lot of classes, structs, unions or interfaces.
+
+ALPHABETICAL_INDEX = NO
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all
+# classes will be put under the same header in the alphabetical index.
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT = framework-docs
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER = framework/docs/footer.html
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
+# style sheet that is used by each HTML page. It can be used to
+# fine-tune the look of the HTML output. If the tag is left blank doxygen
+# will generate a default style sheet. Note that doxygen will try to copy
+# the style sheet file to the HTML output directory, so don't put your own
+# stylesheet in the HTML output directory as well, or it will be erased!
+
+HTML_STYLESHEET =
+
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
+# files or namespaces will be aligned in HTML using tables. If set to
+# NO a bullet list will be used.
+
+HTML_ALIGN_MEMBERS = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded. For this to work a browser that supports
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
+
+HTML_DYNAMIC_SECTIONS = NO
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files
+# will be generated that can be used as input for Apple's Xcode 3
+# integrated development environment, introduced with OSX 10.5 (Leopard).
+# To create a documentation set, doxygen will generate a Makefile in the
+# HTML output directory. Running make will produce the docset in that
+# directory and running "make install" will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
+# it at startup.
+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
+
+GENERATE_DOCSET = NO
+
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
+# feed. A documentation feed provides an umbrella under which multiple
+# documentation sets from a single provider (such as a company or product suite)
+# can be grouped.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
+# should uniquely identify the documentation set bundle. This should be a
+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
+# will append .docset to the name.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
+# be used to specify the file name of the resulting .chm file. You
+# can add a path in front of the file if the result should not be
+# written to the html output directory.
+
+CHM_FILE =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
+# be used to specify the location (absolute path including file name) of
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
+# the HTML help compiler on the generated index.hhp.
+
+HHC_LOCATION =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
+# controls if a separate .chi index file is generated (YES) or that
+# it should be included in the master .chm file (NO).
+
+GENERATE_CHI = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
+# content.
+
+CHM_INDEX_ENCODING =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
+# controls whether a binary table of contents is generated (YES) or a
+# normal table of contents (NO) in the .chm file.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
+# to the contents of the HTML help documentation and to the tree view.
+
+TOC_EXPAND = NO
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
+# are set, an additional index file will be generated that can be used as input for
+# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
+# HTML documentation.
+
+GENERATE_QHP = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
+# be used to specify the file name of the resulting .qch file.
+# The path specified is relative to the HTML output folder.
+
+QCH_FILE =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#namespace
+
+QHP_NAMESPACE =
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#virtual-folders
+
+QHP_VIRTUAL_FOLDER = doc
+
+# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
+# For more information please see
+# http://doc.trolltech.com/qthelpproject.html#custom-filters
+
+QHP_CUST_FILTER_NAME =
+
+# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
+# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
+
+QHP_CUST_FILTER_ATTRS =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
+# filter section matches.
+# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
+
+QHP_SECT_FILTER_ATTRS =
+
+# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
+# be used to specify the location of Qt's qhelpgenerator.
+# If non-empty doxygen will try to run qhelpgenerator on the generated
+# .qhp file.
+
+QHG_LOCATION =
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
+# top of each HTML page. The value NO (the default) enables the index and
+# the value YES disables it.
+
+DISABLE_INDEX = NO
+
+# This tag can be used to set the number of enum values (range [1..20])
+# that doxygen will group on one line in the generated HTML documentation.
+
+ENUM_VALUES_PER_LINE = 4
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information.
+# If the tag value is set to FRAME, a side panel will be generated
+# containing a tree-like index structure (just like the one that
+# is generated for HTML Help). For this to work a browser that supports
+# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
+# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
+# probably better off using the HTML help feature. Other possible values
+# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
+# and Class Hierarchy pages using a tree view instead of an ordered list;
+# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
+# disables this behavior completely. For backwards compatibility with previous
+# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
+# respectively.
+
+GENERATE_TREEVIEW = NO
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
+# used to set the initial width (in pixels) of the frame in which the tree
+# is shown.
+
+TREEVIEW_WIDTH = 250
+
+# Use this tag to change the font size of Latex formulas included
+# as images in the HTML documentation. The default is 10. Note that
+# when you change the font size after a successful doxygen run you need
+# to manually remove any form_*.png images from the HTML output directory
+# to force them to be regenerated.
+
+FORMULA_FONTSIZE = 10
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked. If left blank `latex' will be used as the default command name.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
+# default command name.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
+# LaTeX documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, a4wide, letter, legal and
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE = a4wide
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS = NO
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+USE_PDFLATEX = NO
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE = NO
+
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
+# include the index chapters (such as File Index, Compound Index, etc.)
+# in the output.
+
+LATEX_HIDE_INDICES = NO
+
+# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
+
+LATEX_SOURCE_CODE = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
+# The RTF output is optimized for Word 97 and may not look very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES Doxygen will
+# generate an XML file that captures the structure of
+# the code including all documentation.
+
+GENERATE_XML = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `xml' will be used as the default path.
+
+XML_OUTPUT = xml
+
+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_SCHEMA =
+
+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_DTD =
+
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
+# dump the program listings (including syntax highlighting
+# and cross-referencing information) to the XML output. Note that
+# enabling this will significantly increase the size of the XML output.
+
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
+# generate a Perl module file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
+# to generate PDF and DVI output from the Perl module output.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+# nicely formatted so it can be parsed by a human reader.
+# This is useful
+# if you want to understand what is going on.
+# On the other hand, if this
+# tag is set to NO the size of the Perl module output will be much smaller
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_DEFINED tags.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# in the INCLUDE_PATH (see below) will be search if a #include is found.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that
+# are defined before the preprocessor is started (similar to the -D option of
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed. To prevent a macro definition from being
+# undefined via #undef or recursively expanded use the := operator
+# instead of the = operator.
+
+PREDEFINED = __cplusplus
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
+# this tag can be used to specify a list of macro names that should be expanded.
+# The macro definition that is found in the sources will be used.
+# Use the PREDEFINED tag if you want to use a different macro definition.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
+# doxygen's preprocessor will remove all function-like macros that are alone
+# on a line, have an all uppercase name, and do not end with a semicolon. Such
+# function macros are typically used for boiler-plate code, and will confuse
+# the parser if not removed.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES option can be used to specify one or more tagfiles.
+# Optionally an initial location of the external documentation
+# can be added for each tagfile. The format of a tag file without
+# this location is as follows:
+#
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+#
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where "loc1" and "loc2" can be relative or absolute paths or
+# URLs. If a location is present for each tag, the installdox tool
+# does not have to be run to correct the links.
+# Note that each tag file must have a unique name
+# (where the name does NOT include the path)
+# If a tag file is not located in the directory in which doxygen
+# is run, you must also specify the path to the tagfile here.
+
+TAGFILES =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
+# in the class index. If set to NO only the inherited external classes
+# will be listed.
+
+ALLEXTERNALS = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will
+# be listed.
+
+EXTERNAL_GROUPS = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of `which perl').
+
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
+# or super classes. Setting the tag to NO turns the diagrams off. Note that
+# this option is superseded by the HAVE_DOT option below. This is only a
+# fallback. It is recommended to install and use dot, since it yields more
+# powerful graphs.
+
+CLASS_DIAGRAMS = YES
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. Doxygen will then run the mscgen tool (see
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
+# default search path.
+
+MSCGEN_PATH =
+
+# If set to YES, the inheritance and collaboration graphs will hide
+# inheritance and usage relations if the target is undocumented
+# or is not a class.
+
+HIDE_UNDOC_RELATIONS = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz, a graph visualization
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
+# have no effect if this option is set to NO (the default)
+
+HAVE_DOT = NO
+
+# By default doxygen will write a font called FreeSans.ttf to the output
+# directory and reference it in all dot files that doxygen generates. This
+# font does not include all possible unicode characters however, so when you need
+# these (or just want a differently looking font) you can specify the font name
+# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
+# which can be done by putting it in a standard location or by setting the
+# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
+# containing the font.
+
+DOT_FONTNAME = FreeSans
+
+# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
+# The default size is 10pt.
+
+DOT_FONTSIZE = 10
+
+# By default doxygen will tell dot to use the output directory to look for the
+# FreeSans.ttf font (which doxygen will put there itself). If you specify a
+# different font using DOT_FONTNAME you can set the path where dot
+# can find it using this tag.
+
+DOT_FONTPATH =
+
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect inheritance relations. Setting this tag to YES will force the
+# the CLASS_DIAGRAMS tag to NO.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect implementation dependencies (inheritance, containment, and
+# class references variables) of the class with other documented classes.
+
+COLLABORATION_GRAPH = YES
+
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for groups, showing the direct groups dependencies
+
+GROUP_GRAPHS = YES
+
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+
+UML_LOOK = NO
+
+# If set to YES, the inheritance and collaboration graphs will show the
+# relations between templates and their instances.
+
+TEMPLATE_RELATIONS = NO
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
+# tags are set to YES then doxygen will generate a graph for each documented
+# file showing the direct and indirect include dependencies of the file with
+# other documented files.
+
+INCLUDE_GRAPH = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
+# documented header file showing the documented files that directly or
+# indirectly include this file.
+
+INCLUDED_BY_GRAPH = YES
+
+# If the CALL_GRAPH and HAVE_DOT options are set to YES then
+# doxygen will generate a call dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable call graphs
+# for selected functions only using the \callgraph command.
+
+CALL_GRAPH = NO
+
+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
+# doxygen will generate a caller dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable caller
+# graphs for selected functions only using the \callergraph command.
+
+CALLER_GRAPH = NO
+
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
+# will graphical hierarchy of all classes instead of a textual one.
+
+GRAPHICAL_HIERARCHY = YES
+
+# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
+# then doxygen will show the dependencies a directory has on other directories
+# in a graphical way. The dependency relations are determined by the #include
+# relations between the files in the directories.
+
+DIRECTORY_GRAPH = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. Possible values are png, jpg, or gif
+# If left blank png will be used.
+
+DOT_IMAGE_FORMAT = png
+
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+
+DOT_PATH =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the
+# \dotfile command).
+
+DOTFILE_DIRS =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
+# nodes that will be shown in the graph. If the number of nodes in a graph
+# becomes larger than this value, doxygen will truncate the graph, which is
+# visualized by representing a node as a red box. Note that doxygen if the
+# number of direct children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+
+DOT_GRAPH_MAX_NODES = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
+# graphs generated by dot. A depth value of 3 means that only nodes reachable
+# from the root by following a path via at most 3 edges will be shown. Nodes
+# that lay further from the root node will be omitted. Note that setting this
+# option to 1 or 2 may greatly reduce the computation time needed for large
+# code bases. Also note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+
+MAX_DOT_GRAPH_DEPTH = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, because dot on Windows does not
+# seem to support this out of the box. Warning: Depending on the platform used,
+# enabling this option may lead to badly anti-aliased labels on the edges of
+# a graph (i.e. they become hard to read).
+
+DOT_TRANSPARENT = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10)
+# support this, this feature is disabled by default.
+
+DOT_MULTI_TARGETS = NO
+
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
+# generate a legend page explaining the meaning of the various boxes and
+# arrows in the dot generated graphs.
+
+GENERATE_LEGEND = YES
+
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
+# remove the intermediate dot files that are used to generate
+# the various graphs.
+
+DOT_CLEANUP = YES
+
+#---------------------------------------------------------------------------
+# Options related to the search engine
+#---------------------------------------------------------------------------
+
+# The SEARCHENGINE tag specifies whether or not a search engine should be
+# used. If set to NO the values of all tags below this one will be ignored.
+
+SEARCHENGINE = NO
diff --git a/framework/docs/footer.html b/framework/docs/footer.html
new file mode 100644
index 0000000000000000000000000000000000000000..11bc768ef50772e82576a5b636d7ada48eb92a3d
--- /dev/null
+++ b/framework/docs/footer.html
@@ -0,0 +1,7 @@
+<hr/>
+<p><i>Copyright © 2011 Brian Carrier. (carrier -at- sleuthkit -dot- org)<br/>
+This work is licensed under a
+<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/us/">Creative Commons Attribution-Share Alike 3.0 United States License</a>.
+</i></p>
+</body>
+</html>
diff --git a/framework/docs/main.dox b/framework/docs/main.dox
new file mode 100644
index 0000000000000000000000000000000000000000..ca23f3b9812433e85aaefddaba9a0ee7e60e2f88
--- /dev/null
+++ b/framework/docs/main.dox
@@ -0,0 +1,12 @@
+/*! \mainpage The Sleuth Kit (TSK) Framework User's Guide and API Reference
+
+ <h3>Overview</h3>
+ The framework in TSK extends TSK to allow:
+ <ul>
+ <li>Applications to more easily incorporate third-party-tools that write their programs to be incorporated as modules in the TskPipeline.</li>
+ <li>Applications to be written to take advantage of distributed computing environments.</li>
+ </ul>
+
+ More docs will be coming.
+
+*/