@@ -206,7 +206,7 @@ class SentryNative {
206206 late final _value_append = _value_appendPtr
207207 .asFunction< int Function (sentry_value_u, sentry_value_u)> ();
208208
209- /// Looks up a value in a map by key. If missing a null value is returned.
209+ /// Looks up a value in a map by key. If missing, a null value is returned.
210210 /// The returned value is borrowed.
211211 sentry_value_u value_get_by_key (
212212 sentry_value_u value,
@@ -225,7 +225,7 @@ class SentryNative {
225225 late final _value_get_by_key = _value_get_by_keyPtr.asFunction<
226226 sentry_value_u Function (sentry_value_u, ffi.Pointer <ffi.Char >)> ();
227227
228- /// Looks up a value in a list by index. If missing a null value is returned.
228+ /// Looks up a value in a list by index. If missing, a null value is returned.
229229 /// The returned value is borrowed.
230230 sentry_value_u value_get_by_index (
231231 sentry_value_u value,
@@ -246,7 +246,7 @@ class SentryNative {
246246
247247 /// Returns the length of the given map or list.
248248 ///
249- /// If an item is not a list or map the return value is 0.
249+ /// If an item is not a list or map, the return value is 0.
250250 int value_get_length (
251251 sentry_value_u value,
252252 ) {
@@ -612,8 +612,15 @@ class SentryNative {
612612 /// Sets the path to the crashpad handler if the crashpad backend is used.
613613 ///
614614 /// The path defaults to the `crashpad_handler` /`crashpad_handler.exe`
615- /// executable, depending on platform, which is expected to be present in the
616- /// same directory as the app executable.
615+ /// executable in the same directory as the application executable.
616+ ///
617+ /// Meaning if your application resides in
618+ ///
619+ /// "C:\path\to\your\application.exe"
620+ ///
621+ /// then the handler path will be set (by default) to
622+ ///
623+ /// "C:\path\to\your\crashpad_handler.exe"
617624 ///
618625 /// It is recommended that library users set an explicit handler path, depending
619626 /// on the directory/executable structure of their app.
@@ -656,15 +663,15 @@ class SentryNative {
656663 ///
657664 /// It is recommended that users set an explicit absolute path, depending
658665 /// on their apps runtime directory. The path will be created if it does not
659- /// exist, and will be resolved to an absolute path inside of `sentry_init` . The
666+ /// exist and will be resolved to an absolute path inside `sentry_init` . The
660667 /// directory should not be shared with other application data/configuration, as
661- /// sentry-native will enumerate and possibly delete files in that directory. An
668+ /// sentry-native will list and possibly delete files in that directory. An
662669 /// example might be `$XDG_CACHE_HOME/your-app/sentry`
663670 ///
664- /// If no explicit path it set, sentry-native will default to `.sentry-native` in
671+ /// If no explicit path is set, sentry-native will default to `.sentry-native` in
665672 /// the current working directory, with no specific platform-specific handling.
666673 ///
667- /// `path` is assumed to be in platform-specific filesystem path encoding.
674+ /// `path` is assumed to be in a platform-specific filesystem path encoding.
668675 /// API Users on windows are encouraged to use
669676 /// `sentry_options_set_database_pathw` instead.
670677 void options_set_database_path (
@@ -688,8 +695,8 @@ class SentryNative {
688695
689696 /// Initializes the Sentry SDK with the specified options.
690697 ///
691- /// This takes ownership of the options. After the options have been set
692- /// they cannot be modified any more .
698+ /// This takes ownership of the options. After the options have been set,
699+ /// they cannot be modified anymore .
693700 /// Depending on the configured transport and backend, this function might not be
694701 /// fully thread-safe.
695702 /// Returns 0 on success.
@@ -709,14 +716,14 @@ class SentryNative {
709716
710717 /// Shuts down the sentry client and forces transports to flush out.
711718 ///
712- /// Returns 0 on success .
719+ /// Returns the number of envelopes that have been dumped .
713720 ///
714721 /// Note that this does not uninstall any crash handler installed by our
715722 /// backends, which will still process crashes after `sentry_close()` , except
716723 /// when using `crashpad` on Linux or the `inproc` backend.
717724 ///
718725 /// Further note that this function will block the thread it was called from
719- /// until the sentry background worker has finished its work or it timed out,
726+ /// until the sentry background worker has finished its work, or it timed out,
720727 /// whichever comes first.
721728 int close () {
722729 return _close ();
@@ -901,7 +908,7 @@ class SentryNative {
901908 _sdk_namePtr.asFunction< ffi.Pointer <ffi.Char > Function ()> ();
902909}
903910
904- /// Type of a sentry value.
911+ /// Type of sentry value.
905912enum sentry_value_type_t {
906913 SENTRY_VALUE_TYPE_NULL (0 ),
907914 SENTRY_VALUE_TYPE_BOOL (1 ),
@@ -937,12 +944,12 @@ enum sentry_value_type_t {
937944/// so that alignment for the type can be properly determined.
938945///
939946/// Values must be released with `sentry_value_decref` . This lowers the
940- /// internal refcount by one. If the refcount hits zero it's freed. Some
941- /// values like primitives have no refcount (like null) so operations on
947+ /// internal refcount by one. If the refcount hits zero, it's freed. Some
948+ /// values like primitives have no refcount (like null), so operations on
942949/// those are no-ops.
943950///
944- /// In addition values can be frozen. Some values like primitives are always
945- /// frozen but lists and dicts are not and can be frozen on demand. This
951+ /// In addition, values can be frozen. Some values like primitives are always
952+ /// frozen, but lists and dicts are not and can be frozen on demand. This
946953/// automatically happens for some shared values in the event payload like
947954/// the module list.
948955final class sentry_value_u extends ffi.Union {
0 commit comments