doc

Author: CyrusNajmabadi

src/PublicApiAnalyzers/Core/Analyzers/DeclarePublicApiAnalyzer.Impl.cs

@@ -33,10 +33,10 @@ private readonly record struct ApiLine(string Text, TextSpan Span, AdditionalFil
 
         private readonly record struct ApiName(string Name, string NameWithNullability);
 
-        /// <param name="NullableRank">Number for the max line where #nullable enable was found (-1 otherwise)</param>
-        private sealed record ApiData(ImmutableArray<ApiLine> ApiList, ImmutableArray<RemovedApiLine> RemovedApiList, int NullableRank)
+        /// <param name="NullableLineNumber">Number for the max line where #nullable enable was found (-1 otherwise)</param>
+        private sealed record ApiData(ImmutableArray<ApiLine> ApiList, ImmutableArray<RemovedApiLine> RemovedApiList, int NullableLineNumber)
         {
-            public static readonly ApiData Empty = new(ImmutableArray<ApiLine>.Empty, ImmutableArray<RemovedApiLine>.Empty, NullableRank: -1);
+            public static readonly ApiData Empty = new(ImmutableArray<ApiLine>.Empty, ImmutableArray<RemovedApiLine>.Empty, NullableLineNumber: -1);
         }
 
         private sealed class Impl
@@ -61,7 +61,7 @@ private static readonly ImmutableArray<MethodKind> s_ignorableMethodKinds
             internal Impl(Compilation compilation, ApiData shippedData, ApiData unshippedData, bool isPublic, AnalyzerOptions analyzerOptions)
             {
                 _compilation = compilation;
-                _useNullability = shippedData.NullableRank >= 0 || unshippedData.NullableRank >= 0;
+                _useNullability = shippedData.NullableLineNumber >= 0 || unshippedData.NullableLineNumber >= 0;
                 _unshippedData = unshippedData;
 
                 var publicApiMap = new Dictionary<string, ApiLine>(StringComparer.Ordinal);

src/PublicApiAnalyzers/Core/Analyzers/DeclarePublicApiAnalyzer.cs

@@ -160,22 +160,25 @@ private static ApiData ReadApiData(string path, SourceText sourceText, bool isSh
         {
             var apiBuilder = ArrayBuilder<ApiLine>.GetInstance();
             var removedBuilder = ArrayBuilder<RemovedApiLine>.GetInstance();
-            var maxNullableRank = -1;
-            var rank = -1;
+            var lastNullableLineNumber = -1;
+
+            // current line we're on.  Note: we ignore whitespace lines when computin gthis.
+            var lineNumber = -1;
 
             var additionalFileInfo = new AdditionalFileInfo(path, sourceText, isShippedApi);
 
             foreach (var line in sourceText.Lines)
             {
+                // Skip whitespace.
                 var text = line.ToString();
                 if (string.IsNullOrWhiteSpace(text))
                     continue;
 
-                rank++;
+                lineNumber++;
 
                 if (text == NullableEnable)
                 {
-                    maxNullableRank = rank;
+                    lastNullableLineNumber = lineNumber;
                     continue;
                 }
 
@@ -191,7 +194,7 @@ private static ApiData ReadApiData(string path, SourceText sourceText, bool isSh
                 }
             }
 
-            return new ApiData(apiBuilder.ToImmutableAndFree(), removedBuilder.ToImmutableAndFree(), maxNullableRank);
+            return new ApiData(apiBuilder.ToImmutableAndFree(), removedBuilder.ToImmutableAndFree(), lastNullableLineNumber);
         }
 
         private static bool TryGetApiData(AnalyzerOptions analyzerOptions, Compilation compilation, bool isPublic, List<Diagnostic> errors, CancellationToken cancellationToken, [NotNullWhen(true)] out ApiData? shippedData, [NotNullWhen(true)] out ApiData? unshippedData)
@@ -263,7 +266,7 @@ static ApiData Flatten(ArrayBuilder<ApiData> allData)
                 return new ApiData(
                     apiBuilder.ToImmutableAndFree(),
                     removedBuilder.ToImmutableAndFree(),
-                    allData.Max(static d => d.NullableRank));
+                    allData.Max(static d => d.NullableLineNumber));
             }
         }
 
@@ -379,13 +382,13 @@ private static bool ValidateApiFiles(ApiData shippedData, ApiData unshippedData,
                 errors.Add(Diagnostic.Create(descriptor, Location.None, InvalidReasonShippedCantHaveRemoved));
             }
 
-            if (shippedData.NullableRank > 0)
+            if (shippedData.NullableLineNumber > 0)
             {
                 // '#nullable enable' must be on the first line
                 errors.Add(Diagnostic.Create(descriptor, Location.None, InvalidReasonMisplacedNullableEnable));
             }
 
-            if (unshippedData.NullableRank > 0)
+            if (unshippedData.NullableLineNumber > 0)
             {
                 // '#nullable enable' must be on the first line
                 errors.Add(Diagnostic.Create(descriptor, Location.None, InvalidReasonMisplacedNullableEnable));