guide/index.ngdoc has invalid links

[petebacondarwin]

The documentation generator has identified a number of invalid links:

WARNING: api/AUTO.$provide (defined in src\auto\injector.js) points to a non existing anchor "api/AUTO.$provide#factory"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing anchor "api/ng#directive"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing page "api/ng.ngClick"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing page "api/ng.ngInclude"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing page "api/ng.ngInclude"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing anchor "api/ng#service"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing page "api/ng.$routeParams"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing anchor "api/ng#filter"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing anchor "api/ng#function"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing anchor "api/ngRoute#service"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing anchor "api/ngRoute#directive"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing anchor "api/ngAnimate#service"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing anchor "api/angular.Module#animation"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing anchor "api/ngResource#service"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing anchor "api/ngCookies#service"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing anchor "api/ngTouch#service"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing anchor "api/ngTouch#directive"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing anchor "api/ngSanitize#service"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing anchor "api/ngTouch#filter"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing anchor "api/ngMock#service"!
WARNING: api/index (defined in docs\content\api\index.ngdoc) points to a non existing anchor "api/ngMock#function"!

[jamesdaily]

api/AUTO.$provide#factory is definitely incorrect. The correct anchor is methods_factory.

I spot checked a few more - I think the other anchor warnings are mostly false positives. api/ng#directive, api/ng#filter, api/ng#function, api/ngTouch#service all exist but they are id's on h3 tags, not a tags. Perhaps that h3+id anchor is not understood by the generator validator?

Edit: Moved scroll-to-anchor commentary to #4703.

[petebacondarwin]

Fixed the first one: cf54510

[petebacondarwin]

@jamesdaily - thanks for taking the time to look into these by the way!

[jamesdaily]

@petebacondarwin - a few more easy ones to knock off:

• api/ng.ngClick should be api/ng.directive:ngClick
• api/ng.ngInclude should be api/ng.directive:ngInclude
• api/ng.ngInclude (again) should be api/ng.directive:ngInclude
• $routeParams is not part of ng, so the broken link to api/ng.$routeParams should be removed entirely from the "ng (core module)" section. (The proper link to ngRoute.$routeParams is present in the ngRoute section.)
• api/angular.Module#animation should be api/angular.Module#methods_animation

Haven't yet been able to nail down why the generator is not recognizing anchor links on the ng page.

[petebacondarwin]

More fixed at 2ae29b1

[petebacondarwin]

And more at 117de8e

[petebacondarwin]

The problem with the other anchors is that they are generated at runtime by an AngularJS directive: docModuleComponents. So the links don't exist when the documentation is being generated.

[btford]

I'll take care of the rest of the warnings.

FYI e8cc85f changed how the anchors are generated.

@petebacondarwin is right about the cause of the remaining errors. Fixing this would mean changing the dynamic part to be something statically generated by the docs generator. Hmm.

[petebacondarwin]

I think that statically generating these sections is actually the way forward anyway in this case.

[IgorMinar]

@btford any update on this?

[btford]

@IgorMinar we decided to sneak the links into the cache to suppress these warnings and keep the dynamic version. I'll do that this afternoon.

[IgorMinar]

cache == the pool of known urls? if so that sounds good. write code that populates the pool for each module we have.