Skip to content

Upgrade dartdoc to 0.21.1 #1650

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 2 commits into from
Sep 26, 2018
Merged

Upgrade dartdoc to 0.21.1 #1650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47a38eb
Upgrade customization tests
isoos Sep 25, 2018
0ff9ddb
Upgrade dartdoc to 0.21.1
isoos Sep 25, 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
4 changes: 2 additions & 2 deletions app/lib/shared/versions.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ final RegExp runtimeVersionPattern = new RegExp(r'\d{4}\.\d{2}\.\d{2}');
/// Increment the version when a change is significant enough to trigger
/// reprocessing, including: version change in pana, dartdoc, or the SDKs,
/// or when an feature or bugfix should be picked up by the analysis ASAP.
final String runtimeVersion = '2018.09.17';
final String runtimeVersion = '2018.09.25';
final Version semanticRuntimeVersion = new Version.parse(runtimeVersion);

/// The version which marks the earliest version of the data which we'd like to
Expand All @@ -41,7 +41,7 @@ final Version semanticPanaVersion = new Version.parse(panaVersion);
final String flutterVersion = '0.8.4';
final Version semanticFlutterVersion = new Version.parse(flutterVersion);

final String dartdocVersion = '0.20.4';
final String dartdocVersion = '0.21.1';
final Version semanticDartdocVersion = new Version.parse(dartdocVersion);

/// The version of our customization going into the output of the dartdoc static
Expand Down
6 changes: 3 additions & 3 deletions app/test/dartdoc/golden/pana_0.12.2_index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="made with love by dartdoc 0.20.4">
<meta name="generator" content="made with love by dartdoc 0.21.1">
Copy link

Choose a reason for hiding this comment

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

Can we mock out the dartdoc version so updating it doesn't change this file unless the output format actually changed?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'd rather keep it here, because updating the customization may not be at the same time with the update of the dartdoc version.

<meta name="description" content="pana API docs, for the Dart programming language.">
<title>pana - Dart API docs</title>
<link rel="canonical" href="https://pub.dartlang.org/documentation/pana/0.12.2/index.html">
Expand Down Expand Up @@ -76,12 +76,12 @@ <h3 id="usage">Usage</h3>
<h2>Libraries</h2>
<dl>
<dt id="models">
<span class="name"><a href="models/models-library.html">models</a></span>
<span class="name"><a href="models/models-library.html">models</a></span>
</dt>
<dd>

</dd> <dt id="pana">
<span class="name"><a href="pana/pana-library.html">pana</a></span>
<span class="name"><a href="pana/pana-library.html">pana</a></span>
</dt>
<dd>

Expand Down
6 changes: 3 additions & 3 deletions app/test/dartdoc/golden/pana_0.12.2_index.out.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="made with love by dartdoc 0.20.4">
<meta name="generator" content="made with love by dartdoc 0.21.1">
<meta name="description" content="pana API docs, for the Dart programming language.">
<title>pana - Dart API docs</title>
<link rel="alternate" href="/documentation/pana/latest/">
Expand Down Expand Up @@ -87,12 +87,12 @@ <h3 id="usage">Usage</h3>
<h2>Libraries</h2>
<dl>
<dt id="models">
<span class="name"><a href="models/models-library.html">models</a></span>
<span class="name"><a href="models/models-library.html">models</a></span>
Copy link

Choose a reason for hiding this comment

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

Should the trailing whitespace be reported as a bug in dartdoc?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Reported: dart-lang/dartdoc#1762

</dt>
<dd>

</dd> <dt id="pana">
<span class="name"><a href="pana/pana-library.html">pana</a></span>
<span class="name"><a href="pana/pana-library.html">pana</a></span>
</dt>
<dd>

Expand Down
26 changes: 13 additions & 13 deletions app/test/dartdoc/golden/pana_0.12.2_license_file_class.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ <h5>pana library</h5>
</div>

<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>LicenseFile class</h1>
<h1>LicenseFile class </h1>


<section>
Expand Down Expand Up @@ -167,55 +167,55 @@ <h2>Properties</h2>
<dl class="properties">
<dt id="hashCode" class="property">
<span class="name"><a href="pana/LicenseFile/hashCode.html">hashCode</a></span>
<span class="signature">&#8594; int</span>
<span class="signature">&#8594; int</span>
</dt>
<dd>
The hash code for this object. <a href="pana/LicenseFile/hashCode.html">[...]</a>
<div class="features">read-only</div>
</dd>
<dt id="name" class="property">
<span class="name"><a href="pana/LicenseFile/name.html">name</a></span>
<span class="signature">&#8594; String</span>
<span class="signature">&#8594; String</span>
</dt>
<dd>

<div class="features">final</div>
</dd>
<dt id="path" class="property">
<span class="name"><a href="pana/LicenseFile/path.html">path</a></span>
<span class="signature">&#8594; String</span>
<span class="signature">&#8594; String</span>
</dt>
<dd>

