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

Fix warnings in API documentation #1361

Merged
merged 1 commit into from
Aug 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 lib/src/configuration.dart
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ abstract class Configuration implements Finalizable {

/// The path where the `Realm` should be stored.
///
/// If omitted the [defaultPath] for the platform will be used.
/// If omitted the [defaultRealmPath] for the platform will be used.
late final String path;

/// The key used to encrypt the entire `Realm`.
Expand Down
2 changes: 1 addition & 1 deletion lib/src/credentials.dart
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ class Credentials implements Finalizable {
final RealmAppCredentialsHandle _handle;

/// Returns a [Credentials] object that can be used to authenticate an anonymous user.
/// Setting [reuseCredentials] to [false] will create a new anonymous user, upon [App.logIn].
/// Setting [reuseCredentials] to `false` will create a new anonymous user, upon [App.logIn].
/// [Anonymous Authentication Docs](https://docs.mongodb.com/realm/authentication/anonymous)
Credentials.anonymous({bool reuseCredentials = true}) : _handle = realmCore.createAppCredentialsAnonymous(reuseCredentials);

Expand Down
4 changes: 2 additions & 2 deletions lib/src/realm_class.dart
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ class Realm implements Finalizable {
///
/// Returns `Future<Realm>` that completes with the [Realm] once the remote [Realm] is fully synchronized or with a [CancelledException] if operation is canceled.
/// When the configuration is [LocalConfiguration] this completes right after the local [Realm] is opened.
/// Using [open] for opening a local Realm is equivalent to using the constructor of [Realm].
/// Using [Realm.open] for opening a local Realm is equivalent to using the constructor of [Realm].
static Future<Realm> open(Configuration config, {CancellationToken? cancellationToken, ProgressCallback? onProgressCallback}) async {
if (cancellationToken != null && cancellationToken.isCancelled) {
throw cancellationToken.exception!;
Expand Down Expand Up @@ -954,7 +954,7 @@ class MigrationRealm extends DynamicRealm {
}

/// The signature of a callback that will be executed while the Realm is opened asynchronously with [Realm.open].
/// This is the registered onProgressCallback when calling [open] that receives progress notifications while the download is in progress.
/// This is the registered onProgressCallback when calling [Realm.open] that receives progress notifications while the download is in progress.
///
/// * syncProgress - an object of [SyncProgress] that contains `transferredBytes` and `transferableBytes`.
/// {@category Realm}
Expand Down
6 changes: 3 additions & 3 deletions lib/src/set.dart
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,13 @@ abstract class RealmSet<T extends Object?> extends SetBase<T> with RealmEntity i
@override
bool contains(covariant T element); //Note: explicitly overriding contains() to change parameter type

/// If an object equal to [object] is in the set, return it.
/// If an object equal to [element] is in the set, return it.
///
/// Checks whether [object] is in the set, like [contains], and if so,
/// Checks whether [element] is in the set, like [contains], and if so,
/// returns the object in the set, otherwise returns `null`.
///
/// If the equality relation used by the set is not identity,
/// then the returned object may not be *identical* to [object].
/// then the returned object may not be *identical* to [element].
/// Some set implementations may not be able to implement this method.
/// If the [contains] method is computed,
/// rather than being based on an actual object instance,
Expand Down
2 changes: 1 addition & 1 deletion lib/src/subscription.dart
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ class MutableSubscriptionSet extends SubscriptionSet {
/// If a [name] is given, then this will be used to match with any existing query,
/// otherwise the [query] itself is used for matching.
///
/// If [update] is specified to [true], then any existing query will be replaced.
/// If [update] is specified to `true`, then any existing query will be replaced.
/// Otherwise a [RealmException] is thrown, in case of duplicates.
/// {@category Sync}
Subscription add<T extends RealmObject>(RealmResults<T> query, {String? name, bool update = false}) {
Expand Down
Loading