Skip to content

Require docs on public API #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
goderbauer merged 3 commits into from
Dec 5, 2019
Merged

Require docs on public API #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7922965
Require docs on public API
goderbauer Dec 2, 2019
2648e22
++
goderbauer Dec 4, 2019
b40cb4d
++
goderbauer Dec 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion analysis_options.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions packages/fuchsia_ctl/analysis_options.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
include: ../../analysis_options.yaml

analyzer:
linter:
rules:
public_member_api_docs: false # TODO(goderbauer): enable when package is ready.
6 changes: 6 additions & 0 deletions packages/gauge/analysis_options.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
include: ../../analysis_options.yaml

analyzer:
linter:
rules:
public_member_api_docs: false # TODO(goderbauer): enable when package is ready.