Skip to content

Refactor so that docs are generated through the Package class #1659

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Apr 6, 2018
Merged

Refactor so that docs are generated through the Package class #1659

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f36fbd0
refactors
jcollins-g Apr 2, 2018
3c0e8bc
Library/Package/PackageGraph constructor shuffle
jcollins-g Apr 2, 2018
717412a
Not quite there; still need to populate non-local packages
jcollins-g Apr 3, 2018
299c154
weird vm thing
jcollins-g Apr 3, 2018
b6a1627
Got it?
jcollins-g Apr 3, 2018
951cf4b
Add another test
jcollins-g Apr 3, 2018
f07e99b
tweaks for Flutter
jcollins-g Apr 3, 2018
910a83b
Initialization speedups
jcollins-g Apr 4, 2018
a10abbb
Canonicalize path comparisons and increase timeouts on the complex da…
jcollins-g Apr 4, 2018
2dbd675
Update grind with different parameters
jcollins-g Apr 4, 2018
2fe1c1d
remove commented out line
jcollins-g Apr 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 60 additions & 58 deletions lib/src/html/html_generator_instance.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,76 +89,78 @@ class HtmlGeneratorInstance {

generatePackage();

for (var lib in filterNonDocumented(_packageGraph.libraries)) {
generateLibrary(_packageGraph, lib);

for (var clazz in filterNonDocumented(lib.allClasses)) {
generateClass(_packageGraph, lib, clazz);

for (var constructor in filterNonDocumented(clazz.constructors)) {
if (!constructor.isCanonical) continue;
generateConstructor(_packageGraph, lib, clazz, constructor);
for (var package in _packageGraph.localPackages) {
for (var lib in filterNonDocumented(package.libraries)) {
generateLibrary(_packageGraph, lib);

for (var clazz in filterNonDocumented(lib.allClasses)) {
generateClass(_packageGraph, lib, clazz);

for (var constructor in filterNonDocumented(clazz.constructors)) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

if (!constructor.isCanonical) continue;
generateConstructor(_packageGraph, lib, clazz, constructor);
}

for (var constant in filterNonDocumented(clazz.constants)) {
if (!constant.isCanonical) continue;
generateConstant(_packageGraph, lib, clazz, constant);
}

for (var property in filterNonDocumented(clazz.staticProperties)) {
if (!property.isCanonical) continue;
generateProperty(_packageGraph, lib, clazz, property);
}

for (var property in filterNonDocumented(clazz.propertiesForPages)) {
if (!property.isCanonical) continue;
generateProperty(_packageGraph, lib, clazz, property);
}

for (var method in filterNonDocumented(clazz.methodsForPages)) {
if (!method.isCanonical) continue;
generateMethod(_packageGraph, lib, clazz, method);
}

for (var operator in filterNonDocumented(clazz.operatorsForPages)) {
if (!operator.isCanonical) continue;
generateMethod(_packageGraph, lib, clazz, operator);
}

for (var method in filterNonDocumented(clazz.staticMethods)) {
if (!method.isCanonical) continue;
generateMethod(_packageGraph, lib, clazz, method);
}
}

for (var constant in filterNonDocumented(clazz.constants)) {
if (!constant.isCanonical) continue;
generateConstant(_packageGraph, lib, clazz, constant);
for (var eNum in filterNonDocumented(lib.enums)) {
generateEnum(_packageGraph, lib, eNum);
for (var property in filterNonDocumented(eNum.propertiesForPages)) {
generateProperty(_packageGraph, lib, eNum, property);
}
for (var operator in filterNonDocumented(eNum.operatorsForPages)) {
generateMethod(_packageGraph, lib, eNum, operator);
}
for (var method in filterNonDocumented(eNum.methodsForPages)) {
generateMethod(_packageGraph, lib, eNum, method);
}
}

for (var property in filterNonDocumented(clazz.staticProperties)) {
if (!property.isCanonical) continue;
generateProperty(_packageGraph, lib, clazz, property);
for (var constant in filterNonDocumented(lib.constants)) {
generateTopLevelConstant(_packageGraph, lib, constant);
}

for (var property in filterNonDocumented(clazz.propertiesForPages)) {
if (!property.isCanonical) continue;
generateProperty(_packageGraph, lib, clazz, property);
for (var property in filterNonDocumented(lib.properties)) {
generateTopLevelProperty(_packageGraph, lib, property);
}

for (var method in filterNonDocumented(clazz.methodsForPages)) {
if (!method.isCanonical) continue;
generateMethod(_packageGraph, lib, clazz, method);
for (var function in filterNonDocumented(lib.functions)) {
generateFunction(_packageGraph, lib, function);
}

for (var operator in filterNonDocumented(clazz.operatorsForPages)) {
if (!operator.isCanonical) continue;
generateMethod(_packageGraph, lib, clazz, operator);
}

for (var method in filterNonDocumented(clazz.staticMethods)) {
if (!method.isCanonical) continue;
generateMethod(_packageGraph, lib, clazz, method);
}
}

for (var eNum in filterNonDocumented(lib.enums)) {
generateEnum(_packageGraph, lib, eNum);
for (var property in filterNonDocumented(eNum.propertiesForPages)) {
generateProperty(_packageGraph, lib, eNum, property);
}
for (var operator in filterNonDocumented(eNum.operatorsForPages)) {
generateMethod(_packageGraph, lib, eNum, operator);
}
for (var method in filterNonDocumented(eNum.methodsForPages)) {
generateMethod(_packageGraph, lib, eNum, method);
for (var typeDef in filterNonDocumented(lib.typedefs)) {
generateTypeDef(_packageGraph, lib, typeDef);
}
}

for (var constant in filterNonDocumented(lib.constants)) {
generateTopLevelConstant(_packageGraph, lib, constant);
}

for (var property in filterNonDocumented(lib.properties)) {
generateTopLevelProperty(_packageGraph, lib, property);
}

for (var function in filterNonDocumented(lib.functions)) {
generateFunction(_packageGraph, lib, function);
}

for (var typeDef in filterNonDocumented(lib.typedefs)) {
generateTypeDef(_packageGraph, lib, typeDef);
}
}
}

Expand Down
3 changes: 1 addition & 2 deletions lib/src/html/template_data.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,7 @@ abstract class TemplateData<T extends Documentable> {
}

Iterable<Subnav> _gatherSubnavForInvokable(ModelElement element) {
if (element is SourceCodeMixin &&
(element as SourceCodeMixin).hasSourceCode) {
if (element.hasSourceCode) {
return [new Subnav('Source', '${element.href}#source')];
} else {
return <Subnav>[];
Expand Down
2 changes: 1 addition & 1 deletion lib/src/markdown_processor.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,7 +475,7 @@ ModelElement _findRefElementInLibrary(String codeRef, Warnable element,
assert(packageGraph.allLibrariesAdded);
_findRefElementCache = new Map();
for (final modelElement
in filterNonDocumented(packageGraph.allModelElements)) {
in filterNonDocumented(packageGraph.allLocalModelElements)) {
_findRefElementCache.putIfAbsent(
modelElement.fullyQualifiedNameWithoutLibrary, () => new Set());
_findRefElementCache.putIfAbsent(
Expand Down
Loading