Refactor so that docs are generated through the Package class #1659
Conversation
|
Something is wrong on windows, and some of the new tests seem to time out on travis. Looking. |
|
Without checked mode, Flutter documentation speed is a very slight improvement. More time is spent in the analyzer with the refactor, and less in dartdoc itself, so it more or less comes out a wash. |
| for (var clazz in filterNonDocumented(lib.allClasses)) { | ||
| generateClass(_packageGraph, lib, clazz); | ||
|
|
||
| for (var constructor in filterNonDocumented(clazz.constructors)) { |
There was a problem hiding this comment.
I see 7 things here w/ pretty much the same pattern.
Not for this PR, but wonder if this could be factored into a helper function so it's more readable – and less likely to have copy-paste errors
There was a problem hiding this comment.
Yep.
This can probably be done with a map of Type to Closure in html_generator_instance and helper methods in each ModelElement class to return documentable subitems. That way you could crush this down into some nested expand calls.
There was a problem hiding this comment.
Though as I say that, while that's a pattern I've used in Python I've never actually tried to do that in Dart before.
Another refactor on the long march to #739, #1353, and #1454.
By driving all documentation through the Package class, we can provide for canonical ModelElements that aren't documented locally. This also clears some ground for making dartdoc work in non-package scenarios (since a directory in a monolithic source repository can now be implemented as a special kind of Package).
This change should do almost nothing, and that seems to be true for Flutter, although in checked mode at least dartdoc is twice as fast this way.