From 100f8cba6602a9bfcb5f8c90585781d251361a33 Mon Sep 17 00:00:00 2001 From: Janice Collins Date: Fri, 1 Dec 2017 12:04:49 -0800 Subject: [PATCH 1/4] Upgrade to 0.15.0 --- CHANGELOG.md | 18 +++++++++++++++++- lib/dartdoc.dart | 2 +- pubspec.yaml | 2 +- 3 files changed, 19 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bb559f4461..57d2889e93 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,21 @@ -## unreleased +## 0.15.0 +* Allow super in mixins (#1541) +* Anonymous libraries are now laid out on disk differently + to avoid conflicts (#1526) +* Source code included with docs highlights again (#1525) +* Remove constant value linking via string substitution (#1535) +* Update version of mustache4dart (#1540) +* Eliminate remaining places where dartdoc exposed private interfaces + (#1173) +* Fix private super classes appearing with dead links (#1476) +* Major internal refactoring of public/private, type definitions, + templates, and warnings (#1394, #1539) +* Fix resolution of generic types (#1514) +* Limit width of code blocks (#1522) * Add a `--json` flag to providing logging in a machine-readable format. + (#1531) +* Use the logging package for dartdoc output. (#1518) +* Remove cc commons license text from default footer (#1262) ## 0.14.1 * Add better support for GenericFunctionTypeElementImpl (#1506, #1509) diff --git a/lib/dartdoc.dart b/lib/dartdoc.dart index 2aed561d62..e6e3eddb67 100644 --- a/lib/dartdoc.dart +++ b/lib/dartdoc.dart @@ -35,7 +35,7 @@ export 'src/sdk.dart'; const String name = 'dartdoc'; // Update when pubspec version changes. -const String version = '0.14.2-dev'; +const String version = '0.15.0'; final String defaultOutDir = path.join('doc', 'api'); diff --git a/pubspec.yaml b/pubspec.yaml index f95de927c5..4969789ca1 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: dartdoc # Also update the `version` field in lib/dartdoc.dart. -version: 0.14.2-dev +version: 0.15.0 author: Dart Team description: A documentation generator for Dart. homepage: https://github.com/dart-lang/dartdoc From b2e3e28a4886c765ee5e03270b7adef726f31136 Mon Sep 17 00:00:00 2001 From: Janice Collins Date: Fri, 1 Dec 2017 15:18:31 -0800 Subject: [PATCH 2/4] One more change.. --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 57d2889e93..6af922b2f7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,6 @@ ## 0.15.0 +* Document correct parameters for new-style generic function types + (#1472) * Allow super in mixins (#1541) * Anonymous libraries are now laid out on disk differently to avoid conflicts (#1526) From c36c88d61be0c1dfd26c272618b04476fd6f552d Mon Sep 17 00:00:00 2001 From: Janice Collins Date: Tue, 5 Dec 2017 09:46:20 -0800 Subject: [PATCH 3/4] Fine-tune changelog and assume #1558 will make it --- CHANGELOG.md | 24 +++++++++++++++++++----- testing/test_package_docs/index.html | 2 +- 2 files changed, 20 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6af922b2f7..36180d5e68 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,17 +1,31 @@ ## 0.15.0 +* Breaking change: Allow mixins that call their super-classes. (#1555) +* Breaking change: Anonymous libraries are now laid out on disk + differently to avoid conflicts (#1526) +* Breaking change: The meaning of --auto-include-dependencies has changed to + include all libraries in any package depended on by this package (determined + by the .packages file) (#1524) +* Breaking change: The meaning of --include and --exclude has changed to + require import paths for anonymous libraries, and accept them for other + libraries. (#1524) +* Type parameters for classes now appear next to them on the library page + (#1558) +* GFM-style tables are now supported in Dartdoc markdown (#1557, #1453) +* Navigation and constructor docs now show generic types in more places + (#1556, #1453) +* A new parameter, --exclude-packages, now enables dartdoc to hide entire + packages from --auto-include-dependencies or other --include options. * Document correct parameters for new-style generic function types (#1472) * Allow super in mixins (#1541) -* Anonymous libraries are now laid out on disk differently - to avoid conflicts (#1526) * Source code included with docs highlights again (#1525) * Remove constant value linking via string substitution (#1535) -* Update version of mustache4dart (#1540) +* Update version of mustache4dart and fix minor template errors (#1540) * Eliminate remaining places where dartdoc exposed private interfaces (#1173) * Fix private super classes appearing with dead links (#1476) -* Major internal refactoring of public/private, type definitions, - templates, and warnings (#1394, #1539) +* Breaking change: Major internal refactoring of public/private, + type definitions, templates, and warnings (#1394, #1539) * Fix resolution of generic types (#1514) * Limit width of code blocks (#1522) * Add a `--json` flag to providing logging in a machine-readable format. diff --git a/testing/test_package_docs/index.html b/testing/test_package_docs/index.html index 7d77a9421d..61f0204697 100644 --- a/testing/test_package_docs/index.html +++ b/testing/test_package_docs/index.html @@ -4,7 +4,7 @@ - + test_package - Dart API docs From c37683c7b6afe592241216776e5da00c061a0087 Mon Sep 17 00:00:00 2001 From: Janice Collins Date: Wed, 6 Dec 2017 09:58:23 -0800 Subject: [PATCH 4/4] Changelog tweak to move breaking changes to the top --- CHANGELOG.md | 5 +++-- pubspec.lock | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 36180d5e68..d444689168 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,6 @@ ## 0.15.0 +* Breaking change: Major internal refactoring of public/private, + type definitions, templates, and warnings. (#1524, #1539) * Breaking change: Allow mixins that call their super-classes. (#1555) * Breaking change: Anonymous libraries are now laid out on disk differently to avoid conflicts (#1526) @@ -8,6 +10,7 @@ * Breaking change: The meaning of --include and --exclude has changed to require import paths for anonymous libraries, and accept them for other libraries. (#1524) +* The Interceptor class from the SDK is now cloaked (#1524) * Type parameters for classes now appear next to them on the library page (#1558) * GFM-style tables are now supported in Dartdoc markdown (#1557, #1453) @@ -24,8 +27,6 @@ * Eliminate remaining places where dartdoc exposed private interfaces (#1173) * Fix private super classes appearing with dead links (#1476) -* Breaking change: Major internal refactoring of public/private, - type definitions, templates, and warnings (#1394, #1539) * Fix resolution of generic types (#1514) * Limit width of code blocks (#1522) * Add a `--json` flag to providing logging in a machine-readable format. diff --git a/pubspec.lock b/pubspec.lock index e7d86666e6..266c038089 100644 --- a/pubspec.lock +++ b/pubspec.lock @@ -350,4 +350,4 @@ packages: source: hosted version: "2.1.13" sdks: - dart: ">=1.23.0 <=2.0.0-dev.8.0" + dart: ">=1.23.0 <=2.0.0-dev.10.0"