From 9dffa473a5371f8f8e1520c7b37cbf88ab3ad59a Mon Sep 17 00:00:00 2001 From: Sarah Zakarias Date: Mon, 8 Sep 2025 10:40:58 +0000 Subject: [PATCH 1/2] Remove deprecated public API exports --- CHANGELOG.md | 1 + lib/dartdoc.dart | 16 ---------------- lib/options.dart | 7 ------- 3 files changed, 1 insertion(+), 23 deletions(-) delete mode 100644 lib/dartdoc.dart delete mode 100644 lib/options.dart diff --git a/CHANGELOG.md b/CHANGELOG.md index e6564ce7a8..14682b7d1c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ * Refactor 404 error page to use div instead of p for search form. * Require analyzer 8.1.1 APIs. * Many internal migrations for analyzer APIs. +* Remove deprecated public API exports ## 8.3.4 * The URL for category pages now uses _category name_ instead of diff --git a/lib/dartdoc.dart b/lib/dartdoc.dart deleted file mode 100644 index d5270b8374..0000000000 --- a/lib/dartdoc.dart +++ /dev/null @@ -1,16 +0,0 @@ -// Copyright (c) 2014, the Dart project authors. Please see the AUTHORS file -// 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. - -/// A documentation generator for Dart. -@Deprecated('Will be removed in a later version of DartDoc.') -library; - -export 'package:dartdoc/src/dartdoc.dart'; -export 'package:dartdoc/src/dartdoc_options.dart'; -export 'package:dartdoc/src/generator/generator.dart'; -export 'package:dartdoc/src/model/kind.dart'; -export 'package:dartdoc/src/model/package_builder.dart'; -export 'package:dartdoc/src/model/package_graph.dart'; -export 'package:dartdoc/src/package_config_provider.dart'; -export 'package:dartdoc/src/package_meta.dart'; diff --git a/lib/options.dart b/lib/options.dart deleted file mode 100644 index b75f21541e..0000000000 --- a/lib/options.dart +++ /dev/null @@ -1,7 +0,0 @@ -// Copyright (c) 2023, the Dart project authors. Please see the AUTHORS file -// 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. - -@Deprecated( - 'Will be removed in a later version of DartDoc. Use /src/dartdoc_options.dart.') -export 'package:dartdoc/src/dartdoc_options.dart'; From dfd2e45c5374e414f46f2a6cd14f82a72f01e574 Mon Sep 17 00:00:00 2001 From: Sarah Zakarias Date: Mon, 8 Sep 2025 12:05:08 +0000 Subject: [PATCH 2/2] start with deprecating lib/options.dart --- CHANGELOG.md | 2 +- lib/dartdoc.dart | 16 ++++++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 lib/dartdoc.dart diff --git a/CHANGELOG.md b/CHANGELOG.md index 14682b7d1c..7e6d388256 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,7 @@ * Refactor 404 error page to use div instead of p for search form. * Require analyzer 8.1.1 APIs. * Many internal migrations for analyzer APIs. -* Remove deprecated public API exports +* Remove deprecated public export of options.dart ## 8.3.4 * The URL for category pages now uses _category name_ instead of diff --git a/lib/dartdoc.dart b/lib/dartdoc.dart new file mode 100644 index 0000000000..d5270b8374 --- /dev/null +++ b/lib/dartdoc.dart @@ -0,0 +1,16 @@ +// Copyright (c) 2014, the Dart project authors. Please see the AUTHORS file +// 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. + +/// A documentation generator for Dart. +@Deprecated('Will be removed in a later version of DartDoc.') +library; + +export 'package:dartdoc/src/dartdoc.dart'; +export 'package:dartdoc/src/dartdoc_options.dart'; +export 'package:dartdoc/src/generator/generator.dart'; +export 'package:dartdoc/src/model/kind.dart'; +export 'package:dartdoc/src/model/package_builder.dart'; +export 'package:dartdoc/src/model/package_graph.dart'; +export 'package:dartdoc/src/package_config_provider.dart'; +export 'package:dartdoc/src/package_meta.dart';