Skip to content

Commit d743f16

Browse files
creativecreatorormaybenotkroikie
creativecreatorormaybenot
authored and
kroikie
committed
Format documentation lists (See also & Errors) correctly (#298)
Fix documentation list format.
1 parent 61bccb3 commit d743f16

File tree

13 files changed

+107
-66
lines changed

13 files changed

+107
-66
lines changed

‎packages/cloud_firestore/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## 0.12.10+1
2+
3+
* Formatted method documentations.
4+
15
## 0.12.10
26

37
* Added `FieldPath` class and `FieldPath.documentId` to refer to the document id in queries.

‎packages/cloud_firestore/lib/src/query.dart

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,7 @@ class Query {
213213
/// [endBefore], [endAtDocument] and [endBeforeDocument].
214214
///
215215
/// See also:
216+
///
216217
/// * [endAfterDocument] for a query that ends after a document.
217218
/// * [startAtDocument] for a query that starts at a document.
218219
/// * [endAtDocument] for a query that ends at a document.
@@ -247,6 +248,7 @@ class Query {
247248
/// [endBefore], [endAtDocument] and [endBeforeDocument].
248249
///
249250
/// See also:
251+
///
250252
/// * [startAfterDocument] for a query that starts after a document.
251253
/// * [endAtDocument] for a query that ends at a document.
252254
/// * [endBeforeDocument] for a query that ends before a document.
@@ -315,6 +317,7 @@ class Query {
315317
/// [startAfter], [startAtDocument] and [startAfterDocument].
316318
///
317319
/// See also:
320+
///
318321
/// * [startAfterDocument] for a query that starts after a document.
319322
/// * [startAtDocument] for a query that starts at a document.
320323
/// * [endBeforeDocument] for a query that ends before a document.
@@ -366,6 +369,7 @@ class Query {
366369
/// [startAfter], [startAtDocument] and [startAfterDocument].
367370
///
368371
/// See also:
372+
///
369373
/// * [startAfterDocument] for a query that starts after document.
370374
/// * [startAtDocument] for a query that starts at a document.
371375
/// * [endAtDocument] for a query that ends at a document.

‎packages/cloud_firestore/pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ description: Flutter plugin for Cloud Firestore, a cloud-hosted, noSQL database
33
live synchronization and offline support on Android and iOS.
44
author: Flutter Team <[email protected]>
55
homepage: https://github.com/FirebaseExtended/flutterfire/tree/master/packages/cloud_firestore
6-
version: 0.12.10
6+
version: 0.12.10+1
77

88
flutter:
99
plugin:

‎packages/firebase_analytics/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## 5.0.7
2+
3+
* Formatted `setCurrentScreen` documentation.
4+
15
## 5.0.6
26

37
* Updated README instructions for contributing for consistency with other Flutterfire plugins.

‎packages/firebase_analytics/lib/firebase_analytics.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ class FirebaseAnalytics {
8686
///
8787
/// See also:
8888
///
89-
/// https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.html#setCurrentScreen(android.app.Activity, java.lang.String, java.lang.String)
90-
/// https://firebase.google.com/docs/reference/ios/firebaseanalytics/api/reference/Classes/FIRAnalytics#setscreennamescreenclass
89+
/// * https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.html#setCurrentScreen(android.app.Activity, java.lang.String, java.lang.String)
90+
/// * https://firebase.google.com/docs/reference/ios/firebaseanalytics/api/reference/Classes/FIRAnalytics#setscreennamescreenclass
9191
Future<void> setCurrentScreen(
9292
{@required String screenName,
9393
String screenClassOverride = 'Flutter'}) async {

‎packages/firebase_analytics/pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ description: Flutter plugin for Google Analytics for Firebase, an app measuremen
33
solution that provides insight on app usage and user engagement on Android and iOS.
44
author: Flutter Team <[email protected]>
55
homepage: https://github.com/FirebaseExtended/flutterfire/tree/master/packages/firebase_analytics
6-
version: 5.0.6
6+
version: 5.0.7
77

88
flutter:
99
plugin:

‎packages/firebase_auth/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## 0.14.0+10
2+
3+
* Formatted lists in member documentations for better readability.
4+
15
## 0.14.0+9
26

37
* Fix the behavior of `getIdToken` to use the `refresh` parameter instead of always refreshing.

‎packages/firebase_auth/lib/src/firebase_auth.dart

Lines changed: 35 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,8 @@ class FirebaseAuth {
7070
/// of the Firebase console before being able to use them.
7171
///
7272
/// Errors:
73-
/// • `ERROR_OPERATION_NOT_ALLOWED` - Indicates that Anonymous accounts are not enabled.
73+
///
74+
/// * `ERROR_OPERATION_NOT_ALLOWED` - Indicates that Anonymous accounts are not enabled.
7475
Future<AuthResult> signInAnonymously() async {
7576
final Map<String, dynamic> data = await channel
7677
.invokeMapMethod<String, dynamic>(
@@ -85,9 +86,10 @@ class FirebaseAuth {
8586
/// the [onAuthStateChanged] stream.
8687
///
8788
/// Errors:
88-
/// • `ERROR_WEAK_PASSWORD` - If the password is not strong enough.
89-
/// • `ERROR_INVALID_EMAIL` - If the email address is malformed.
90-
/// • `ERROR_EMAIL_ALREADY_IN_USE` - If the email is already in use by a different account.
89+
///
90+
/// * `ERROR_WEAK_PASSWORD` - If the password is not strong enough.
91+
/// * `ERROR_INVALID_EMAIL` - If the email address is malformed.
92+
/// * `ERROR_EMAIL_ALREADY_IN_USE` - If the email is already in use by a different account.
9193
Future<AuthResult> createUserWithEmailAndPassword({
9294
@required String email,
9395
@required String password,
@@ -112,7 +114,8 @@ class FirebaseAuth {
112114
/// An empty `List` is returned if the user could not be found.
113115
///
114116
/// Errors:
115-
/// • `ERROR_INVALID_CREDENTIAL` - If the [email] address is malformed.
117+
///
118+
/// * `ERROR_INVALID_CREDENTIAL` - If the [email] address is malformed.
116119
Future<List<String>> fetchSignInMethodsForEmail({
117120
@required String email,
118121
}) async {
@@ -128,8 +131,9 @@ class FirebaseAuth {
128131
/// user of your app.
129132
///
130133
/// Errors:
131-
/// • `ERROR_INVALID_EMAIL` - If the [email] address is malformed.
132-
/// • `ERROR_USER_NOT_FOUND` - If there is no user corresponding to the given [email] address.
134+
///
135+
/// * `ERROR_INVALID_EMAIL` - If the [email] address is malformed.
136+
/// * `ERROR_USER_NOT_FOUND` - If there is no user corresponding to the given [email] address.
133137
Future<void> sendPasswordResetEmail({
134138
@required String email,
135139
}) async {
@@ -183,11 +187,12 @@ class FirebaseAuth {
183187
/// Signs in using an email address and email sign-in link.
184188
///
185189
/// Errors:
186-
/// • `ERROR_NOT_ALLOWED` - Indicates that email and email sign-in link
190+
///
191+
/// * `ERROR_NOT_ALLOWED` - Indicates that email and email sign-in link
187192
/// accounts are not enabled. Enable them in the Auth section of the
188193
/// Firebase console.
189-
/// • `ERROR_DISABLED` - Indicates the user's account is disabled.
190-
/// • `ERROR_INVALID` - Indicates the email address is invalid.
194+
/// * `ERROR_DISABLED` - Indicates the user's account is disabled.
195+
/// * `ERROR_INVALID` - Indicates the email address is invalid.
191196
Future<AuthResult> signInWithEmailAndLink({String email, String link}) async {
192197
final Map<String, dynamic> data =
193198
await channel.invokeMapMethod<String, dynamic>(
@@ -211,12 +216,13 @@ class FirebaseAuth {
211216
/// section of the Firebase console before being able to use them.
212217
///
213218
/// Errors:
214-
/// • `ERROR_INVALID_EMAIL` - If the [email] address is malformed.
215-
/// • `ERROR_WRONG_PASSWORD` - If the [password] is wrong.
216-
/// • `ERROR_USER_NOT_FOUND` - If there is no user corresponding to the given [email] address, or if the user has been deleted.
217-
/// • `ERROR_USER_DISABLED` - If the user has been disabled (for example, in the Firebase console)
218-
/// • `ERROR_TOO_MANY_REQUESTS` - If there was too many attempts to sign in as this user.
219-
/// • `ERROR_OPERATION_NOT_ALLOWED` - Indicates that Email & Password accounts are not enabled.
219+
///
220+
/// * `ERROR_INVALID_EMAIL` - If the [email] address is malformed.
221+
/// * `ERROR_WRONG_PASSWORD` - If the [password] is wrong.
222+
/// * `ERROR_USER_NOT_FOUND` - If there is no user corresponding to the given [email] address, or if the user has been deleted.
223+
/// * `ERROR_USER_DISABLED` - If the user has been disabled (for example, in the Firebase console)
224+
/// * `ERROR_TOO_MANY_REQUESTS` - If there was too many attempts to sign in as this user.
225+
/// * `ERROR_OPERATION_NOT_ALLOWED` - Indicates that Email & Password accounts are not enabled.
220226
Future<AuthResult> signInWithEmailAndPassword({
221227
@required String email,
222228
@required String password,
@@ -243,13 +249,14 @@ class FirebaseAuth {
243249
/// of the Firebase console before being able to use them.
244250
///
245251
/// Errors:
246-
/// • `ERROR_INVALID_CREDENTIAL` - If the credential data is malformed or has expired.
247-
/// • `ERROR_USER_DISABLED` - If the user has been disabled (for example, in the Firebase console)
248-
/// • `ERROR_ACCOUNT_EXISTS_WITH_DIFFERENT_CREDENTIAL` - If there already exists an account with the email address asserted by Google.
252+
///
253+
/// * `ERROR_INVALID_CREDENTIAL` - If the credential data is malformed or has expired.
254+
/// * `ERROR_USER_DISABLED` - If the user has been disabled (for example, in the Firebase console)
255+
/// * `ERROR_ACCOUNT_EXISTS_WITH_DIFFERENT_CREDENTIAL` - If there already exists an account with the email address asserted by Google.
249256
/// Resolve this case by calling [fetchSignInMethodsForEmail] and then asking the user to sign in using one of them.
250257
/// This error will only be thrown if the "One account per email address" setting is enabled in the Firebase console (recommended).
251-
/// • `ERROR_OPERATION_NOT_ALLOWED` - Indicates that Google accounts are not enabled.
252-
/// • `ERROR_INVALID_ACTION_CODE` - If the action code in the link is malformed, expired, or has already been used.
258+
/// * `ERROR_OPERATION_NOT_ALLOWED` - Indicates that Google accounts are not enabled.
259+
/// * `ERROR_INVALID_ACTION_CODE` - If the action code in the link is malformed, expired, or has already been used.
253260
/// This can only occur when using [EmailAuthProvider.getCredentialWithLink] to obtain the credential.
254261
Future<AuthResult> signInWithCredential(AuthCredential credential) async {
255262
assert(credential != null);
@@ -274,10 +281,11 @@ class FirebaseAuth {
274281
/// No duplicated SMS will be sent out upon re-entry (before timeout).
275282
///
276283
/// Make sure to test all scenarios below:
277-
/// • You directly get logged in if Google Play Services verified the phone
284+
///
285+
/// * You directly get logged in if Google Play Services verified the phone
278286
/// number instantly or helped you auto-retrieve the verification code.
279-
/// • Auto-retrieve verification code timed out.
280-
/// • Error cases when you receive [verificationFailed] callback.
287+
/// * Auto-retrieve verification code timed out.
288+
/// * Error cases when you receive [verificationFailed] callback.
281289
///
282290
/// [phoneNumber] The phone number for the account the user is signing up
283291
/// for or signing into. Make sure to pass in a phone number with country
@@ -352,9 +360,10 @@ class FirebaseAuth {
352360
/// useful in [the guides](https://firebase.google.com/docs/auth/android/custom-auth).
353361
///
354362
/// Errors:
355-
/// • `ERROR_INVALID_CUSTOM_TOKEN` - The custom token format is incorrect.
363+
///
364+
/// * `ERROR_INVALID_CUSTOM_TOKEN` - The custom token format is incorrect.
356365
/// Please check the documentation.
357-
/// • `ERROR_CUSTOM_TOKEN_MISMATCH` - Invalid configuration.
366+
/// * `ERROR_CUSTOM_TOKEN_MISMATCH` - Invalid configuration.
358367
/// Ensure your app's SHA1 is correct in the Firebase console.
359368
Future<AuthResult> signInWithCustomToken({@required String token}) async {
360369
assert(token != null);

‎packages/firebase_auth/lib/src/firebase_user.dart

Lines changed: 39 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,16 @@ class FirebaseUser extends UserInfo {
5050
/// the given account.
5151
///
5252
/// Errors:
53-
/// • `ERROR_WEAK_PASSWORD` - If the password is not strong enough.
54-
/// • `ERROR_INVALID_CREDENTIAL` - If the credential is malformed or has expired.
55-
/// • `ERROR_EMAIL_ALREADY_IN_USE` - If the email is already in use by a different account.
56-
/// • `ERROR_CREDENTIAL_ALREADY_IN_USE` - If the account is already in use by a different account, e.g. with phone auth.
57-
/// • `ERROR_USER_DISABLED` - If the user has been disabled (for example, in the Firebase console)
58-
/// • `ERROR_REQUIRES_RECENT_LOGIN` - If the user's last sign-in time does not meet the security threshold. Use reauthenticate methods to resolve.
59-
/// • `ERROR_PROVIDER_ALREADY_LINKED` - If the current user already has an account of this type linked.
60-
/// • `ERROR_OPERATION_NOT_ALLOWED` - Indicates that this type of account is not enabled.
61-
/// • `ERROR_INVALID_ACTION_CODE` - If the action code in the link is malformed, expired, or has already been used.
53+
///
54+
/// * `ERROR_WEAK_PASSWORD` - If the password is not strong enough.
55+
/// * `ERROR_INVALID_CREDENTIAL` - If the credential is malformed or has expired.
56+
/// * `ERROR_EMAIL_ALREADY_IN_USE` - If the email is already in use by a different account.
57+
/// * `ERROR_CREDENTIAL_ALREADY_IN_USE` - If the account is already in use by a different account, e.g. with phone auth.
58+
/// * `ERROR_USER_DISABLED` - If the user has been disabled (for example, in the Firebase console)
59+
/// * `ERROR_REQUIRES_RECENT_LOGIN` - If the user's last sign-in time does not meet the security threshold. Use reauthenticate methods to resolve.
60+
/// * `ERROR_PROVIDER_ALREADY_LINKED` - If the current user already has an account of this type linked.
61+
/// * `ERROR_OPERATION_NOT_ALLOWED` - Indicates that this type of account is not enabled.
62+
/// * `ERROR_INVALID_ACTION_CODE` - If the action code in the link is malformed, expired, or has already been used.
6263
/// This can only occur when using [EmailAuthProvider.getCredentialWithLink] to obtain the credential.
6364
Future<AuthResult> linkWithCredential(AuthCredential credential) async {
6465
assert(credential != null);
@@ -91,10 +92,11 @@ class FirebaseUser extends UserInfo {
9192
/// Deletes the current user (also signs out the user).
9293
///
9394
/// Errors:
94-
/// • `ERROR_REQUIRES_RECENT_LOGIN` - If the user's last sign-in time does not meet the security threshold. Use reauthenticate methods to resolve.
95-
/// • `ERROR_INVALID_CREDENTIAL` - If the credential is malformed or has expired.
96-
/// • `ERROR_USER_DISABLED` - If the user has been disabled (for example, in the Firebase console)
97-
/// • `ERROR_USER_NOT_FOUND` - If the user has been deleted (for example, in the Firebase console)
95+
///
96+
/// * `ERROR_REQUIRES_RECENT_LOGIN` - If the user's last sign-in time does not meet the security threshold. Use reauthenticate methods to resolve.
97+
/// * `ERROR_INVALID_CREDENTIAL` - If the credential is malformed or has expired.
98+
/// * `ERROR_USER_DISABLED` - If the user has been disabled (for example, in the Firebase console)
99+
/// * `ERROR_USER_NOT_FOUND` - If the user has been deleted (for example, in the Firebase console)
98100
Future<void> delete() async {
99101
await FirebaseAuth.channel
100102
.invokeMethod<void>('delete', <String, String>{'app': _app.name});
@@ -110,12 +112,13 @@ class FirebaseUser extends UserInfo {
110112
/// the user to have recently signed in.
111113
///
112114
/// Errors:
113-
/// • `ERROR_INVALID_CREDENTIAL` - If the email address is malformed.
114-
/// • `ERROR_EMAIL_ALREADY_IN_USE` - If the email is already in use by a different account.
115-
/// • `ERROR_USER_DISABLED` - If the user has been disabled (for example, in the Firebase console)
116-
/// • `ERROR_USER_NOT_FOUND` - If the user has been deleted (for example, in the Firebase console)
117-
/// • `ERROR_REQUIRES_RECENT_LOGIN` - If the user's last sign-in time does not meet the security threshold. Use reauthenticate methods to resolve.
118-
/// • `ERROR_OPERATION_NOT_ALLOWED` - Indicates that Email & Password accounts are not enabled.
115+
///
116+
/// * `ERROR_INVALID_CREDENTIAL` - If the email address is malformed.
117+
/// * `ERROR_EMAIL_ALREADY_IN_USE` - If the email is already in use by a different account.
118+
/// * `ERROR_USER_DISABLED` - If the user has been disabled (for example, in the Firebase console)
119+
/// * `ERROR_USER_NOT_FOUND` - If the user has been deleted (for example, in the Firebase console)
120+
/// * `ERROR_REQUIRES_RECENT_LOGIN` - If the user's last sign-in time does not meet the security threshold. Use reauthenticate methods to resolve.
121+
/// * `ERROR_OPERATION_NOT_ALLOWED` - Indicates that Email & Password accounts are not enabled.
119122
Future<void> updateEmail(String email) async {
120123
assert(email != null);
121124
return await FirebaseAuth.channel.invokeMethod<void>(
@@ -154,11 +157,12 @@ class FirebaseUser extends UserInfo {
154157
/// the user to have recently signed in.
155158
///
156159
/// Errors:
157-
/// • `ERROR_WEAK_PASSWORD` - If the password is not strong enough.
158-
/// • `ERROR_USER_DISABLED` - If the user has been disabled (for example, in the Firebase console)
159-
/// • `ERROR_USER_NOT_FOUND` - If the user has been deleted (for example, in the Firebase console)
160-
/// • `ERROR_REQUIRES_RECENT_LOGIN` - If the user's last sign-in time does not meet the security threshold. Use reauthenticate methods to resolve.
161-
/// • `ERROR_OPERATION_NOT_ALLOWED` - Indicates that Email & Password accounts are not enabled.
160+
///
161+
/// * `ERROR_WEAK_PASSWORD` - If the password is not strong enough.
162+
/// * `ERROR_USER_DISABLED` - If the user has been disabled (for example, in the Firebase console)
163+
/// * `ERROR_USER_NOT_FOUND` - If the user has been deleted (for example, in the Firebase console)
164+
/// * `ERROR_REQUIRES_RECENT_LOGIN` - If the user's last sign-in time does not meet the security threshold. Use reauthenticate methods to resolve.
165+
/// * `ERROR_OPERATION_NOT_ALLOWED` - Indicates that Email & Password accounts are not enabled.
162166
Future<void> updatePassword(String password) async {
163167
assert(password != null);
164168
return await FirebaseAuth.channel.invokeMethod<void>(
@@ -170,8 +174,9 @@ class FirebaseUser extends UserInfo {
170174
/// Updates the user profile information.
171175
///
172176
/// Errors:
173-
/// • `ERROR_USER_DISABLED` - If the user has been disabled (for example, in the Firebase console)
174-
/// • `ERROR_USER_NOT_FOUND` - If the user has been deleted (for example, in the Firebase console)
177+
///
178+
/// * `ERROR_USER_DISABLED` - If the user has been disabled (for example, in the Firebase console)
179+
/// * `ERROR_USER_NOT_FOUND` - If the user has been deleted (for example, in the Firebase console)
175180
Future<void> updateProfile(UserUpdateInfo userUpdateInfo) async {
176181
assert(userUpdateInfo != null);
177182
final Map<String, String> data = userUpdateInfo._updateData;
@@ -194,10 +199,11 @@ class FirebaseUser extends UserInfo {
194199
/// error is returned and the current user remains signed in.
195200
///
196201
/// Errors:
197-
/// • `ERROR_INVALID_CREDENTIAL` - If the [authToken] or [authTokenSecret] is malformed or has expired.
198-
/// • `ERROR_USER_DISABLED` - If the user has been disabled (for example, in the Firebase console)
199-
/// • `ERROR_USER_NOT_FOUND` - If the user has been deleted (for example, in the Firebase console)
200-
/// • `ERROR_OPERATION_NOT_ALLOWED` - Indicates that Email & Password accounts are not enabled.
202+
///
203+
/// * `ERROR_INVALID_CREDENTIAL` - If the [authToken] or [authTokenSecret] is malformed or has expired.
204+
/// * `ERROR_USER_DISABLED` - If the user has been disabled (for example, in the Firebase console)
205+
/// * `ERROR_USER_NOT_FOUND` - If the user has been deleted (for example, in the Firebase console)
206+
/// * `ERROR_OPERATION_NOT_ALLOWED` - Indicates that Email & Password accounts are not enabled.
201207
Future<AuthResult> reauthenticateWithCredential(
202208
AuthCredential credential) async {
203209
assert(credential != null);
@@ -224,8 +230,9 @@ class FirebaseUser extends UserInfo {
224230
/// Use the `providerId` method of an auth provider for [provider].
225231
///
226232
/// Errors:
227-
/// • `ERROR_NO_SUCH_PROVIDER` - If the user does not have a Github Account linked to their account.
228-
/// • `ERROR_REQUIRES_RECENT_LOGIN` - If the user's last sign-in time does not meet the security threshold. Use reauthenticate methods to resolve.
233+
///
234+
/// * `ERROR_NO_SUCH_PROVIDER` - If the user does not have a Github Account linked to their account.
235+
/// * `ERROR_REQUIRES_RECENT_LOGIN` - If the user's last sign-in time does not meet the security threshold. Use reauthenticate methods to resolve.
229236
Future<void> unlinkFromProvider(String provider) async {
230237
assert(provider != null);
231238
return await FirebaseAuth.channel.invokeMethod<void>(

‎packages/firebase_auth/pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Flutter plugin for Firebase Auth, enabling Android and iOS
44
like Google, Facebook and Twitter.
55
author: Flutter Team <[email protected]>
66
homepage: https://github.com/FirebaseExtended/flutterfire/tree/master/packages/firebase_auth
7-
version: 0.14.0+9
7+
version: 0.14.0+10
88

99
flutter:
1010
plugin:

0 commit comments

Comments
 (0)