[feedback] Add comments to snapshot manager
Change-Id: Ief8777af30b29c5e01c9323efbaf1b7a2872b34e
Reviewed-on: https://fuchsia-review.googlesource.com/c/fuchsia/+/474525
Commit-Queue: Daniel Salazar Villarreal <villarreald@google.com>
Reviewed-by: Alex Pankhurst <pankhurst@google.com>
diff --git a/src/developer/forensics/crash_reports/snapshot_manager.h b/src/developer/forensics/crash_reports/snapshot_manager.h
index 30667b4..454b1d4 100644
--- a/src/developer/forensics/crash_reports/snapshot_manager.h
+++ b/src/developer/forensics/crash_reports/snapshot_manager.h
@@ -42,7 +42,9 @@
timekeeper::Clock* clock, zx::duration shared_request_window,
StorageSize max_annotations_size, StorageSize max_archives_size);
- // Returns a promise of a snapshot uuid. No uuid will be returned if |timeout| expires.
+ // Returns a promise of a snapshot uuid for a snapshot that contains the most up-to-date system
+ // data (a new snapshot will be created if all existing snapshots contain data that is
+ // out-of-date). No uuid will be returned if |timeout| expires.
::fit::promise<SnapshotUuid> GetSnapshotUuid(zx::duration timeout);
// Returns the snapshot for |uuid|, if one exists. If no snapshot exists for |uuid| a snapshot
