Skip to content

Commit ff194f4

Browse files
devoncarewdevoncarew
authored
Merge pull request #1223 from dart-lang/packages_name
don't show package label for sdk docs
2 parents ee8272b + ec88d2a commit ff194f4

39 files changed

+70
-14
lines changed

‎lib/resources/styles.css‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -508,7 +508,7 @@ ul.subnav {
508508
overflow: auto;
509509
white-space: nowrap;
510510
padding-left: 0;
511-
min-height: 24px;
511+
min-height: 25px;
512512
}
513513

514514
ul.subnav::-webkit-scrollbar {

‎lib/src/html/template_data.dart‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -49,21 +49,21 @@ abstract class TemplateData<T extends Documentable> {
4949
String get version => htmlOptions.toolVersion;
5050
String get relCanonicalPrefix => htmlOptions.relCanonicalPrefix;
5151

52-
Iterable<Subnav> getSubNavItems() => const Iterable<Subnav>.empty();
52+
Iterable<Subnav> getSubNavItems() => <Subnav>[];
5353

5454
String _layoutTitle(String name, String kind, bool isDeprecated) {
55-
if (kind.isEmpty)
56-
kind =
57-
'&nbsp;'; // Ugly. fixes https://github.com/dart-lang/dartdoc/issues/695
55+
if (kind.isEmpty) kind = '&nbsp;';
5856
String str = '<span class="kind">$kind</span>';
5957
if (!isDeprecated) return '${str} ${name}';
6058
return '${str} <span class="deprecated">$name</span>';
6159
}
6260

63-
Iterable<Subnav> _gatherSubnavForInvokable(ModelElement element) sync* {
61+
Iterable<Subnav> _gatherSubnavForInvokable(ModelElement element) {
6462
if (element is SourceCodeMixin &&
6563
(element as SourceCodeMixin).hasSourceCode) {
66-
yield new Subnav('Source', '${element.href}#source');
64+
return [new Subnav('Source', '${element.href}#source')];
65+
} else {
66+
return <Subnav>[];
6767
}
6868
}
6969
}
@@ -83,14 +83,14 @@ class PackageTemplateData extends TemplateData<Package> {
8383
@override
8484
Package get self => package;
8585
@override
86-
String get layoutTitle =>
87-
_layoutTitle(package.name, package.isSdk ? '' : 'package', false);
86+
String get layoutTitle => _layoutTitle(
87+
package.name, (useCategories || package.isSdk) ? '' : 'package', false);
8888
@override
8989
String get metaDescription =>
9090
'${package.name} API docs, for the Dart programming language.';
9191
@override
92-
Iterable<Subnav> getSubNavItems() sync* {
93-
yield new Subnav('Libraries', '${package.href}#libraries');
92+
Iterable<Subnav> getSubNavItems() {
93+
return [new Subnav('Libraries', '${package.href}#libraries')];
9494
}
9595

9696
/// `null` for packages because they are at the root – not needed
@@ -177,13 +177,13 @@ class ClassTemplateData extends TemplateData<Class> {
177177
yield new Subnav('Static Properties', '${clazz.href}#static-properties');
178178
if (clazz.hasStaticMethods)
179179
yield new Subnav('Static Methods', '${clazz.href}#static-methods');
180-
if (clazz.hasInstanceProperties)
180+
if (clazz.hasProperties)
181181
yield new Subnav('Properties', '${clazz.href}#instance-properties');
182182
if (clazz.hasConstructors)
183183
yield new Subnav('Constructors', '${clazz.href}#constructors');
184184
if (clazz.hasOperators)
185185
yield new Subnav('Operators', '${clazz.href}#operators');
186-
if (clazz.hasInstanceMethods)
186+
if (clazz.hasMethods)
187187
yield new Subnav('Methods', '${clazz.href}#instance-methods');
188188
}
189189

@@ -383,6 +383,8 @@ class TypedefTemplateData extends TemplateData<Typedef> {
383383
List get navLinks => [package, library];
384384
@override
385385
String get htmlBase => '..';
386+
@override
387+
Iterable<Subnav> getSubNavItems() => _gatherSubnavForInvokable(typeDef);
386388
}
387389

388390
class TopLevelPropertyTemplateData extends TemplateData<TopLevelVariable> {

‎testing/test_package_docs/ex/CatString-class.html‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,10 @@ <h1 class="title">
5757
</h1>
5858
</div>
5959
<ul class="subnav">
60+
<li><a href="ex/CatString-class.html#instance-properties">Properties</a></li>
6061
<li><a href="ex/CatString-class.html#constructors">Constructors</a></li>
6162
<li><a href="ex/CatString-class.html#operators">Operators</a></li>
63+
<li><a href="ex/CatString-class.html#instance-methods">Methods</a></li>
6264
</ul>
6365
</div> <!-- /col -->
6466
</div> <!-- /row -->

‎testing/test_package_docs/ex/Cool-class.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ <h1 class="title">
5757
</h1>
5858
</div>
5959
<ul class="subnav">
60+
<li><a href="ex/Cool-class.html#instance-properties">Properties</a></li>
6061
<li><a href="ex/Cool-class.html#constructors">Constructors</a></li>
6162
<li><a href="ex/Cool-class.html#operators">Operators</a></li>
6263
<li><a href="ex/Cool-class.html#instance-methods">Methods</a></li>

‎testing/test_package_docs/ex/E-class.html‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,10 @@ <h1 class="title">
5757
</h1>
5858
</div>
5959
<ul class="subnav">
60+
<li><a href="ex/E-class.html#instance-properties">Properties</a></li>
6061
<li><a href="ex/E-class.html#constructors">Constructors</a></li>
6162
<li><a href="ex/E-class.html#operators">Operators</a></li>
63+
<li><a href="ex/E-class.html#instance-methods">Methods</a></li>
6264
</ul>
6365
</div> <!-- /col -->
6466
</div> <!-- /row -->

‎testing/test_package_docs/ex/F-class.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ <h1 class="title">
5757
</h1>
5858
</div>
5959
<ul class="subnav">
60+
<li><a href="ex/F-class.html#instance-properties">Properties</a></li>
6061
<li><a href="ex/F-class.html#constructors">Constructors</a></li>
6162
<li><a href="ex/F-class.html#operators">Operators</a></li>
6263
<li><a href="ex/F-class.html#instance-methods">Methods</a></li>

‎testing/test_package_docs/ex/ForAnnotation-class.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ <h1 class="title">
6060
<li><a href="ex/ForAnnotation-class.html#instance-properties">Properties</a></li>
6161
<li><a href="ex/ForAnnotation-class.html#constructors">Constructors</a></li>
6262
<li><a href="ex/ForAnnotation-class.html#operators">Operators</a></li>
63+
<li><a href="ex/ForAnnotation-class.html#instance-methods">Methods</a></li>
6364
</ul>
6465
</div> <!-- /col -->
6566
</div> <!-- /row -->

‎testing/test_package_docs/ex/HasAnnotation-class.html‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,10 @@ <h1 class="title">
5757
</h1>
5858
</div>
5959
<ul class="subnav">
60+
<li><a href="ex/HasAnnotation-class.html#instance-properties">Properties</a></li>
6061
<li><a href="ex/HasAnnotation-class.html#constructors">Constructors</a></li>
6162
<li><a href="ex/HasAnnotation-class.html#operators">Operators</a></li>
63+
<li><a href="ex/HasAnnotation-class.html#instance-methods">Methods</a></li>
6264
</ul>
6365
</div> <!-- /col -->
6466
</div> <!-- /row -->

‎testing/test_package_docs/ex/Helper-class.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ <h1 class="title">
5757
</h1>
5858
</div>
5959
<ul class="subnav">
60+
<li><a href="ex/Helper-class.html#instance-properties">Properties</a></li>
6061
<li><a href="ex/Helper-class.html#constructors">Constructors</a></li>
6162
<li><a href="ex/Helper-class.html#operators">Operators</a></li>
6263
<li><a href="ex/Helper-class.html#instance-methods">Methods</a></li>

‎testing/test_package_docs/ex/Klass-class.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ <h1 class="title">
5757
</h1>
5858
</div>
5959
<ul class="subnav">
60+
<li><a href="ex/Klass-class.html#instance-properties">Properties</a></li>
6061
<li><a href="ex/Klass-class.html#constructors">Constructors</a></li>
6162
<li><a href="ex/Klass-class.html#operators">Operators</a></li>
6263
<li><a href="ex/Klass-class.html#instance-methods">Methods</a></li>

0 commit comments

Comments
 (0)