mirror of
https://github.com/overcuriousity/autopsy-flatpak.git
synced 2025-07-06 21:00:22 +00:00
Added doxygen infrastructure instead of javadocs
This commit is contained in:
parent
e9542ebda0
commit
b77ccfb816
1810
docs/doxygen/Doxyfile
Normal file
1810
docs/doxygen/Doxyfile
Normal file
File diff suppressed because it is too large
Load Diff
8
docs/doxygen/contentViewer.dox
Normal file
8
docs/doxygen/contentViewer.dox
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
/*! \page contentViewer_page Creating Content Viewers
|
||||||
|
|
||||||
|
\section cv_overview Overview
|
||||||
|
|
||||||
|
This page will talk about making content viewers. We have not written it yet.
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
10
docs/doxygen/design.dox
Normal file
10
docs/doxygen/design.dox
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
/*! \page design_page General Design
|
||||||
|
|
||||||
|
\section design_overview Overview
|
||||||
|
|
||||||
|
Talk about the various pieces, etc.
|
||||||
|
|
||||||
|
It will refer to the org.sleuthkit.autopsy.casemodule, org.sleuthkit.autopsy.ingest.IngestManager, etc.
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
8
docs/doxygen/ingest.dox
Normal file
8
docs/doxygen/ingest.dox
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
/*! \page ingest_page Creating Ingest Modules
|
||||||
|
|
||||||
|
\section ingest_overview Overview
|
||||||
|
|
||||||
|
This page will talk about making ingest modules. We have not written it yet.
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
13
docs/doxygen/main.dox
Normal file
13
docs/doxygen/main.dox
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
/*! \mainpage Autopsy Forensic Browser Developer's Guide and API Reference
|
||||||
|
|
||||||
|
<h3>Overview</h3>
|
||||||
|
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 ingest_page
|
||||||
|
- \subpage contentViewer_page
|
||||||
|
- \subpage report_page
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
8
docs/doxygen/report.dox
Normal file
8
docs/doxygen/report.dox
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
/*! \page report_page Creating Report Modules
|
||||||
|
|
||||||
|
\section report_overview Overview
|
||||||
|
|
||||||
|
This page will talk about making report modules. We have not written it yet.
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
Loading…
x
Reference in New Issue
Block a user