Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(899)

Unified Diff: lib/src/rules/public_member_api_docs.dart

Issue 1781793002: Skip overriding members in API doc checks. (Closed) Base URL: https://github.com/dart-lang/linter.git@master
Patch Set: Created 4 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | test/rules/public_member_api_docs.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: lib/src/rules/public_member_api_docs.dart
diff --git a/lib/src/rules/public_member_api_docs.dart b/lib/src/rules/public_member_api_docs.dart
index fdbe88993ba9c442a8bb96a3283e4ec6ba4cc594..557a31b56e407dca74b7b7ed5529e58ae3e14695 100644
--- a/lib/src/rules/public_member_api_docs.dart
+++ b/lib/src/rules/public_member_api_docs.dart
@@ -5,6 +5,8 @@
library linter.src.rules.public_member_api_docs;
import 'package:analyzer/src/generated/ast.dart';
+import 'package:analyzer/src/generated/element.dart';
+import 'package:analyzer/src/generated/resolver.dart';
import 'package:linter/src/ast.dart';
import 'package:linter/src/linter.dart';
@@ -13,7 +15,8 @@ const desc = r'Document all public members';
const details = r'''
**DO** document all public members.
-All public members should be documented with `///` doc-style comments.
+All non-overriding public members should be documented with `///` doc-style
+comments.
**Good:**
```
@@ -29,7 +32,26 @@ abstract class Good {
**Bad:**
```
class Bad {
- void meh();
+ void meh() { }
+}
+```
+
+In case a public member overrides a member it is up to the declaring member
+to provide documentation. For example, in the following, `Sub` needn't
+document `init` (though it certainly may, if there's need).
+
+**Good:**
+```
+/// Base of all things.
+abstract class Base {
+ /// Initialize the base.
+ void init();
+}
+
+/// A sub base.
+class Sub extends Base {
+ @override
+ void init() { ... }
}
```
''';
@@ -47,15 +69,33 @@ class PublicMemberApiDocs extends LintRule {
}
class Visitor extends GeneralizingAstVisitor {
+ InheritanceManager manager;
+
final LintRule rule;
Visitor(this.rule);
void check(Declaration node) {
- if (node.documentationComment == null && !hasOverrideAnnotation(node)) {
+ if (node.documentationComment == null && !isOverridingMember(node)) {
rule.reportLint(getNodeToAnnotate(node));
}
}
+ bool isOverridingMember(Declaration node) =>
+ getOverriddenMember(node.element) != null;
+
+ ExecutableElement getOverriddenMember(Element member) {
+ if (member == null || manager == null) {
+ return null;
+ }
+
+ ClassElement classElement =
+ member.getAncestor((element) => element is ClassElement);
+ if (classElement == null) {
+ return null;
+ }
+ return manager.lookupInheritance(classElement, member.name);
+ }
+
@override
visitClassDeclaration(ClassDeclaration node) {
if (!isPrivate(node.name)) {
@@ -71,6 +111,13 @@ class Visitor extends GeneralizingAstVisitor {
}
@override
+ visitCompilationUnit(CompilationUnit node) {
+ LibraryElement library = node?.element?.library;
+ manager = library == null ? null : new InheritanceManager(library);
+ super.visitCompilationUnit(node);
+ }
+
+ @override
visitConstructorDeclaration(ConstructorDeclaration node) {
if (!inPrivateMember(node) && !isPrivate(node.name)) {
check(node);
« no previous file with comments | « no previous file | test/rules/public_member_api_docs.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698