Add docs

getsentry · Dec 16, 2021 · 88fa666 · 88fa666
1 parent 53783ce
commit 88fa666
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/include/sentry.h b/include/sentry.h
@@ -1275,15 +1275,29 @@ SENTRY_EXPERIMENTAL_API void sentry_transaction_set_sampled(
 SENTRY_EXPERIMENTAL_API void sentry_transaction_remove_sampled(
     sentry_value_t transaction);
 
+/**
+ * Sets a tag on a transaction to the given string value.
+ */
 SENTRY_EXPERIMENTAL_API void sentry_transaction_set_tag(
     sentry_value_t transaction, const char *tag, const char *value);
 
+/**
+ * Removes a tag from a transaction. Returns 0 if the tag was successfully
+ * removed, 1 otherwise.
+ */
 SENTRY_EXPERIMENTAL_API int sentry_transaction_remove_tag(
     sentry_value_t transaction, const char *tag);
 
+/**
+ * Sets the given key in a transaction's "data" section to the given value.
+ */
 SENTRY_EXPERIMENTAL_API void sentry_transaction_set_data(
     sentry_value_t transaction, const char *key, sentry_value_t value);
 
+/**
+ * Removes a key from a transaction's "data" section. Returns 0 if the key was successfully
+ * removed, 1 otherwise.
+ */
 SENTRY_EXPERIMENTAL_API int sentry_transaction_remove_data(
     sentry_value_t transaction, const char *key);