From 73f747ba25b3aa881437d8de1285fc9712660604 Mon Sep 17 00:00:00 2001 From: Pavel Grafov Date: Mon, 10 Apr 2017 19:29:41 +0100 Subject: [PATCH] Improve javadocs for SecurityLog class. Test: checked rendering in Intellij Idea quick doc tooltip. Bug: 34213443 Change-Id: I108df5af5a9aa05d701f2db6e2b57280f9f134b8 --- core/java/android/app/admin/SecurityLog.java | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/core/java/android/app/admin/SecurityLog.java b/core/java/android/app/admin/SecurityLog.java index 790a952035111..2b590e0d4301f 100644 --- a/core/java/android/app/admin/SecurityLog.java +++ b/core/java/android/app/admin/SecurityLog.java @@ -27,6 +27,16 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.util.Collection; +/** + * Definitions for working with security logs. + * + *

Device owner apps can control the logging with + * {@link DevicePolicyManager#setSecurityLoggingEnabled}. When security logs are enabled, device + * owner apps receive periodic callbacks from {@link DeviceAdminReceiver#onSecurityLogsAvailable}, + * at which time new batch of logs can be collected via + * {@link DevicePolicyManager#retrieveSecurityLogs}. {@link SecurityEvent} describes the type and + * format of security logs being collected. + */ public class SecurityLog { private static final String PROPERTY_LOGGING_ENABLED = "persist.logd.security";