Improve javadocs for SecurityLog class.

Test: checked rendering in Intellij Idea quick doc tooltip.
Bug: 34213443
Change-Id: I108df5af5a9aa05d701f2db6e2b57280f9f134b8
This commit is contained in:
Pavel Grafov
2017-04-10 19:29:41 +01:00
parent e812e7dc2e
commit 73f747ba25

View File

@@ -27,6 +27,16 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.Collection;
/**
* Definitions for working with security logs.
*
* <p>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";