Skip to content

Commit d081c1f

Browse files
Store: note how to view debug messages on iOS GH#747
1 parent beed14f commit d081c1f

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

objectbox/lib/src/native/store.dart

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,14 +209,24 @@ class Store implements Finalizable {
209209
/// ends. Thus, be mindful with the number of active threads.
210210
///
211211
/// ## Debug flags
212+
///
212213
/// Pass one or more [DebugFlags] to [debugFlags] to enable debug log
213214
/// output:
215+
///
214216
/// ```dart
215217
/// final store = Store(getObjectBoxModel(),
216218
/// debugFlag: DebugFlags.logQueries | DebugFlags.logQueryParameters);
217219
/// ```
218220
///
219-
/// See our examples for more details.
221+
/// Note: to see these log messages when debugging an iOS app, you need to
222+
/// open `ios/Runner.xcworkspace` in Xcode and run the app from there.
223+
/// See also the Flutter instructions to
224+
/// ["Debug Dart and iOS code using Xcode"](https://docs.flutter.dev/testing/native-debugging#debug-dart-and-ios-code-using-xcode).
225+
///
226+
/// ## More details
227+
///
228+
/// See our [documentation](https://docs.objectbox.io/) and examples for more
229+
/// details.
220230
Store(ModelDefinition modelDefinition,
221231
{String? directory,
222232
int? maxDBSizeInKB,

0 commit comments

Comments
 (0)