Updated docs to have more structure in pages.

This commit is contained in:
Brian Carrier 2012-09-12 14:01:16 -04:00
parent 9ceeaa8d8c
commit 2b1de8f77f
10 changed files with 61 additions and 3 deletions

View File

@ -655,8 +655,9 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = main.dox \ INPUT = main.dox blackboard.dox workflow.dox \
design.dox \ modContent.dox modDev.dox modIngest.dox modReport.dox \
modResult.dox platformConcepts.dox \
regressionTesting.dox \ regressionTesting.dox \
../../Case/src \ ../../Case/src \
../../CoreComponentInterfaces/src \ ../../CoreComponentInterfaces/src \

View File

@ -0,0 +1,11 @@
/*! \page blackboard_page The Blackboard
What is the blackboard
What is it used for
How do modules get access to it.
Refer to C++ page to reduce duplication.
*/

View File

@ -4,6 +4,13 @@
Autopsy has been designed as a platform for open source tools besides just The Sleuth Kit. This document is for developers who want to add functionality into Autopsy. This could be in the form of enhancing the existing functionality or by making a module that plugs into it and you may distribute from your own site or push it back into the base distribution. Autopsy has been designed as a platform for open source tools besides just The Sleuth Kit. This document is for developers who want to add functionality into Autopsy. This could be in the form of enhancing the existing functionality or by making a module that plugs into it and you may distribute from your own site or push it back into the base distribution.
- \subpage design_page - \subpage design_page
- \subpage framework_page (Basic concepts of framework and types of modules)
- \subpage blackboard_page (what is the blackboard)
- \subpage mod_dev_page (Developing modules:get dev env setup, getting sersvices, properties etc.)
- \subpage mod_ingest_page (developing ingest modules)
- \subpage mod_report_page (developing report modules)
- \subpage mod_content_page (Developing content viewer modules)
- \subpage mod_result_page (developing result viewers)
- \subpage regression_test_page - \subpage regression_test_page
*/ */

View File

@ -0,0 +1,6 @@
/*! \page mod_content_page Developing Content Viewer Modules
How to write a content viewer module.
*/

9
docs/doxygen/modDev.dox Normal file
View File

@ -0,0 +1,9 @@
/*! \page mod_dev_page Developing Module Overview
How to get dev env setup (platform, etc.)
How to get access to services and what services exist.
How to set properties, etc.
*/

View File

@ -0,0 +1,6 @@
/*! \page mod_ingest_page Developing Ingest Modules
How to write an ingest module.
*/

View File

@ -0,0 +1,6 @@
/*! \page mod_report_page Developing Report Modules
How to write a report module.
*/

View File

@ -0,0 +1,6 @@
/*! \page mod_result_page Developing Result Viewer Modules
How to write a result viewer module.
*/

View File

@ -0,0 +1,6 @@
/*! \page framework_page Autopsy Platform Concepts
What frameworks / modules exist
*/

View File

@ -1,4 +1,4 @@
/*! \page design_page General Design /*! \page design_page General Workflow and Design
\section design_overview Overview \section design_overview Overview
This section outlines Autopsy design from the typical analysis work flow perspective. This section outlines Autopsy design from the typical analysis work flow perspective.