dartdoc icon indicating copy to clipboard operation
dartdoc copied to clipboard

Provide an option to generate fewer (larger) pages.

Open kwalrath opened this issue 9 years ago • 5 comments

We used to document members in the class that declared them, but now each member gets its own class.

In a large API, this means thousands of additional files, which can be problematic if you do any processing on the output. For example, adding the Dart API docs to angular.io/dart increased the build time by many minutes, because almost 3000 files were added to the build. (The entire site has 3858 .jade files, of which 2845 are in the AngularDart API doc directory.) If we had just *-class and *-library files, plus the index file, the total # of files for the Dart API docs would be around 250.

I'd like the option to keep all the documentation in the owning class.

kwalrath avatar Nov 10 '16 23:11 kwalrath

This would be a big change - if we do this it would be safer to generate all docs w/ fewer pages, instead of having an option for it. It would make for simpler code for handling things like cross references.

devoncarew avatar Nov 10 '16 23:11 devoncarew

When I've thought about this in the past, I've generally come to the conclusion that libraries get their own output file, and classes get their own output file, with some sort of class summarization on the library page.

devoncarew avatar Nov 10 '16 23:11 devoncarew

I'm not on the Flutter team, but in #1983 they note that Flutter would greatly benefit from this, and by extension, anyone who wants to include the Flutter docs in their private documentation. I've tried a couple of times to add Flutter docs and my computer just couldn't handle it.

Levi-Lesches avatar Oct 02 '19 00:10 Levi-Lesches