Skip to content

Commit f90ff3f

Browse files
committed
Add documentation for mongoc_server_api_t getters
1 parent fe8a8c4 commit f90ff3f

File tree

4 files changed

+75
-0
lines changed

4 files changed

+75
-0
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
:man_page: mongoc_server_api_get_deprecation_errors
2+
3+
mongoc_server_api_get_deprecation_errors()
4+
==========================================
5+
6+
Synopsis
7+
--------
8+
9+
.. code-block:: c
10+
11+
const mongoc_optional_t
12+
mongoc_server_api_get_deprecation_errors (const mongoc_server_api_t *api);
13+
14+
Returns the value of the deprecation_errors flag for the :symbol:`mongoc_server_api_t`.
15+
16+
Parameters
17+
----------
18+
19+
* ``api``: A :symbol:`mongoc_server_api_t`.
20+
21+
Returns
22+
-------
23+
24+
Returns a :symbol:`mongoc_optional_t` indicating whether the deprecation_errors flag was set.
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
:man_page: mongoc_server_api_get_strict
2+
3+
mongoc_server_api_get_strict()
4+
==============================
5+
6+
Synopsis
7+
--------
8+
9+
.. code-block:: c
10+
11+
const mongoc_optional_t
12+
mongoc_server_api_get_strict (const mongoc_server_api_t *api);
13+
14+
Returns the value of the strict flag for the :symbol:`mongoc_server_api_t`.
15+
16+
Parameters
17+
----------
18+
19+
* ``api``: A :symbol:`mongoc_server_api_t`.
20+
21+
Returns
22+
-------
23+
24+
Returns a :symbol:`mongoc_optional_t` indicating whether the strict flag was set.
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
:man_page: mongoc_server_api_get_version
2+
3+
mongoc_server_api_get_version()
4+
===============================
5+
6+
Synopsis
7+
--------
8+
9+
.. code-block:: c
10+
11+
mongoc_server_api_version_t
12+
mongoc_server_api_get_version (const mongoc_server_api_t *api);
13+
14+
Fetch the declared API version as from a :symbol:`mongoc_server_api_t`.
15+
16+
Parameters
17+
----------
18+
19+
* ``api``: A :symbol:`mongoc_server_api_t`.
20+
21+
Returns
22+
-------
23+
24+
Returns a :symbol:`mongoc_server_api_version_t` with the API version declare in the :symbol:`mongoc_server_api_t`.

src/libmongoc/doc/mongoc_server_api_t.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,8 @@ A :symbol:`mongoc_server_api_t` can be set on a client, and will then be sent to
2626
mongoc_server_api_copy
2727
mongoc_server_api_deprecation_errors
2828
mongoc_server_api_destroy
29+
mongoc_server_api_get_deprecation_errors
30+
mongoc_server_api_get_strict
31+
mongoc_server_api_get_version
2932
mongoc_server_api_new
3033
mongoc_server_api_strict

0 commit comments

Comments
 (0)