Skip to content
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.

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

Document public members of classes #380

Closed
ikurek opened this issue Apr 26, 2022 · 0 comments · Fixed by #381
Closed

Document public members of classes #380

ikurek opened this issue Apr 26, 2022 · 0 comments · Fixed by #381
Assignees
Labels
documentation Improvements or additions to public interface documentation (API reference or readme).

Comments

@ikurek
Copy link
Contributor

ikurek commented Apr 26, 2022

This is a part of #278. Many issues reported by dart analyzers are related to public members in library code not being documented:

   info • Document all public members • lib/src/authentication/src/token_params.dart:66:24 • public_member_api_docs
   info • Document all public members • lib/src/crypto/src/crypto.dart:10:16 • public_member_api_docs
   info • Document all public members • lib/src/crypto/src/crypto.dart:11:16 • public_member_api_docs
   info • Document all public members • lib/src/crypto/src/crypto.dart:12:16 • public_member_api_docs
   info • Document all public members • lib/src/crypto/src/crypto.dart:13:16 • public_member_api_docs
   info • Document all public members • lib/src/crypto/src/crypto.dart:14:16 • public_member_api_docs
   info • Document all public members • lib/src/crypto/src/crypto.dart:15:16 • public_member_api_docs
   info • Document all public members • lib/src/crypto/src/crypto.dart:16:16 • public_member_api_docs
   info • Document all public members • lib/src/crypto/src/crypto.dart:46:15 • public_member_api_docs
   info • Document all public members • lib/src/logging/src/log_level.dart:8:17 • public_member_api_docs
   info • Document all public members • lib/src/logging/src/log_level.dart:8:23 • public_member_api_docs
   info • Document all public members • lib/src/logging/src/log_level.dart:8:32 • public_member_api_docs
   info • Document all public members • lib/src/logging/src/log_level.dart:8:39 • public_member_api_docs
   info • Document all public members • lib/src/logging/src/log_level.dart:8:45 • public_member_api_docs
   info • Document all public members • lib/src/logging/src/log_level.dart:8:51 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/background_android_isolate_platform.dart:47:14 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/cipher_params_internal.dart:18:8 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/cipher_params_internal.dart:19:14 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/cipher_params_internal.dart:21:11 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/cipher_params_internal.dart:23:11 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/cipher_params_internal.dart:44:24 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/cipher_params_internal.dart:59:31 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/method_call_handler.dart:97:19 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/method_call_handler.dart:103:19 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/platform.dart:7:7 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/platform.dart:36:14 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/platform.dart:66:13 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/push_activation_events_internal.dart:5:7 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/push_activation_events_internal.dart:6:32 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/push_activation_events_internal.dart:7:32 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/push_activation_events_internal.dart:9:31 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/push_notification_events_internal.dart:8:7 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/push_notification_events_internal.dart:9:17 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/push_notification_events_internal.dart:11:7 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/push_notification_events_internal.dart:12:35 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/push_notification_events_internal.dart:80:8 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/realtime/connection.dart:66:33 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/realtime/realtime_channel.dart:101:16 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/realtime/realtime_channel.dart:127:30 • public_member_api_docs
   info • Document all public members • lib/src/platform/src/rest/rest_channel.dart:32:20 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:15:3 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:16:3 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:17:3 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:18:3 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:19:3 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:26:3 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:27:3 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:28:3 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:35:3 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:36:3 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:37:3 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:44:3 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:45:3 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:46:3 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:54:25 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:55:16 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:56:25 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:57:25 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:58:25 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:59:25 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:60:25 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:61:25 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:62:25 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:63:8 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:64:25 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/ios_notification_settings.dart:65:25 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/notification.dart:24:24 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/push_notification_events.dart:5:1 • public_member_api_docs
   info • Document all public members • lib/src/push_notifications/src/remote_message.dart:25:25 • public_member_api_docs

This affects not only the generated DartDoc files, but also package score on pub.dev. We should update documentation or suppress the warnings accordingly

┆Issue is synchronized with this Jira Uncategorised by Unito

@ikurek ikurek added the documentation Improvements or additions to public interface documentation (API reference or readme). label Apr 26, 2022
@ikurek ikurek self-assigned this Apr 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to public interface documentation (API reference or readme).
Development

Successfully merging a pull request may close this issue.

1 participant