commit 0a9fb1723e393a1442c555b5c18249b652a06e33
author Devon Carew <devoncarew@google.com> Wed Jan 12 23:46:42 2022 +0000
committer Commit Bot <commit-bot@chromium.org> Wed Jan 12 23:46:42 2022 +0000
tree 51692636a05fa7455339c14ad0c533862cd74dfb
parent 0a3d896274c30e7f9c89d2cbe63b8403b65c63ce

[dartdev] update help text for 'dart doc'

Change-Id: Iac786b3dd471c4650e42aefacdddb177370f38f5
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/227921
Reviewed-by: Ben Konyi <bkonyi@google.com>
Commit-Queue: Devon Carew <devoncarew@google.com>

pkg/dartdev/lib/src/commands/doc.dart

diff --git a/pkg/dartdev/lib/src/commands/doc.dart b/pkg/dartdev/lib/src/commands/doc.dart
index d039183..8faff48 100644
--- a/pkg/dartdev/lib/src/commands/doc.dart
+++ b/pkg/dartdev/lib/src/commands/doc.dart
@@ -12,20 +12,20 @@
 import '../core.dart';
 import '../sdk.dart';
 
-/// A command to create a new project from a set of templates.
+/// A command to generate documentation for a project.
 class DocCommand extends DartdevCommand {
   static const String cmdName = 'doc';
 
-  DocCommand({bool verbose = false})
-      : super(
-          cmdName,
-          'Generate HTML API documentation from Dart documentation comments.',
-          verbose,
-        ) {
+  static const String cmdDescription = '''
+Generate API documentation for Dart projects.
+
+For additional documentation generation options, see the 'dartdoc_options.yaml' file documentation at https://dart.dev/go/dartdoc-options-file.''';
+
+  DocCommand({bool verbose = false}) : super(cmdName, cmdDescription, verbose) {
     argParser.addOption(
       'output-dir',
       abbr: 'o',
-      defaultsTo: path.join('.', 'doc', 'api'),
+      defaultsTo: path.join('doc', 'api'),
       help: 'Output directory',
     );
     argParser.addFlag(
@@ -75,8 +75,9 @@
 
     // Call dartdoc.
     if (verbose) {
-      log.stdout('Calling dartdoc with the following options: $options');
+      log.stdout('Using the following options: $options');
     }
+
     final packageConfigProvider = PhysicalPackageConfigProvider();
     final packageBuilder = PubPackageBuilder(
         config, pubPackageMetaProvider, packageConfigProvider);