Fix links to overriden methods in docs for base class (#1998)

* Fix links to overriden methods in docs for base class

* fix spelling, format test code

Author: keertip

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## 0.28.5-dev
 * Support the latest version of `package:analyzer`.
+* Fix hyperlinks to overriden methods (#1994).
 
 ## 0.28.4
 * **Breaking change** Change the default for `allow-tools` command line flag to false.

lib/src/markdown_processor.dart

@@ -647,6 +647,10 @@ class _MarkdownCommentReference {
 
     for (Class tryClass in tryClasses) {
       if (tryClass != null) {
+        if (codeRefChomped.contains('.') &&
+            !codeRefChomped.startsWith(tryClass.name)) {
+          continue;
+        }
         _getResultsForClass(tryClass);
       }
       results.remove(null);

test/dartdoc_test.dart

@@ -100,7 +100,8 @@ void main() {
     });
 
     test('errors generate errors even when warnings are off', () async {
-      Dartdoc dartdoc = await buildDartdoc(['--allow-tools'], testPackageToolError, tempDir);
+      Dartdoc dartdoc =
+          await buildDartdoc(['--allow-tools'], testPackageToolError, tempDir);
       DartdocResults results = await dartdoc.generateDocsBase();
       PackageGraph p = results.packageGraph;
       Iterable<String> unresolvedToolErrors = p
@@ -258,7 +259,7 @@ void main() {
         expect(p.name, 'test_package');
         expect(p.hasDocumentationFile, isTrue);
         // Total number of public libraries in test_package.
-        expect(packageGraph.defaultPackage.publicLibraries, hasLength(12));
+        expect(packageGraph.defaultPackage.publicLibraries, hasLength(14));
         expect(packageGraph.localPackages.length, equals(1));
       });
 
@@ -327,7 +328,7 @@ void main() {
       PackageGraph p = results.packageGraph;
       expect(p.defaultPackage.name, 'test_package');
       expect(p.defaultPackage.hasDocumentationFile, isTrue);
-      expect(p.localPublicLibraries, hasLength(11));
+      expect(p.localPublicLibraries, hasLength(13));
       expect(p.localPublicLibraries.map((lib) => lib.name).contains('fake'),
           isFalse);
     });

test/model_test.dart

@@ -61,6 +61,7 @@ void main() {
   Library errorLibrary;
   Library twoExportsLib;
   Library interceptorsLib;
+  Library baseClassLib;
   PackageGraph sdkAsPackageGraph;
   Library dartAsync;
 
@@ -82,6 +83,8 @@ void main() {
         packageGraph.libraries.firstWhere((lib) => lib.name == 'two_exports');
     interceptorsLib = packageGraph.libraries
         .firstWhere((lib) => lib.name == 'dart:_interceptors');
+    baseClassLib =
+        packageGraph.libraries.firstWhere((lib) => lib.name == 'base_class');
     sdkAsPackageGraph = utils.testPackageGraphSdk;
   });
 
@@ -492,7 +495,7 @@ void main() {
       expect(
           packageGraph
               .localPackages.first.defaultCategory.publicLibraries.length,
-          equals(5));
+          equals(7));
     });
 
     test('Verify libraries with multiple categories show up in multiple places',
@@ -516,7 +519,7 @@ void main() {
       expect(
           packageGraph
               .localPackages.first.defaultCategory.publicLibraries.length,
-          equals(5));
+          equals(7));
     });
   });
 
@@ -588,7 +591,7 @@ void main() {
       });
 
       test('libraries', () {
-        expect(packageGraph.localPublicLibraries, hasLength(10));
+        expect(packageGraph.localPublicLibraries, hasLength(12));
         expect(interceptorsLib.isPublic, isFalse);
       });
 
@@ -603,7 +606,7 @@ void main() {
 
         Package package = packageGraph.localPackages.first;
         expect(package.name, 'test_package');
-        expect(package.publicLibraries, hasLength(10));
+        expect(package.publicLibraries, hasLength(12));
       });
 
       test('multiple packages, sorted default', () {
@@ -1432,6 +1435,15 @@ void main() {
             contains('<a href="ex/B-class.html">ex.B</a>'));
       });
 
+      test('link to override method in implementer from base class', () {
+        final Class helperClass =
+            baseClassLib.classes.firstWhere((c) => c.name == 'Constraints');
+        expect(
+            helperClass.documentationAsHtml,
+            contains(
+                '<a href="override_class/BoxConstraints/debugAssertIsValid.html">BoxConstraints.debugAssertIsValid</a>'));
+      });
+
       test(
           'link to a name of a class from an imported library that exports the name',
           () {

testing/test_package/lib/base_class.dart

@@ -0,0 +1,20 @@
+library base_class;
+
+/// Abstract class Constraints
+/// * The [debugAssertIsValid] method, which should assert if there's anything
+///   wrong with the constraints object. (We use this approach rather than
+///   asserting in constructors so that our constructors can be `const` and so
+///   that it is possible to create invalid constraints temporarily while
+///   building valid ones.) See the implementation of
+///   [BoxConstraints.debugAssertIsValid] for an example of the detailed checks
+///   that can be made.
+abstract class Constraints {
+  /// Abstract const constructor. This constructor enables subclasses to provide
+  /// const constructors so that they can be used in const expressions.
+  const Constraints();
+
+  /// Method is overriden in implementations.
+  bool debugAssertIsValid() {
+    return true;
+  }
+}

testing/test_package/lib/override_class.dart

@@ -0,0 +1,12 @@
+import 'base_class.dart';
+
+class BoxConstraints extends Constraints {
+  /// Creates box constraints with the given constraints.
+  const BoxConstraints();
+
+  /// Overrides the method in the superclass.
+  @override
+  bool debugAssertIsValid() {
+    return false;
+  }
+}