<div class="features">final</div>
</dd>
<dt id="shortFormatted" class="property">
<span class="name"><a href="pana/LicenseFile/shortFormatted.html">shortFormatted</a></span>
<span class="signature">&#8594; String</span>
<span class="signature">&#8594; String</span>
</dt>
<dd>

<div class="features">read-only</div>
</dd>
<dt id="url" class="property">
<span class="name"><a href="pana/LicenseFile/url.html">url</a></span>
<span class="signature">&#8594; String</span>
<span class="signature">&#8594; String</span>
</dt>
<dd>

<div class="features">@JsonKey(includeIfNull: false), final</div>
</dd>
<dt id="version" class="property">
<span class="name"><a href="pana/LicenseFile/version.html">version</a></span>
<span class="signature">&#8594; String</span>
<span class="signature">&#8594; String</span>
</dt>
<dd>

<div class="features">@JsonKey(includeIfNull: false), final</div>
</dd>
<dt id="runtimeType" class="property inherited">
<span class="name"><a href="pana/LicenseFile/runtimeType.html">runtimeType</a></span>
<span class="signature">&#8594; Type</span>
<span class="signature">&#8594; Type</span>
</dt>
<dd class="inherited">
A representation of the runtime type of the object.
Expand All @@ -231,7 +231,7 @@ <h2>Methods</h2>
<span class="name"><a href="pana/LicenseFile/change.html">change</a></span><span class="signature">(<wbr>{<span class="parameter" id="change-param-url"><span class="type-annotation">String</span> <span class="parameter-name">url</span></span> })
<span class="returntype parameter">&#8594; <a href="pana/LicenseFile-class.html">LicenseFile</a></span>
</span>
</dt>
</dt>
<dd>


Expand All @@ -240,7 +240,7 @@ <h2>Methods</h2>
<span class="name"><a href="pana/LicenseFile/toString.html">toString</a></span><span class="signature">(<wbr>)
<span class="returntype parameter">&#8594; String</span>
</span>
</dt>
</dt>
<dd>
Returns a string representation of this object.

Expand All @@ -249,7 +249,7 @@ <h2>Methods</h2>
<span class="name"><a href="pana/LicenseFile/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation">Invocation</span> <span class="parameter-name">invocation</span></span>)
<span class="returntype parameter">&#8594; dynamic</span>
</span>
</dt>
</dt>
<dd class="inherited">
Invoked when a non-existent method or property is accessed. <a href="pana/LicenseFile/noSuchMethod.html">[...]</a>
<div class="features">inherited</div>
Expand All @@ -258,7 +258,7 @@ <h2>Methods</h2>
<span class="name"><a href="pana/LicenseFile/toJson.html">toJson</a></span><span class="signature">(<wbr>)
<span class="returntype parameter">&#8594; Map<span class="signature">&lt;<wbr><span class="type-parameter">String</span>, <span class="type-parameter">dynamic</span>&gt;</span></span>
</span>
</dt>
</dt>
<dd class="inherited">

<div class="features">inherited</div>
Expand All @@ -273,7 +273,7 @@ <h2>Operators</h2>
<span class="name"><a href="pana/LicenseFile/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation">Object</span> <span class="parameter-name">other</span></span>)
<span class="returntype parameter">&#8594; bool</span>
</span>
</dt>
</dt>
<dd>
The equality operator. <a href="pana/LicenseFile/operator_equals.html">[...]</a>

Expand Down
26 changes: 13 additions & 13 deletions app/test/dartdoc/golden/pana_0.12.2_license_file_class.out.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ <h5>pana library</h5>
</div>

<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>LicenseFile class</h1>
<h1>LicenseFile class </h1>


<section>
Expand Down Expand Up @@ -177,55 +177,55 @@ <h2>Properties</h2>
<dl class="properties">
<dt id="hashCode" class="property">
<span class="name"><a href="pana/LicenseFile/hashCode.html">hashCode</a></span>
<span class="signature">→ int</span>
<span class="signature">→ int</span>
</dt>
<dd>
The hash code for this object. <a href="pana/LicenseFile/hashCode.html">[...]</a>
<div class="features">read-only</div>
</dd>
<dt id="name" class="property">
<span class="name"><a href="pana/LicenseFile/name.html">name</a></span>
<span class="signature">→ String</span>
<span class="signature">→ String</span>
</dt>
<dd>

<div class="features">final</div>
</dd>
<dt id="path" class="property">
<span class="name"><a href="pana/LicenseFile/path.html">path</a></span>
<span class="signature">→ String</span>
<span class="signature">→ String</span>
</dt>
<dd>

<div class="features">final</div>
</dd>
<dt id="shortFormatted" class="property">
<span class="name"><a href="pana/LicenseFile/shortFormatted.html">shortFormatted</a></span>
<span class="signature">→ String</span>
<span class="signature">→ String</span>
</dt>
<dd>

