CDRIVER-3320 Add BSON_GNUC_WARN_UNUSED_RESULT to exported functions (#855)

Author: eramongodb

src/libmongoc/doc/mongoc_apm_callbacks_new.rst

@@ -9,7 +9,7 @@ Synopsis
 .. code-block:: c
 
   mongoc_apm_callbacks_t *
-  mongoc_apm_callbacks_new (void);
+  mongoc_apm_callbacks_new (void) BSON_GNUC_WARN_UNUSED_RESULT;
 
 Create a struct to hold event-notification callbacks.
 

src/libmongoc/doc/mongoc_auto_encryption_opts_new.rst

@@ -8,8 +8,8 @@ Synopsis
 
 .. code-block:: c
 
-   mongoc_auto_encryption_opts_t *
-   mongoc_auto_encryption_opts_new (void);
+  mongoc_auto_encryption_opts_t *
+  mongoc_auto_encryption_opts_new (void) BSON_GNUC_WARN_UNUSED_RESULT;
 
 
 Create a new :symbol:`mongoc_auto_encryption_opts_t`.

src/libmongoc/doc/mongoc_client_command.rst

@@ -17,7 +17,8 @@ Synopsis
                          uint32_t batch_size,
                          const bson_t *query,
                          const bson_t *fields,
-                         const mongoc_read_prefs_t *read_prefs);
+                         const mongoc_read_prefs_t *read_prefs)
+     BSON_GNUC_WARN_UNUSED_RESULT;
 
 This function is superseded by :symbol:`mongoc_client_command_with_opts()`, :symbol:`mongoc_client_read_command_with_opts()`, :symbol:`mongoc_client_write_command_with_opts()`, and :symbol:`mongoc_client_read_write_command_with_opts()`.
 

src/libmongoc/doc/mongoc_client_encryption_datakey_opts_new.rst

@@ -8,7 +8,8 @@ Synopsis
 
 .. code-block:: c
 
-  mongoc_client_encryption_datakey_opts_t * mongoc_client_encryption_datakey_opts_new ();
+  mongoc_client_encryption_datakey_opts_t *
+  mongoc_client_encryption_datakey_opts_new (void) BSON_GNUC_WARN_UNUSED_RESULT;
 
 Returns
 -------

src/libmongoc/doc/mongoc_client_encryption_encrypt_opts_new.rst

@@ -9,7 +9,7 @@ Synopsis
 .. code-block:: c
 
   mongoc_client_encryption_encrypt_opts_t *
-  mongoc_client_encryption_encrypt_opts_new ();
+  mongoc_client_encryption_encrypt_opts_new (void) BSON_GNUC_WARN_UNUSED_RESULT;
 
 Returns
 -------

src/libmongoc/doc/mongoc_client_encryption_new.rst

@@ -8,9 +8,9 @@ Synopsis
 
 .. code-block:: c
 
-   mongoc_client_encryption_t *
-   mongoc_client_encryption_new (mongoc_client_encryption_opts_t *opts,
-                                 bson_error_t *error);
+  mongoc_client_encryption_t *
+  mongoc_client_encryption_new (mongoc_client_encryption_opts_t *opts,
+                                bson_error_t *error) BSON_GNUC_WARN_UNUSED_RESULT;
 
 Create a new :symbol:`mongoc_client_encryption_t`.
 

src/libmongoc/doc/mongoc_client_encryption_opts_new.rst

@@ -8,7 +8,8 @@ Synopsis
 
 .. code-block:: c
 
-   mongoc_client_encryption_opts_t * mongoc_client_encryption_opts_new (void);
+  mongoc_client_encryption_opts_t *
+  mongoc_client_encryption_opts_new (void) BSON_GNUC_WARN_UNUSED_RESULT;
 
 Returns
 -------

src/libmongoc/doc/mongoc_client_find_databases_with_opts.rst

@@ -9,8 +9,8 @@ Synopsis
 .. code-block:: c
 
   mongoc_cursor_t *
-  mongoc_client_find_databases_with_opts (mongoc_client_t *client,
-                                          const bson_t *opts);
+  mongoc_client_find_databases_with_opts (
+     mongoc_client_t *client, const bson_t *opts) BSON_GNUC_WARN_UNUSED_RESULT;
 
 Fetches a cursor containing documents, each corresponding to a database on this MongoDB server.
 

src/libmongoc/doc/mongoc_client_get_collection.rst

@@ -11,7 +11,8 @@ Synopsis
   mongoc_collection_t *
   mongoc_client_get_collection (mongoc_client_t *client,
                                 const char *db,
-                                const char *collection);
+                                const char *collection)
+     BSON_GNUC_WARN_UNUSED_RESULT;
 
 Get a newly allocated :symbol:`mongoc_collection_t` for the collection named ``collection`` in the database named ``db``.
 

src/libmongoc/doc/mongoc_client_get_database.rst

@@ -9,7 +9,8 @@ Synopsis
 .. code-block:: c
 
   mongoc_database_t *
-  mongoc_client_get_database (mongoc_client_t *client, const char *name);
+  mongoc_client_get_database (mongoc_client_t *client,
+                              const char *name) BSON_GNUC_WARN_UNUSED_RESULT;
 
 Get a newly allocated :symbol:`mongoc_database_t` for the database named ``name``.