DocumentationΒΆ
Documentation on the modules of the Overwatch package are available below. For any code contributions, please be certain to document:
- New functions, arguments, and classes.
- New attributes of classes.
- New modules (for example, an additional subsystem).
All of the above can be documented in the source, with the exception of adding new modules to the docs. The
new modules must be added in the docs/api
folder.
Module are list below by the order of their inheritance, with the bottom most module depending on every module
above it (the overwatch.receiver
module is the exception - it only depends on overwatch.base
).
- Overwatch Base Package (
overwatch.base
) - Overwatch Processing Package (
overwatch.processing
) - Overwatch Subsystem (Detector) Package (
overwatch.processing.detectors
) - Overwatch Web App Package (
overwatch.webApp
) - Overwatch Receiver Package (
overwatch.receiver package
)
Some additional helpful links: