Update vpnProvider documentation in the idl.

The CL adds documentation for enum states in the idl for vpnProvider.

BUG=432496

Review URL: https://codereview.chromium.org/1020433002

Cr-Commit-Position: refs/heads/master@{#321161}

1 files changed, 9 insertions, 0 deletions

diff --git a/extensions/common/api/vpn_provider.idl b/extensions/common/api/vpn_provider.idl
index b0fdc2f..ef0e947 100644
--- a/extensions/common/api/vpn_provider.idl
+++ b/extensions/common/api/vpn_provider.idl
@@ -45,8 +45,13 @@ namespace vpnProvider {
   // The enum is used by the platform to notify the client of the VPN session
   // status.
   enum PlatformMessage {
+    // VPN configuration connected.
     connected,
+    // VPN configuration disconnected.
     disconnected,
+    // An error occurred in VPN connection, for example a timeout. A description
+    // of the error is give as the <ahref="#property-onPlatformMessage-error">
+    // error argument to onPlatformMessage</a>.
     error
   };
 
@@ -54,14 +59,18 @@ namespace vpnProvider {
   // of its current state. This helps provide meaningful messages
   // to the user.
   enum VpnConnectionState {
+    // VPN connection was successful.
     connected,
+    // VPN connection failed.
     failure
   };
 
   // The enum is used by the platform to indicate the event that triggered
   // <code>onUIEvent</code>.
   enum UIEvent {
+    // Request the VPN client to show add configuration dialog to the user.
     showAddDialog,
+    // Request the VPN client to show configuration settings dialog to the user.
     showConfigureDialog
   };