@@ -106,7 +106,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetClipboardText(const char *text);
106
106
/**
107
107
* Get UTF-8 text from the clipboard.
108
108
*
109
- * This functions returns an empty string if there was not enough memory left
109
+ * This function returns an empty string if there is not enough memory left
110
110
* for a copy of the clipboard's content.
111
111
*
112
112
* \returns the clipboard text on success or an empty string on failure; call
@@ -155,7 +155,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetPrimarySelectionText(const char *text);
155
155
/**
156
156
* Get UTF-8 text from the primary selection.
157
157
*
158
- * This functions returns an empty string if there was not enough memory left
158
+ * This function returns an empty string if there is not enough memory left
159
159
* for a copy of the primary selection's content.
160
160
*
161
161
* \returns the primary selection text on success or an empty string on
@@ -194,15 +194,15 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasPrimarySelectionText(void);
194
194
* clipboard is cleared or new data is set. The clipboard is automatically
195
195
* cleared in SDL_Quit().
196
196
*
197
- * \param userdata a pointer to provided user data.
197
+ * \param userdata a pointer to the provided user data.
198
198
* \param mime_type the requested mime-type.
199
199
* \param size a pointer filled in with the length of the returned data.
200
200
* \returns a pointer to the data for the provided mime-type. Returning NULL
201
- * or setting length to 0 will cause no data to be sent to the
201
+ * or setting the length to 0 will cause no data to be sent to the
202
202
* "receiver". It is up to the receiver to handle this. Essentially
203
203
* returning no data is more or less undefined behavior and may cause
204
204
* breakage in receiving applications. The returned data will not be
205
- * freed so it needs to be retained and dealt with internally.
205
+ * freed, so it needs to be retained and dealt with internally.
206
206
*
207
207
* \since This function is available since SDL 3.2.0.
208
208
*
@@ -211,10 +211,10 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasPrimarySelectionText(void);
211
211
typedef const void * (SDLCALL * SDL_ClipboardDataCallback )(void * userdata , const char * mime_type , size_t * size );
212
212
213
213
/**
214
- * Callback function that will be called when the clipboard is cleared, or new
214
+ * Callback function that will be called when the clipboard is cleared, or when new
215
215
* data is set.
216
216
*
217
- * \param userdata a pointer to provided user data.
217
+ * \param userdata a pointer to the provided user data.
218
218
*
219
219
* \since This function is available since SDL 3.2.0.
220
220
*
@@ -231,15 +231,15 @@ typedef void (SDLCALL *SDL_ClipboardCleanupCallback)(void *userdata);
231
231
* respond with the data for the requested mime-type.
232
232
*
233
233
* The size of text data does not include any terminator, and the text does
234
- * not need to be null terminated (e.g. you can directly copy a portion of a
234
+ * not need to be null- terminated (e.g., you can directly copy a portion of a
235
235
* document).
236
236
*
237
237
* \param callback a function pointer to the function that provides the
238
238
* clipboard data.
239
239
* \param cleanup a function pointer to the function that cleans up the
240
240
* clipboard data.
241
241
* \param userdata an opaque pointer that will be forwarded to the callbacks.
242
- * \param mime_types a list of mime-types that are being offered.
242
+ * \param mime_types a list of mime-types that are being offered. SDL copies the given list.
243
243
* \param num_mime_types the number of mime-types in the mime_types list.
244
244
* \returns true on success or false on failure; call SDL_GetError() for more
245
245
* information.
@@ -269,10 +269,10 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetClipboardData(SDL_ClipboardDataCallback
269
269
extern SDL_DECLSPEC bool SDLCALL SDL_ClearClipboardData (void );
270
270
271
271
/**
272
- * Get the data from clipboard for a given mime type.
272
+ * Get the data from the clipboard for a given mime type.
273
273
*
274
274
* The size of text data does not include the terminator, but the text is
275
- * guaranteed to be null terminated.
275
+ * guaranteed to be null- terminated.
276
276
*
277
277
* \param mime_type the mime type to read from the clipboard.
278
278
* \param size a pointer filled in with the length of the returned data.
@@ -292,8 +292,8 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetClipboardData(const char *mime_type, s
292
292
/**
293
293
* Query whether there is data in the clipboard for the provided mime type.
294
294
*
295
- * \param mime_type the mime type to check for data for .
296
- * \returns true if there exists data in clipboard for the provided mime type,
295
+ * \param mime_type the mime type to check for data.
296
+ * \returns true if data exists in the clipboard for the provided mime type,
297
297
* false if it does not.
298
298
*
299
299
* \threadsafety This function should only be called on the main thread.
@@ -310,7 +310,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasClipboardData(const char *mime_type);
310
310
*
311
311
* \param num_mime_types a pointer filled with the number of mime types, may
312
312
* be NULL.
313
- * \returns a null terminated array of strings with mime types, or NULL on
313
+ * \returns a null- terminated array of strings with mime types, or NULL on
314
314
* failure; call SDL_GetError() for more information. This should be
315
315
* freed with SDL_free() when it is no longer needed.
316
316
*
0 commit comments