angular_components icon indicating copy to clipboard operation
angular_components copied to clipboard

Link to API docs

Open kwalrath opened this issue 6 years ago • 3 comments

The docs in the gallery consist only of the class description. Often that's all you need, but sometimes you might want more API details. You shouldn't have to look at the source code to get those.

Also, links in the description come out plain. E.g. [SelectionOptions] in the MaterialSelectComponent gallery page is plain text, but is a real link in the MaterialSelectComponent API doc. That seems like a bug, but having easy access to the API doc would make it less of a problem.

kwalrath avatar Apr 13 '18 00:04 kwalrath

I agree there is room for improvement. I'm focusing my work this quarter to improve the documentation pages that are generated in the gallery.

The missing link that you described isn't a bug but rather just a feature that hasn't been implemented because it isn't clear what it should actually link to since not all of the classes that you can reference in the dartdoc are represented in the gallery.

nshahan avatar Apr 13 '18 16:04 nshahan

FYI, the AngularTS material app has a separate tab for the API entry ("Overview" and "Examples" being the other tabs), e.g. see https://material.angular.io/components/sidenav/api:

screen shot 2018-05-01 at 11 41 10

chalin avatar May 01 '18 15:05 chalin

These were recently updated to appear as code instead of the square brackets. I'll leave this as a possible improvement in the future for full dartdoc linking support.

nshahan avatar Jul 26 '18 21:07 nshahan