From f4d926d9511ac359dca5cb9562d9c55765a284a0 Mon Sep 17 00:00:00 2001 From: Parker Lougheed Date: Sat, 12 Feb 2022 08:53:51 -0600 Subject: [PATCH] Update mentions from 'dartdoc' to 'dart doc' (#3182) --- lib/src/rules/avoid_renaming_method_parameters.dart | 4 ++-- lib/src/rules/comment_references.dart | 2 +- lib/src/rules/public_member_api_docs.dart | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/src/rules/avoid_renaming_method_parameters.dart b/lib/src/rules/avoid_renaming_method_parameters.dart index 48f7f05ee..5ad817bd8 100644 --- a/lib/src/rules/avoid_renaming_method_parameters.dart +++ b/lib/src/rules/avoid_renaming_method_parameters.dart @@ -16,9 +16,9 @@ const _desc = r"Don't rename parameters of overridden methods."; const _details = r'''**DON'T** rename parameters of overridden methods. Methods that override another method, but do not have their own documentation -comment, will inherit the overridden method's comment when dartdoc produces +comment, will inherit the overridden method's comment when `dart doc` produces documentation. If the inherited method contains the name of the parameter (in -square brackets), then dartdoc cannot link it correctly. +square brackets), then `dart doc` cannot link it correctly. **BAD:** ```dart diff --git a/lib/src/rules/comment_references.dart b/lib/src/rules/comment_references.dart index 3e76b8c5b..b6e0270a3 100644 --- a/lib/src/rules/comment_references.dart +++ b/lib/src/rules/comment_references.dart @@ -14,7 +14,7 @@ const _details = r''' **DO** reference only in scope identifiers in doc comments. If you surround things like variable, method, or type names in square brackets, -then [dartdoc](https://dart.dev/guides/language/effective-dart/documentation) will look +then [`dart doc`](https://dart.dev/tools/dart-doc) will look up the name and link to its docs. For this all to work, ensure that all identifiers in docs wrapped in brackets are in scope. diff --git a/lib/src/rules/public_member_api_docs.dart b/lib/src/rules/public_member_api_docs.dart index 82cfa698c..294ee2f8f 100644 --- a/lib/src/rules/public_member_api_docs.dart +++ b/lib/src/rules/public_member_api_docs.dart @@ -55,7 +55,7 @@ class Sub extends Base { } ``` -Note that consistent with `dartdoc`, an exception to the rule is made when +Note that consistent with `dart doc`, an exception to the rule is made when documented getters have corresponding undocumented setters. In this case the setters inherit the docs from the getters.