From bb57907a601573d81d6f97b1641bcff8a5ee07e0 Mon Sep 17 00:00:00 2001
From: Zhomart Mukhamejanov <zhomart@google.com>
Date: Mon, 15 Mar 2021 13:25:40 -0700
Subject: [PATCH] Add docs to Slog class.

Docs will be super useful, especially to new developers.
I see several docs and questions inside/outside google asking
what is it and when to use it.

Bug: 182476140
Test: m -j
Change-Id: Ibb41ab0b6fd808f2a1e5475103860fc415a502d6
---
 core/java/android/util/Slog.java | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/core/java/android/util/Slog.java b/core/java/android/util/Slog.java
index d3eaeae993e68..e5106e2b0ce73 100644
--- a/core/java/android/util/Slog.java
+++ b/core/java/android/util/Slog.java
@@ -26,6 +26,10 @@ import java.util.Formatter;
 import java.util.Locale;
 
 /**
+ * API for sending log output to the {@link Log#LOG_ID_SYSTEM} buffer.
+ *
+ * <p>Should be used by system components. Use {@code adb logcat --buffer=system} to fetch the logs.
+ *
  * @hide
  */
 public final class Slog {