From 1b0644a3b706233ddb86972916704f95af9b0f7d Mon Sep 17 00:00:00 2001
From: Daniel Nadeau <3473356+D4N14L@users.noreply.github.com>
Date: Fri, 4 Oct 2019 15:30:23 -0700
Subject: [PATCH] Add doc comment to maxEffectiveReleaseTag

---
 apps/api-extractor/src/collector/SymbolMetadata.ts | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/apps/api-extractor/src/collector/SymbolMetadata.ts b/apps/api-extractor/src/collector/SymbolMetadata.ts
index b5ea2948e71..361df3c1650 100644
--- a/apps/api-extractor/src/collector/SymbolMetadata.ts
+++ b/apps/api-extractor/src/collector/SymbolMetadata.ts
@@ -4,5 +4,7 @@
 import { ReleaseTag } from '@microsoft/api-extractor-model';
 
 export class SymbolMetadata {
+  // For all declarations associated with this symbol, this is the
+  // `DeclarationMetadata.effectiveReleaseTag` value that is most public.
   public maxEffectiveReleaseTag: ReleaseTag = ReleaseTag.None;
 }