mixin member linked to wrong mixin in generated ACX API docs

[chalin]

• Visit the ACX MaterialDropdownSelectComponent API page on webdev.

• Search for, say, handleHomeKey:

  handleHomeKey(KeyboardEvent event) → void
  inherited

• Click on the link, and you'll get a 404.

The handleHomeKey is linked to https://webdev.dartlang.org/components/api/angular_components/ActivateItemOnKeyPressMixin/handleHomeKey.html but the ActivateItemOnKeyPressMixin doesn't define handleHomeKey. It is defined in KeyboardHandlerMixin.

Note that if you look at the "Mixes-in" list towards the top of the API entry for MaterialDropdownSelectComponent, the KeyboardHandlerMixin entry isn't hyperlinked:

The API docs linked to above were generated using dartdoc 0.11.x.

cc @kwalrath @nshahan

[jcollins-g]

This suggests some sort of canonicalization problem.

[jcollins-g]

As part of fixing this, the links in index.json should be added to the link checker.

[kwalrath]

This probably explains a bunch of 404s in the doc analytics.

I was just thinking that we should have a complete list of all bad links. @chalin?

[jcollins-g]

I'm very interested in tracking that on my side too -- our built-in link checker covers most things now but clearly not everything.

[chalin]

I was just thinking that we should have a complete list of all bad links.

@kwalrath, well, in a way, we've encoded that here in the link checker skip list: https://github.com/dart-lang/site-webdev/blob/master/scripts/config/linkcheck-skip-list.txt#L23-L26

[kwalrath]

Those don't match the 404s I'm seeing:

/angular/api/angular2.platform.browser/BrowserDomAdapter/getElementsByClassName
/angular/guide/testing/component/component/page-objects
/angular/api/angular2.platform.common_dom/DomAdapter/getElementsByTagName
/angular/api/angular2.platform.common_dom/DomAdapter/querySelectorAll
/angular/api/angular2.core/Stream/listen
/angular/api/angular2.platform.browser_static/BrowserDomAdapter/getComputedStyle
/angular/api/angular2.platform.browser/BrowserDomAdapter/BrowserDomAdapter
/angular/api/angular2.platform.browser/BrowserDomAdapter/classList

(That said, I don't know where these URLs are coming from. Some might be dart:html APIs that something is treating as angular2 ones. Some might be TS APIs that don't exist in Dart.)

[jcollins-g]

As for the mixin that isn't linked, that is an indication that dartdoc (rightly or wrongly) believes that it is referred to by the public interface (in this case, referenced from a class in the public interface) but isn't actually exported itself. I'll verify that this determination is correct; if it is correct, the way to fix the missing link is to solve the warning.

The broken links look like they are gone now with 0.12.0.

[jcollins-g]

Never mind on the broken links -- we still have them in 0.12.0, looking into that.

[chalin]

Ok, thanks.

[jcollins-g]

Ah, I see what's going on here. dartdoc is treating mixins too similarly to other things in the inheritance chain. They aren't though, and so it isn't appropriate to redirect to other mixins if one can't be documented.

[jcollins-g]

Fixed with the combination of #1440 and #1442, will go out in the next release.