Skip to content

Commit 209cdf4

Browse files
srawlinssrawlins
committed
Improve display text for libraries
1 parent ab845cb commit 209cdf4

11 files changed

+252
-94
lines changed

‎lib/src/element_type.dart

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,12 @@ abstract class ElementType
6464
/// Name with generics and nullability indication.
6565
String get nameWithGenerics;
6666

67+
@override
68+
String get displayName => throw UnimplementedError();
69+
70+
@override
71+
String get breadcrumbName => throw UnimplementedError();
72+
6773
DartType get instantiatedType;
6874

6975
Iterable<ElementType> get typeArguments;

‎lib/src/generator/generator_frontend.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ class GeneratorFrontEnd implements Generator {
7474

7575
for (var lib in filterNonDocumented(package.libraries)) {
7676
if (!multiplePackages) {
77-
logInfo('Generating docs for library ${lib.name} from '
77+
logInfo('Generating docs for library ${lib.breadcrumbName} from '
7878
'${lib.element.source.uri}...');
7979
}
8080
if (!lib.isAnonymous && !lib.hasDocumentation) {

‎lib/src/generator/templates.aot_renderers_for_html.dart

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1109,17 +1109,25 @@ String renderLibrary(LibraryTemplateData context0) {
11091109
var context1 = context0.self;
11101110
buffer.writeln();
11111111
buffer.write('''
1112-
<div>''');
1112+
<div>
1113+
''');
11131114
buffer.write(_renderLibrary_partial_source_link_1(context1));
1114-
buffer.write('''<h1><span class="kind-library">''');
1115-
buffer.write(context1.name);
1116-
buffer.write('''</span> ''');
1115+
buffer.writeln();
1116+
buffer.write('''
1117+
<h1>
1118+
<span class="kind-library">''');
1119+
buffer.write(context1.displayName);
1120+
buffer.write('''</span>
1121+
''');
11171122
buffer.writeEscaped(context1.kind.toString());
11181123
buffer.write(' ');
11191124
buffer.write(_renderLibrary_partial_feature_set_2(context1));
11201125
buffer.write(' ');
11211126
buffer.write(_renderLibrary_partial_categorization_3(context1));
1122-
buffer.write('''</h1></div>''');
1127+
buffer.writeln();
1128+
buffer.write('''
1129+
</h1>
1130+
</div>''');
11231131
buffer.writeln();
11241132
var context2 = context0.library;
11251133
buffer.write('\n ');
@@ -3579,7 +3587,7 @@ String _deduplicated_lib_templates_html__head_html(TemplateDataBase context0) {
35793587
<li><a href="''');
35803588
buffer.write(context4.href);
35813589
buffer.write('''">''');
3582-
buffer.writeEscaped(context4.name);
3590+
buffer.writeEscaped(context4.breadcrumbName);
35833591
buffer.write('''</a></li>''');
35843592
}
35853593
var context5 = context0.navLinksWithGenerics;
@@ -3589,7 +3597,7 @@ String _deduplicated_lib_templates_html__head_html(TemplateDataBase context0) {
35893597
<li><a href="''');
35903598
buffer.write(context6.href);
35913599
buffer.write('''">''');
3592-
buffer.writeEscaped(context6.name);
3600+
buffer.writeEscaped(context6.breadcrumbName);
35933601
if (context6.hasGenericParameters == true) {
35943602
buffer.write('''<span class="signature">''');
35953603
buffer.write(context6.genericParameters);

‎lib/src/generator/templates.runtime_renderers.dart

Lines changed: 134 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -4399,6 +4399,50 @@ class _Renderer_ElementType extends RendererBase<ElementType> {
43994399
..._Renderer_CommentReferable.propertyMap<CT_>(),
44004400
..._Renderer_Nameable.propertyMap<CT_>(),
44014401
..._Renderer_ModelBuilder.propertyMap<CT_>(),
4402+
'breadcrumbName': Property(
4403+
getValue: (CT_ c) => c.breadcrumbName,
4404+
renderVariable:
4405+
(CT_ c, Property<CT_> self, List<String> remainingNames) {
4406+
if (remainingNames.isEmpty) {
4407+
return self.getValue(c).toString();
4408+
}
4409+
var name = remainingNames.first;
4410+
var nextProperty =
4411+
_Renderer_String.propertyMap().getValue(name);
4412+
return nextProperty.renderVariable(
4413+
self.getValue(c) as String,
4414+
nextProperty,
4415+
[...remainingNames.skip(1)]);
4416+
},
4417+
isNullValue: (CT_ c) => false,
4418+
renderValue: (CT_ c, RendererBase<CT_> r,
4419+
List<MustachioNode> ast, StringSink sink) {
4420+
_render_String(c.breadcrumbName, ast, r.template, sink,
4421+
parent: r);
4422+
},
4423+
),
4424+
'displayName': Property(
4425+
getValue: (CT_ c) => c.displayName,
4426+
renderVariable:
4427+
(CT_ c, Property<CT_> self, List<String> remainingNames) {
4428+
if (remainingNames.isEmpty) {
4429+
return self.getValue(c).toString();
4430+
}
4431+
var name = remainingNames.first;
4432+
var nextProperty =
4433+
_Renderer_String.propertyMap().getValue(name);
4434+
return nextProperty.renderVariable(
4435+
self.getValue(c) as String,
4436+
nextProperty,
4437+
[...remainingNames.skip(1)]);
4438+
},
4439+
isNullValue: (CT_ c) => false,
4440+
renderValue: (CT_ c, RendererBase<CT_> r,
4441+
List<MustachioNode> ast, StringSink sink) {
4442+
_render_String(c.displayName, ast, r.template, sink,
4443+
parent: r);
4444+
},
4445+
),
44024446
'instantiatedType': Property(
44034447
getValue: (CT_ c) => c.instantiatedType,
44044448
renderVariable: (CT_ c, Property<CT_> self,
@@ -8276,6 +8320,28 @@ class _Renderer_Library extends RendererBase<Library> {
82768320
parent: r);
82778321
},
82788322
),
8323+
'breadcrumbName': Property(
8324+
getValue: (CT_ c) => c.breadcrumbName,
8325+
renderVariable:
8326+
(CT_ c, Property<CT_> self, List<String> remainingNames) {
8327+
if (remainingNames.isEmpty) {
8328+
return self.getValue(c).toString();
8329+
}
8330+
var name = remainingNames.first;
8331+
var nextProperty =
8332+
_Renderer_String.propertyMap().getValue(name);
8333+
return nextProperty.renderVariable(
8334+
self.getValue(c) as String,
8335+
nextProperty,
8336+
[...remainingNames.skip(1)]);
8337+
},
8338+
isNullValue: (CT_ c) => false,
8339+
renderValue: (CT_ c, RendererBase<CT_> r,
8340+
List<MustachioNode> ast, StringSink sink) {
8341+
_render_String(c.breadcrumbName, ast, r.template, sink,
8342+
parent: r);
8343+
},
8344+
),
82798345
'characterLocation': Property(
82808346
getValue: (CT_ c) => c.characterLocation,
82818347
renderVariable: (CT_ c, Property<CT_> self,
@@ -8351,6 +8417,28 @@ class _Renderer_Library extends RendererBase<Library> {
83518417
_render_String(c.dirName, ast, r.template, sink, parent: r);
83528418
},
83538419
),
8420+
'displayName': Property(
8421+
getValue: (CT_ c) => c.displayName,
8422+
renderVariable:
8423+
(CT_ c, Property<CT_> self, List<String> remainingNames) {
8424+
if (remainingNames.isEmpty) {
8425+
return self.getValue(c).toString();
8426+
}
8427+
var name = remainingNames.first;
8428+
var nextProperty =
8429+
_Renderer_String.propertyMap().getValue(name);
8430+
return nextProperty.renderVariable(
8431+
self.getValue(c) as String,
8432+
nextProperty,
8433+
[...remainingNames.skip(1)]);
8434+
},
8435+
isNullValue: (CT_ c) => false,
8436+
renderValue: (CT_ c, RendererBase<CT_> r,
8437+
List<MustachioNode> ast, StringSink sink) {
8438+
_render_String(c.displayName, ast, r.template, sink,
8439+
parent: r);
8440+
},
8441+
),
83548442
'element': Property(
83558443
getValue: (CT_ c) => c.element,
83568444
renderVariable: (CT_ c, Property<CT_> self,
@@ -8594,28 +8682,6 @@ class _Renderer_Library extends RendererBase<Library> {
85948682
_render_String(c.name, ast, r.template, sink, parent: r);
85958683
},
85968684
),
8597-
'nameFromPath': Property(
8598-
getValue: (CT_ c) => c.nameFromPath,
8599-
renderVariable:
8600-
(CT_ c, Property<CT_> self, List<String> remainingNames) {
8601-
if (remainingNames.isEmpty) {
8602-
return self.getValue(c).toString();
8603-
}
8604-
var name = remainingNames.first;
8605-
var nextProperty =
8606-
_Renderer_String.propertyMap().getValue(name);
8607-
return nextProperty.renderVariable(
8608-
self.getValue(c) as String,
8609-
nextProperty,
8610-
[...remainingNames.skip(1)]);
8611-
},
8612-
isNullValue: (CT_ c) => false,
8613-
renderValue: (CT_ c, RendererBase<CT_> r,
8614-
List<MustachioNode> ast, StringSink sink) {
8615-
_render_String(c.nameFromPath, ast, r.template, sink,
8616-
parent: r);
8617-
},
8618-
),
86198685
'package': Property(
86208686
getValue: (CT_ c) => c.package,
86218687
renderVariable:
@@ -8673,19 +8739,6 @@ class _Renderer_Library extends RendererBase<Library> {
86738739
parent: r);
86748740
},
86758741
),
8676-
'prefixToLibrary': Property(
8677-
getValue: (CT_ c) => c.prefixToLibrary,
8678-
renderVariable: (CT_ c, Property<CT_> self,
8679-
List<String> remainingNames) =>
8680-
self.renderSimpleVariable(
8681-
c, remainingNames, 'Map<String, Set<Library>>'),
8682-
isNullValue: (CT_ c) => false,
8683-
renderValue: (CT_ c, RendererBase<CT_> r,
8684-
List<MustachioNode> ast, StringSink sink) {
8685-
renderSimple(c.prefixToLibrary, ast, r.template, sink,
8686-
parent: r, getters: _invisibleGetters['Map']!);
8687-
},
8688-
),
86898742
'properties': Property(
86908743
getValue: (CT_ c) => c.properties,
86918744
renderVariable: (CT_ c, Property<CT_> self,
@@ -11544,6 +11597,50 @@ class _Renderer_Nameable extends RendererBase<Nameable> {
1154411597
CT_,
1154511598
() => {
1154611599
..._Renderer_Object.propertyMap<CT_>(),
11600+
'breadcrumbName': Property(
11601+
getValue: (CT_ c) => c.breadcrumbName,
11602+
renderVariable:
11603+
(CT_ c, Property<CT_> self, List<String> remainingNames) {
11604+
if (remainingNames.isEmpty) {
11605+
return self.getValue(c).toString();
11606+
}
11607+
var name = remainingNames.first;
11608+
var nextProperty =
11609+
_Renderer_String.propertyMap().getValue(name);
11610+
return nextProperty.renderVariable(
11611+
self.getValue(c) as String,
11612+
nextProperty,
11613+
[...remainingNames.skip(1)]);
11614+
},
11615+
isNullValue: (CT_ c) => false,
11616+
renderValue: (CT_ c, RendererBase<CT_> r,
11617+
List<MustachioNode> ast, StringSink sink) {
11618+
_render_String(c.breadcrumbName, ast, r.template, sink,
11619+
parent: r);
11620+
},
11621+
),
11622+
'displayName': Property(
11623+
getValue: (CT_ c) => c.displayName,
11624+
renderVariable:
11625+
(CT_ c, Property<CT_> self, List<String> remainingNames) {
11626+
if (remainingNames.isEmpty) {
11627+
return self.getValue(c).toString();
11628+
}
11629+
var name = remainingNames.first;
11630+
var nextProperty =
11631+
_Renderer_String.propertyMap().getValue(name);
11632+
return nextProperty.renderVariable(
11633+
self.getValue(c) as String,
11634+
nextProperty,
11635+
[...remainingNames.skip(1)]);
11636+
},
11637+
isNullValue: (CT_ c) => false,
11638+
renderValue: (CT_ c, RendererBase<CT_> r,
11639+
List<MustachioNode> ast, StringSink sink) {
11640+
_render_String(c.displayName, ast, r.template, sink,
11641+
parent: r);
11642+
},
11643+
),
1154711644
'fullyQualifiedName': Property(
1154811645
getValue: (CT_ c) => c.fullyQualifiedName,
1154911646
renderVariable:
@@ -16886,10 +16983,12 @@ const _invisibleGetters = {
1688616983
'allLibraries',
1688716984
'allLibrariesAdded',
1688816985
'allLocalModelElements',
16986+
'breadcrumbName',
1688916987
'config',
1689016988
'dartCoreObject',
1689116989
'defaultPackage',
1689216990
'defaultPackageName',
16991+
'displayName',
1689316992
'documentedExtensions',
1689416993
'documentedPackages',
1689516994
'extensions',

0 commit comments

Comments
 (0)