diff --git a/CHANGELOG.md b/CHANGELOG.md index 2c483291e49..79ffbe825d1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,6 +25,15 @@ [an issue]: https://github.com/dart-lang/sdk/issues/new +- **Breaking Change** [#46100](https://github.com/dart-lang/sdk/issues/46100): + The standalone `dartdoc` tool has been + marked deprecated as previously announced. + Its replacement is the `dart doc` command. + Should you find any issues, or missing features, in the replacement + command, kindly file [an issue][]. + +[an issue]: https://github.com/dart-lang/sdk/issues/new + #### Linter Updated the Linter to `1.15.0`, which includes changes that diff --git a/sdk/bin/dartdoc b/sdk/bin/dartdoc index f7ad6828eeb..b7817c8503a 100755 --- a/sdk/bin/dartdoc +++ b/sdk/bin/dartdoc @@ -3,6 +3,8 @@ # for details. All rights reserved. Use of this source code is governed by a # BSD-style license that can be found in the LICENSE file. +echo "Warning: 'dartdoc' is deprecated. Please use 'dart doc'." 1>&2 + function follow_links() { file="$1" while [ -h "$file" ]; do diff --git a/sdk/bin/dartdoc.bat b/sdk/bin/dartdoc.bat index 876eb0e2a4e..ea32a87e897 100644 --- a/sdk/bin/dartdoc.bat +++ b/sdk/bin/dartdoc.bat @@ -3,6 +3,8 @@ REM Copyright (c) 2015, the Dart project authors. Please see the AUTHORS file REM for details. All rights reserved. Use of this source code is governed by a REM BSD-style license that can be found in the LICENSE file. +echo Warning: 'dartdoc' is deprecated. Please use 'dart doc'. 1>&2 + setlocal rem Handle the case where dart-sdk/bin has been symlinked to. set DIR_NAME_WITH_SLASH=%~dp0