mirror of
https://github.com/overcuriousity/autopsy-flatpak.git
synced 2025-07-06 21:00:22 +00:00
Updated docs to have more structure in pages.
This commit is contained in:
parent
9ceeaa8d8c
commit
2b1de8f77f
@ -655,8 +655,9 @@ WARN_LOGFILE =
|
||||
# directories like "/usr/src/myproject". Separate the files or directories
|
||||
# with spaces.
|
||||
|
||||
INPUT = main.dox \
|
||||
design.dox \
|
||||
INPUT = main.dox blackboard.dox workflow.dox \
|
||||
modContent.dox modDev.dox modIngest.dox modReport.dox \
|
||||
modResult.dox platformConcepts.dox \
|
||||
regressionTesting.dox \
|
||||
../../Case/src \
|
||||
../../CoreComponentInterfaces/src \
|
||||
|
11
docs/doxygen/blackboard.dox
Normal file
11
docs/doxygen/blackboard.dox
Normal 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.
|
||||
|
||||
*/
|
@ -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.
|
||||
|
||||
- \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
|
||||
|
||||
*/
|
||||
|
6
docs/doxygen/modContent.dox
Normal file
6
docs/doxygen/modContent.dox
Normal 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
9
docs/doxygen/modDev.dox
Normal 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.
|
||||
|
||||
*/
|
6
docs/doxygen/modIngest.dox
Normal file
6
docs/doxygen/modIngest.dox
Normal file
@ -0,0 +1,6 @@
|
||||
/*! \page mod_ingest_page Developing Ingest Modules
|
||||
|
||||
|
||||
How to write an ingest module.
|
||||
|
||||
*/
|
6
docs/doxygen/modReport.dox
Normal file
6
docs/doxygen/modReport.dox
Normal file
@ -0,0 +1,6 @@
|
||||
/*! \page mod_report_page Developing Report Modules
|
||||
|
||||
|
||||
How to write a report module.
|
||||
|
||||
*/
|
6
docs/doxygen/modResult.dox
Normal file
6
docs/doxygen/modResult.dox
Normal file
@ -0,0 +1,6 @@
|
||||
/*! \page mod_result_page Developing Result Viewer Modules
|
||||
|
||||
|
||||
How to write a result viewer module.
|
||||
|
||||
*/
|
6
docs/doxygen/platformConcepts.dox
Normal file
6
docs/doxygen/platformConcepts.dox
Normal file
@ -0,0 +1,6 @@
|
||||
/*! \page framework_page Autopsy Platform Concepts
|
||||
|
||||
What frameworks / modules exist
|
||||
|
||||
|
||||
*/
|
@ -1,4 +1,4 @@
|
||||
/*! \page design_page General Design
|
||||
/*! \page design_page General Workflow and Design
|
||||
|
||||
\section design_overview Overview
|
||||
This section outlines Autopsy design from the typical analysis work flow perspective.
|
Loading…
x
Reference in New Issue
Block a user