1144227 - Properly document the async behavior of the Telemetry modules

Status: NEW

(Toolkit :: Telemetry, defect, P4)

Description

[Georg Fritzsche [:gfritzsche]]

We have some async tasks and async startup and shutdown behavior for TelemetryPing.jsm and TelemetrySession.jsm.

We need to document this properly for future readers:
* more in-code commenting on the async parts/tasks and how they interact and order
* ideally an overview on the async/task/etc behavior in the in-tree docs

(Note that bug 1140558 will remove some asynchronicity)

Comment 1

[Georg Fritzsche [:gfritzsche]]

The in-code commenting should be reasonable now, we still want to add a short overview of the Telemetry modules involved and the kind of tasks they run.