Skip to content

Commit 0499c4e

Browse files
authored
Deprecate public exports in lib/dartdoc.dart. (#3589)
1 parent 7c2d9f0 commit 0499c4e

File tree

6 files changed

+9
-5
lines changed

6 files changed

+9
-5
lines changed

bin/dartdoc.dart

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,11 @@ library dartdoc.bin;
66

77
import 'dart:async';
88

9-
import 'package:dartdoc/dartdoc.dart';
109
import 'package:dartdoc/options.dart';
10+
import 'package:dartdoc/src/dartdoc.dart';
11+
import 'package:dartdoc/src/model/model.dart';
12+
import 'package:dartdoc/src/package_config_provider.dart';
13+
import 'package:dartdoc/src/package_meta.dart';
1114

1215
/// Analyzes Dart files and generates a representation of included libraries,
1316
/// classes, and members. Uses the current directory to look for libraries.

lib/dartdoc.dart

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
// BSD-style license that can be found in the LICENSE file.
44

55
/// A documentation generator for Dart.
6+
@Deprecated('Will be removed in a later version of DartDoc.')
67
library dartdoc;
78

89
export 'package:dartdoc/src/dartdoc.dart';

lib/options.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import 'dart:io' show stderr, exitCode;
22

33
import 'package:args/args.dart';
4-
import 'package:dartdoc/dartdoc.dart' show dartdocVersion, programName;
4+
import 'package:dartdoc/src/dartdoc.dart' show dartdocVersion, programName;
55
import 'package:dartdoc/src/dartdoc_options.dart';
66
import 'package:dartdoc/src/generator/generator.dart';
77
import 'package:dartdoc/src/logging.dart';

test/end2end/dartdoc_test.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ library dartdoc.dartdoc_test;
77
import 'dart:async';
88

99
import 'package:analyzer/file_system/file_system.dart';
10-
import 'package:dartdoc/dartdoc.dart' show Dartdoc, DartdocResults;
1110
import 'package:dartdoc/options.dart';
11+
import 'package:dartdoc/src/dartdoc.dart' show Dartdoc, DartdocResults;
1212
import 'package:dartdoc/src/dartdoc_options.dart';
1313
import 'package:dartdoc/src/failure.dart';
1414
import 'package:dartdoc/src/io_utils.dart';

test/html_generator_test.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
import 'package:analyzer/file_system/file_system.dart';
66
import 'package:analyzer/file_system/memory_file_system.dart';
7-
import 'package:dartdoc/dartdoc.dart' show DartdocFileWriter;
87
import 'package:dartdoc/options.dart';
8+
import 'package:dartdoc/src/dartdoc.dart' show DartdocFileWriter;
99
import 'package:dartdoc/src/dartdoc_options.dart';
1010
import 'package:dartdoc/src/generator/generator.dart';
1111
import 'package:dartdoc/src/generator/generator_backend.dart';

test/mustachio/renderers_output_test.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ import 'dart:io';
99

1010
import 'package:analyzer/file_system/file_system.dart';
1111
import 'package:analyzer/file_system/memory_file_system.dart';
12-
import 'package:dartdoc/dartdoc.dart' show Dartdoc, DartdocFileWriter;
1312
import 'package:dartdoc/options.dart';
13+
import 'package:dartdoc/src/dartdoc.dart' show Dartdoc, DartdocFileWriter;
1414
import 'package:dartdoc/src/dartdoc_options.dart';
1515
import 'package:dartdoc/src/generator/generator.dart';
1616
import 'package:dartdoc/src/generator/html_generator.dart';

0 commit comments

Comments
 (0)