<div class="features">read-only</div>
</dd>
<dt id="url" class="property">
<span class="name"><a href="pana/LicenseFile/url.html">url</a></span>
<span class="signature">→ String</span>
<span class="signature">→ String</span>
</dt>
<dd>

<div class="features">@JsonKey(includeIfNull: false), final</div>
</dd>
<dt id="version" class="property">
<span class="name"><a href="pana/LicenseFile/version.html">version</a></span>
<span class="signature">→ String</span>
<span class="signature">→ String</span>
</dt>
<dd>

<div class="features">@JsonKey(includeIfNull: false), final</div>
</dd>
<dt id="runtimeType" class="property inherited">
<span class="name"><a href="pana/LicenseFile/runtimeType.html">runtimeType</a></span>
<span class="signature">→ Type</span>
<span class="signature">→ Type</span>
</dt>
<dd class="inherited">
A representation of the runtime type of the object.
Expand All @@ -241,7 +241,7 @@ <h2>Methods</h2>
<span class="name"><a href="pana/LicenseFile/change.html">change</a></span><span class="signature">(<wbr>{<span class="parameter" id="change-param-url"><span class="type-annotation">String</span> <span class="parameter-name">url</span></span> })
<span class="returntype parameter">→ <a href="pana/LicenseFile-class.html">LicenseFile</a></span>
</span>
</dt>
</dt>
<dd>


Expand All @@ -250,7 +250,7 @@ <h2>Methods</h2>
<span class="name"><a href="pana/LicenseFile/toString.html">toString</a></span><span class="signature">(<wbr>)
<span class="returntype parameter">→ String</span>
</span>
</dt>
</dt>
<dd>
Returns a string representation of this object.

Expand All @@ -259,7 +259,7 @@ <h2>Methods</h2>
<span class="name"><a href="pana/LicenseFile/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation">Invocation</span> <span class="parameter-name">invocation</span></span>)
<span class="returntype parameter">→ dynamic</span>
</span>
</dt>
</dt>
<dd class="inherited">
Invoked when a non-existent method or property is accessed. <a href="pana/LicenseFile/noSuchMethod.html">[...]</a>
<div class="features">inherited</div>
Expand All @@ -268,7 +268,7 @@ <h2>Methods</h2>
<span class="name"><a href="pana/LicenseFile/toJson.html">toJson</a></span><span class="signature">(<wbr>)
<span class="returntype parameter">→ Map<span class="signature">&lt;<wbr><span class="type-parameter">String</span>, <span class="type-parameter">dynamic</span>&gt;</span></span>
</span>
</dt>
</dt>
<dd class="inherited">

<div class="features">inherited</div>
Expand All @@ -283,7 +283,7 @@ <h2>Operators</h2>
<span class="name"><a href="pana/LicenseFile/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation">Object</span> <span class="parameter-name">other</span></span>)
<span class="returntype parameter">→ bool</span>
</span>
</dt>
</dt>
<dd>
The equality operator. <a href="pana/LicenseFile/operator_equals.html">[...]</a>

Expand Down
2 changes: 1 addition & 1 deletion app/test/dartdoc/golden/pana_0.12.2_pretty_json.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ <h5>pana library</h5>
</div><!--/.sidebar-offcanvas-left-->

<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>prettyJson function</h1>
<h1>prettyJson function </h1>

<section class="multi-line-signature">
<span class="returntype">String</span>
Expand Down
2 changes: 1 addition & 1 deletion app/test/dartdoc/golden/pana_0.12.2_pretty_json.out.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ <h5>pana library</h5>
</div><!--/.sidebar-offcanvas-left-->

<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>prettyJson function</h1>
<h1>prettyJson function </h1>

<section class="multi-line-signature">
<span class="returntype">String</span>
Expand Down
2 changes: 1 addition & 1 deletion app/test/shared/versions_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ void main() {
// This test is a reminder that if pana, the SDK or any of the above
// versions change, we should also adjust the [runtimeVersion]. Before
// updating the hash value, double-check if it is being updated.
expect(hash, 643525684);
expect(hash, 575265127);
});

test('runtime version should be (somewhat) lexicographically ordered', () {
Expand Down
2 changes: 1 addition & 1 deletion pkg/pub_dartdoc/pubspec.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ packages:
name: dartdoc
url: "https://pub.dartlang.org"
source: hosted
version: "0.20.4"
version: "0.21.1"
fixnum:
dependency: transitive
description:
Expand Down
2 changes: 1 addition & 1 deletion pkg/pub_dartdoc/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ dependencies:
meta: ^1.1.5
path: ^1.6.0
# dartdoc version to be pinned
dartdoc: 0.20.4
dartdoc: 0.21.1

dev_dependencies:
build_runner: '^0.10.0'
Expand Down
1 change: 1 addition & 0 deletions pkg/pub_dartdoc/test/self_documenting_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ main() {
files.sort();
expect(files, [
'__404error.html',
'categories.json',
'index.html',
'index.json',
'pub-data.json',
Expand Down