From d503d25f2984f1bbde0021e5e12d77ea84ede9c6 Mon Sep 17 00:00:00 2001
From: Vikram Subramanian <vikram.subramanian@gmail.com>
Date: Mon, 17 Jul 2017 14:22:54 -0700
Subject: [PATCH] docs(platform-server): add doc string for PlatformOptions

---
 packages/platform-server/src/utils.ts | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/packages/platform-server/src/utils.ts b/packages/platform-server/src/utils.ts
index d404253596..01add9360c 100644
--- a/packages/platform-server/src/utils.ts
+++ b/packages/platform-server/src/utils.ts
@@ -18,9 +18,26 @@ import {INITIAL_CONFIG} from './tokens';
 
 const parse5 = require('parse5');
 
+/**
+ * Options used to configure the server Platform instance that is created in {@link renderModule}
+ * and {@link renderModuleFactory}.
+ *
+ * @experimental
+ */
 export interface PlatformOptions {
+  /**
+   * The full document HTML of the page to render as a string.
+   */
   document?: string;
+
+  /**
+   * The URL for the current render request.
+   */
   url?: string;
+
+  /**
+   * Platform level providers for the current render request.
+   */
   extraProviders?: Provider[];
 }