diff --git a/lib/dartdoc.dart b/lib/dartdoc.dart index 287a71edbb..c5678fd469 100644 --- a/lib/dartdoc.dart +++ b/lib/dartdoc.dart @@ -15,6 +15,7 @@ import 'dart:io' show Platform, exitCode, stderr; import 'package:analyzer/file_system/file_system.dart'; import 'package:dartdoc/options.dart'; import 'package:dartdoc/src/dartdoc_options.dart'; +import 'package:dartdoc/src/failure.dart'; import 'package:dartdoc/src/generator/empty_generator.dart'; import 'package:dartdoc/src/generator/generator.dart'; import 'package:dartdoc/src/generator/html_generator.dart'; @@ -527,17 +528,6 @@ class Dartdoc { } } -/// This class is returned if dartdoc fails in an expected way (for instance, if -/// there is an analysis error in the library). -class DartdocFailure { - final String message; - - DartdocFailure(this.message); - - @override - String toString() => message; -} - /// The results of a [Dartdoc.generateDocs] call. class DartdocResults { final PackageMeta packageMeta; diff --git a/lib/src/dartdoc_options.dart b/lib/src/dartdoc_options.dart index 9c83b85068..65adb82f77 100644 --- a/lib/src/dartdoc_options.dart +++ b/lib/src/dartdoc_options.dart @@ -20,9 +20,10 @@ import 'dart:io' show Platform, stdout; import 'package:analyzer/dart/element/element.dart'; import 'package:analyzer/file_system/file_system.dart'; import 'package:args/args.dart'; -import 'package:dartdoc/dartdoc.dart'; import 'package:dartdoc/src/experiment_options.dart'; +import 'package:dartdoc/src/failure.dart'; import 'package:dartdoc/src/io_utils.dart'; +import 'package:dartdoc/src/package_meta.dart'; import 'package:dartdoc/src/source_linker.dart'; import 'package:dartdoc/src/tool_definition.dart'; import 'package:dartdoc/src/tool_runner.dart'; diff --git a/lib/src/failure.dart b/lib/src/failure.dart new file mode 100644 index 0000000000..fcee30ad2d --- /dev/null +++ b/lib/src/failure.dart @@ -0,0 +1,16 @@ +// Copyright (c) 2021, 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 class representing a failure during dartdoc execution. +/// +/// An instance of this is returned if dartdoc fails in an expected way (for +/// instance, if there is an analysis error in the library). +class DartdocFailure { + final String message; + + DartdocFailure(this.message); + + @override + String toString() => message; +} diff --git a/lib/src/generator/dartdoc_generator_backend.dart b/lib/src/generator/dartdoc_generator_backend.dart index 8b2d6aae8c..7ab32db4cf 100644 --- a/lib/src/generator/dartdoc_generator_backend.dart +++ b/lib/src/generator/dartdoc_generator_backend.dart @@ -3,12 +3,14 @@ // BSD-style license that can be found in the LICENSE file. import 'package:analyzer/file_system/file_system.dart'; -import 'package:dartdoc/dartdoc.dart'; import 'package:dartdoc/options.dart'; +import 'package:dartdoc/src/generator/generator.dart'; import 'package:dartdoc/src/generator/generator_frontend.dart'; import 'package:dartdoc/src/generator/generator_utils.dart' as generator_util; import 'package:dartdoc/src/generator/template_data.dart'; import 'package:dartdoc/src/generator/templates.dart'; +import 'package:dartdoc/src/model/model.dart'; +import 'package:dartdoc/src/version.dart'; import 'package:dartdoc/src/warnings.dart'; import 'package:path/path.dart' as path show Context; @@ -39,7 +41,7 @@ class DartdocGeneratorBackendOptions implements TemplateOptions { DartdocGeneratorBackendOptions.fromContext( DartdocGeneratorOptionContext context) : relCanonicalPrefix = context.relCanonicalPrefix, - toolVersion = dartdocVersion, + toolVersion = packageVersion, favicon = context.favicon, prettyIndexJson = context.prettyIndexJson, useBaseHref = context.useBaseHref, diff --git a/lib/src/generator/templates.dart b/lib/src/generator/templates.dart index 9ce0ef7fc2..52915a6f45 100644 --- a/lib/src/generator/templates.dart +++ b/lib/src/generator/templates.dart @@ -27,8 +27,9 @@ library dartdoc.templates; import 'package:analyzer/file_system/file_system.dart'; -import 'package:dartdoc/dartdoc.dart'; import 'package:dartdoc/options.dart'; +import 'package:dartdoc/src/element_type.dart'; +import 'package:dartdoc/src/failure.dart'; import 'package:dartdoc/src/generator/resource_loader.dart'; import 'package:dartdoc/src/generator/template_data.dart'; import 'package:dartdoc/src/generator/templates.aot_renderers_for_html.dart' @@ -40,6 +41,7 @@ import 'package:dartdoc/src/generator/templates.runtime_renderers.dart' import 'package:dartdoc/src/model/annotation.dart'; import 'package:dartdoc/src/model/feature_set.dart'; import 'package:dartdoc/src/model/language_feature.dart'; +import 'package:dartdoc/src/model/model.dart'; import 'package:dartdoc/src/mustachio/annotations.dart'; import 'package:dartdoc/src/mustachio/renderer_base.dart'; import 'package:meta/meta.dart'; diff --git a/lib/src/generator/templates.runtime_renderers.dart b/lib/src/generator/templates.runtime_renderers.dart index 2cf98c9c6b..f7fa4d9ad4 100644 --- a/lib/src/generator/templates.runtime_renderers.dart +++ b/lib/src/generator/templates.runtime_renderers.dart @@ -5,7 +5,7 @@ // ignore_for_file: camel_case_types, deprecated_member_use_from_same_package // ignore_for_file: unused_import -import 'package:dartdoc/dartdoc.dart'; +import 'package:dartdoc/src/element_type.dart'; import 'package:dartdoc/src/generator/template_data.dart'; import 'package:dartdoc/src/model/annotation.dart'; import 'package:dartdoc/src/model/comment_referable.dart'; @@ -13,6 +13,7 @@ import 'package:dartdoc/src/model/extension_target.dart'; import 'package:dartdoc/src/model/feature.dart'; import 'package:dartdoc/src/model/feature_set.dart'; import 'package:dartdoc/src/model/language_feature.dart'; +import 'package:dartdoc/src/model/model.dart'; import 'package:dartdoc/src/mustachio/parser.dart'; import 'package:dartdoc/src/mustachio/renderer_base.dart'; import 'package:dartdoc/src/warnings.dart'; diff --git a/lib/src/model/comment_referable.dart b/lib/src/model/comment_referable.dart index d7696cfa0e..b60174ecfa 100644 --- a/lib/src/model/comment_referable.dart +++ b/lib/src/model/comment_referable.dart @@ -11,7 +11,8 @@ import 'dart:core'; import 'package:analyzer/dart/element/element.dart'; import 'package:analyzer/dart/element/scope.dart'; -import 'package:dartdoc/dartdoc.dart'; +import 'package:dartdoc/src/model/model.dart'; +import 'package:dartdoc/src/model/package_graph.dart'; import 'package:meta/meta.dart'; class ReferenceChildrenLookup { diff --git a/lib/src/model/package_graph.dart b/lib/src/model/package_graph.dart index 937641a0e4..07b26ef911 100644 --- a/lib/src/model/package_graph.dart +++ b/lib/src/model/package_graph.dart @@ -10,8 +10,8 @@ import 'package:analyzer/file_system/file_system.dart'; import 'package:analyzer/src/generated/sdk.dart'; import 'package:analyzer/src/generated/source.dart'; import 'package:analyzer/src/generated/source_io.dart'; -import 'package:dartdoc/dartdoc.dart' show DartdocFailure; import 'package:dartdoc/src/dartdoc_options.dart'; +import 'package:dartdoc/src/failure.dart'; import 'package:dartdoc/src/logging.dart'; import 'package:dartdoc/src/model/comment_referable.dart'; import 'package:dartdoc/src/model/model.dart'; diff --git a/lib/src/model_utils.dart b/lib/src/model_utils.dart index 26dc519338..05de7de0c1 100644 --- a/lib/src/model_utils.dart +++ b/lib/src/model_utils.dart @@ -11,7 +11,7 @@ import 'package:analyzer/dart/ast/ast.dart'; import 'package:analyzer/dart/element/element.dart'; import 'package:analyzer/file_system/file_system.dart'; import 'package:analyzer/src/dart/ast/utilities.dart'; -import 'package:dartdoc/dartdoc.dart' show DartdocFailure; +import 'package:dartdoc/src/failure.dart'; import 'package:dartdoc/src/model/model.dart'; import 'package:glob/glob.dart'; import 'package:path/path.dart' as path; diff --git a/lib/src/package_meta.dart b/lib/src/package_meta.dart index 603a9f4e3a..0bf497a874 100644 --- a/lib/src/package_meta.dart +++ b/lib/src/package_meta.dart @@ -11,7 +11,8 @@ import 'package:analyzer/dart/element/element.dart'; import 'package:analyzer/file_system/file_system.dart'; import 'package:analyzer/file_system/physical_file_system.dart'; import 'package:analyzer/src/generated/sdk.dart'; -import 'package:dartdoc/dartdoc.dart'; +import 'package:dartdoc/src/dartdoc_options.dart'; +import 'package:dartdoc/src/failure.dart'; import 'package:meta/meta.dart'; import 'package:path/path.dart' as p; import 'package:yaml/yaml.dart'; diff --git a/lib/src/render/element_type_renderer.dart b/lib/src/render/element_type_renderer.dart index 5ef50c24af..3da78c6170 100644 --- a/lib/src/render/element_type_renderer.dart +++ b/lib/src/render/element_type_renderer.dart @@ -2,7 +2,7 @@ // 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. -import 'package:dartdoc/dartdoc.dart'; +import 'package:dartdoc/src/element_type.dart'; import 'package:dartdoc/src/render/parameter_renderer.dart'; abstract class ElementTypeRenderer { diff --git a/lib/src/render/renderer_factory.dart b/lib/src/render/renderer_factory.dart index 9bc6d3ba11..f975fdf1e6 100644 --- a/lib/src/render/renderer_factory.dart +++ b/lib/src/render/renderer_factory.dart @@ -2,7 +2,7 @@ // 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. -import 'package:dartdoc/dartdoc.dart'; +import 'package:dartdoc/src/element_type.dart'; import 'package:dartdoc/src/render/category_renderer.dart'; import 'package:dartdoc/src/render/documentation_renderer.dart'; import 'package:dartdoc/src/render/element_type_renderer.dart'; diff --git a/test/end2end/dartdoc_integration_test.dart b/test/end2end/dartdoc_integration_test.dart index c8bddf94ab..fa4e39d2f1 100644 --- a/test/end2end/dartdoc_integration_test.dart +++ b/test/end2end/dartdoc_integration_test.dart @@ -8,7 +8,7 @@ import 'dart:async'; import 'dart:io'; import 'dart:mirrors'; -import 'package:dartdoc/dartdoc.dart'; +import 'package:dartdoc/src/package_meta.dart'; import 'package:path/path.dart' as path; import 'package:test/test.dart'; diff --git a/test/end2end/dartdoc_test.dart b/test/end2end/dartdoc_test.dart index 9e53722e9f..ffca881e24 100644 --- a/test/end2end/dartdoc_test.dart +++ b/test/end2end/dartdoc_test.dart @@ -8,10 +8,18 @@ import 'dart:async'; import 'dart:io' show Platform; import 'package:analyzer/file_system/file_system.dart'; -import 'package:dartdoc/dartdoc.dart'; +import 'package:dartdoc/dartdoc.dart' show Dartdoc, DartdocResults; import 'package:dartdoc/options.dart'; +import 'package:dartdoc/src/dartdoc_options.dart'; +import 'package:dartdoc/src/failure.dart'; +import 'package:dartdoc/src/generator/generator.dart'; import 'package:dartdoc/src/io_utils.dart'; import 'package:dartdoc/src/logging.dart'; +import 'package:dartdoc/src/model/model.dart'; +import 'package:dartdoc/src/model/package_builder.dart'; +import 'package:dartdoc/src/model/package_graph.dart'; +import 'package:dartdoc/src/package_config_provider.dart'; +import 'package:dartdoc/src/package_meta.dart'; import 'package:dartdoc/src/warnings.dart'; import 'package:path/path.dart' as path; import 'package:pub_semver/pub_semver.dart'; diff --git a/test/html_generator_test.dart b/test/html_generator_test.dart index 899fb1b49d..0eb9d8ff61 100644 --- a/test/html_generator_test.dart +++ b/test/html_generator_test.dart @@ -4,12 +4,14 @@ import 'package:analyzer/file_system/file_system.dart'; import 'package:analyzer/file_system/memory_file_system.dart'; -import 'package:dartdoc/dartdoc.dart'; +import 'package:dartdoc/dartdoc.dart' show DartdocFileWriter; import 'package:dartdoc/src/generator/generator_frontend.dart'; import 'package:dartdoc/src/generator/html_generator.dart'; import 'package:dartdoc/src/generator/html_resources.g.dart'; import 'package:dartdoc/src/generator/resource_loader.dart'; import 'package:dartdoc/src/generator/templates.dart'; +import 'package:dartdoc/src/package_config_provider.dart'; +import 'package:dartdoc/src/package_meta.dart'; import 'package:dartdoc/src/warnings.dart'; import 'package:path/path.dart' as p; import 'package:test/test.dart'; diff --git a/test/mustachio/foo.runtime_renderers.dart b/test/mustachio/foo.runtime_renderers.dart index 118a2c88b0..e1b31ca1eb 100644 --- a/test/mustachio/foo.runtime_renderers.dart +++ b/test/mustachio/foo.runtime_renderers.dart @@ -5,7 +5,7 @@ // ignore_for_file: camel_case_types, deprecated_member_use_from_same_package // ignore_for_file: unused_import -import 'package:dartdoc/dartdoc.dart'; +import 'package:dartdoc/src/element_type.dart'; import 'package:dartdoc/src/generator/template_data.dart'; import 'package:dartdoc/src/model/annotation.dart'; import 'package:dartdoc/src/model/comment_referable.dart'; @@ -13,6 +13,7 @@ import 'package:dartdoc/src/model/extension_target.dart'; import 'package:dartdoc/src/model/feature.dart'; import 'package:dartdoc/src/model/feature_set.dart'; import 'package:dartdoc/src/model/language_feature.dart'; +import 'package:dartdoc/src/model/model.dart'; import 'package:dartdoc/src/mustachio/parser.dart'; import 'package:dartdoc/src/mustachio/renderer_base.dart'; import 'package:dartdoc/src/warnings.dart'; diff --git a/test/mustachio/renderers_output_test.dart b/test/mustachio/renderers_output_test.dart index 89bbc0ebea..f7d0b99313 100644 --- a/test/mustachio/renderers_output_test.dart +++ b/test/mustachio/renderers_output_test.dart @@ -8,10 +8,15 @@ import 'dart:async'; import 'package:analyzer/file_system/file_system.dart'; import 'package:analyzer/file_system/memory_file_system.dart'; -import 'package:dartdoc/dartdoc.dart'; +import 'package:dartdoc/dartdoc.dart' show Dartdoc, DartdocFileWriter; import 'package:dartdoc/options.dart'; +import 'package:dartdoc/src/dartdoc_options.dart'; +import 'package:dartdoc/src/generator/generator.dart'; import 'package:dartdoc/src/generator/html_generator.dart'; import 'package:dartdoc/src/io_utils.dart'; +import 'package:dartdoc/src/model/package_builder.dart'; +import 'package:dartdoc/src/package_config_provider.dart'; +import 'package:dartdoc/src/package_meta.dart'; import 'package:test/test.dart'; /// Convenience factory to build a [DartdocGeneratorOptionContext] and associate diff --git a/tool/mustachio/codegen_runtime_renderer.dart b/tool/mustachio/codegen_runtime_renderer.dart index 4636e2478c..59905ebc84 100644 --- a/tool/mustachio/codegen_runtime_renderer.dart +++ b/tool/mustachio/codegen_runtime_renderer.dart @@ -81,7 +81,7 @@ class RuntimeRenderersBuilder { // ignore_for_file: camel_case_types, deprecated_member_use_from_same_package // ignore_for_file: unused_import -import 'package:dartdoc/dartdoc.dart'; +import 'package:dartdoc/src/element_type.dart'; import 'package:dartdoc/src/generator/template_data.dart'; import 'package:dartdoc/src/model/annotation.dart'; import 'package:dartdoc/src/model/comment_referable.dart'; @@ -89,6 +89,7 @@ import 'package:dartdoc/src/model/extension_target.dart'; import 'package:dartdoc/src/model/feature.dart'; import 'package:dartdoc/src/model/feature_set.dart'; import 'package:dartdoc/src/model/language_feature.dart'; +import 'package:dartdoc/src/model/model.dart'; import 'package:dartdoc/src/mustachio/parser.dart'; import 'package:dartdoc/src/mustachio/renderer_base.dart'; import 'package:dartdoc/src/warnings.dart';