docs: expose existing comments

open-telemetry · Oct 20, 2021 · 326ccb0 · 326ccb0
1 parent 3045eba
commit 326ccb0
Showing 1 changed file with 9 additions and 7 deletions.
diff --git a/experimental/packages/opentelemetry-instrumentation-xml-http-request/src/xhr.ts b/experimental/packages/opentelemetry-instrumentation-xml-http-request/src/xhr.ts
@@ -57,14 +57,16 @@ export type XHRCustomAttributeFunction = (
  */
 export interface XMLHttpRequestInstrumentationConfig
   extends InstrumentationConfig {
-  // the number of timing resources is limited, after the limit
-  // (chrome 250, safari 150) the information is not collected anymore
-  // the only way to prevent that is to regularly clean the resources
-  // whenever it is possible, this is needed only when PerformanceObserver
-  // is not available
+  /**
+   * The number of timing resources is limited, after the limit
+   * (chrome 250, safari 150) the information is not collected anymore.
+   * The only way to prevent that is to regularly clean the resources
+   * whenever it is possible. This is needed only when PerformanceObserver
+   * is not available
+   */
   clearTimingResources?: boolean;
-  // urls which should include trace headers when origin doesn't match
-  propagateTraceHeaderCorsUrls?: PropagateTraceHeaderCorsUrls;
+  /** URLs which should include trace headers when origin doesn't match */
+  propagateTraceHeaderCorsUrls?: PropagateTraceHeaderCorsUrls;  
   /**
    * URLs that partially match any regex in ignoreUrls will not be traced.
    * In addition, URLs that are _exact matches_ of strings in ignoreUrls will