chore: snippets

mlykotom · mlykotom · commit cfa4cc8a7300 · 2022-02-03T14:02:19.000+01:00
diff --git a/JankStatsSample/app/src/main/java/com/example/jankstats/JankAggregatorActivity.kt b/JankStatsSample/app/src/main/java/com/example/jankstats/JankAggregatorActivity.kt
@@ -36,54 +36,69 @@ import kotlinx.coroutines.asExecutor
  * receives data when a report is issued, either when the activity goes into the background
  * or if JankStatsAggregator issues the report itself.
  */
+// [START aggregator_activity_init]
 class JankAggregatorActivity : AppCompatActivity() {
 
+    private lateinit var jankStatsAggregator: JankStatsAggregator
+    // [START_EXCLUDE silent]
     private lateinit var binding: ActivityJankLoggingBinding
     private lateinit var navController: NavController
     private lateinit var appBarConfiguration: AppBarConfiguration
 
-    private lateinit var jankStatsAggregator: JankStatsAggregator
-
+    // [START jank_aggregator_listener]
     private val jankReportListener =
         JankStatsAggregator.OnJankReportListener { reason, totalFrames, jankFrameData ->
+            // real app would do something more interesting than log this...
+
             Log.v(
                 "JankStatsSample",
-                "*** Jank Report ($reason), totalFrames = $totalFrames, " +
+                "*** Jank Report ($reason), " +
+                        "totalFrames = $totalFrames, " +
                         "jankFrames = ${jankFrameData.size}"
             )
 
             jankFrameData.forEach { frameData ->
                 Log.v("JankStatsSample", frameData.toString())
             }
         }
+    // [END jank_aggregator_listener]
+    // [END_EXCLUDE silent]
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
+        // [START_EXCLUDE]
         binding = ActivityJankLoggingBinding.inflate(layoutInflater)
         setContentView(binding.root)
         setupUi()
-
+        // [END_EXCLUDE]
+        // metrics state holder can be retrieved regardless of JankStats initialization
         val metricsStateHolder = PerformanceMetricsState.getForHierarchy(binding.root)
 
+        // initialize JankStats with aggregator for current window
         jankStatsAggregator = JankStatsAggregator(
             window,
             Dispatchers.Default.asExecutor(),
             jankReportListener
         )
 
+        // add activity name as state
         metricsStateHolder.state?.addState("Activity", javaClass.simpleName)
     }
+    // [END aggregator_activity_init]
 
+    // [START aggregator_tracking_enabled]
     override fun onResume() {
         super.onResume()
         jankStatsAggregator.jankStats.isTrackingEnabled = true
     }
 
     override fun onPause() {
         super.onPause()
+        // before disabling tracking, issue the report with (optionally) specified reason
         jankStatsAggregator.issueJankReport("Activity paused")
         jankStatsAggregator.jankStats.isTrackingEnabled = false
     }
+    // [END aggregator_tracking_enabled]
 
     override fun onSupportNavigateUp(): Boolean {
         return navController.navigateUp(appBarConfiguration) || super.onSupportNavigateUp()
diff --git a/JankStatsSample/app/src/main/java/com/example/jankstats/JankLoggingActivity.kt b/JankStatsSample/app/src/main/java/com/example/jankstats/JankLoggingActivity.kt
@@ -39,14 +39,14 @@ import kotlinx.coroutines.asExecutor
 class JankLoggingActivity : AppCompatActivity() {
 
     private lateinit var jankStats: JankStats
-
-    // [START_EXCLUDE]
+    // [START_EXCLUDE silent]
     private lateinit var binding: ActivityJankLoggingBinding
     private lateinit var navController: NavController
     private lateinit var appBarConfiguration: AppBarConfiguration
 
     // [START jank_frame_listener]
     private val jankFrameListener = JankStats.OnFrameListener { frameData ->
+        // real app would do something more interesting than log this...
         Log.v("JankStatsSample", frameData.toString())
     }
     // [END jank_frame_listener]
