From 446e7a82f01c63c33ddc8dbdc805b134378ab657 Mon Sep 17 00:00:00 2001 From: Michael Goderbauer Date: Thu, 5 Dec 2019 09:23:02 -0800 Subject: [PATCH] Require docs on public API (#51) --- analysis_options.yaml | 2 +- packages/fuchsia_ctl/analysis_options.yaml | 6 ++++++ packages/gauge/analysis_options.yaml | 6 ++++++ 3 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 packages/fuchsia_ctl/analysis_options.yaml create mode 100644 packages/gauge/analysis_options.yaml diff --git a/analysis_options.yaml b/analysis_options.yaml index 9151c7c30f..d7ec8e54ad 100644 --- a/analysis_options.yaml +++ b/analysis_options.yaml @@ -143,7 +143,7 @@ linter: - prefer_typing_uninitialized_variables - prefer_void_to_null # - provide_deprecation_message # not yet tested - # - public_member_api_docs # enabled on a case-by-case basis; see e.g. packages/analysis_options.yaml + - public_member_api_docs - recursive_getters - slash_for_doc_comments # - sort_child_properties_last # not yet tested diff --git a/packages/fuchsia_ctl/analysis_options.yaml b/packages/fuchsia_ctl/analysis_options.yaml new file mode 100644 index 0000000000..d9742aba00 --- /dev/null +++ b/packages/fuchsia_ctl/analysis_options.yaml @@ -0,0 +1,6 @@ +include: ../../analysis_options.yaml + +analyzer: +linter: + rules: + public_member_api_docs: false # TODO(goderbauer): enable when package is ready. diff --git a/packages/gauge/analysis_options.yaml b/packages/gauge/analysis_options.yaml new file mode 100644 index 0000000000..d9742aba00 --- /dev/null +++ b/packages/gauge/analysis_options.yaml @@ -0,0 +1,6 @@ +include: ../../analysis_options.yaml + +analyzer: +linter: + rules: + public_member_api_docs: false # TODO(goderbauer): enable when package is ready.