Skip to content

Commit a914924

Browse files
authored
Remove compiler attributes from docs (#1781)
* remove non-existant reference to `BSON_GNUC_CONST` * remove compiler attributes from docs * relocate "superseded by" note to deprecation for deprecated legacy BSON helpers * remove redundant deprecation wording * fix reference in `mongoc_uri_get_ssl`
1 parent 9e42ae3 commit a914924

File tree

150 files changed

+180
-352
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

150 files changed

+180
-352
lines changed

src/libbson/doc/bson_array_as_json.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,17 @@ bson_array_as_json()
66
.. warning::
77
.. deprecated:: 1.29.0
88

9-
This function is deprecated and should not be used in new code.
9+
Use :symbol:`bson_array_as_canonical_extended_json()` and :symbol:`bson_array_as_relaxed_extended_json()` instead, which use the same `MongoDB Extended JSON format`_ as all other MongoDB drivers.
10+
11+
To continue producing Legacy Extended JSON, use :symbol:`bson_array_as_legacy_extended_json()`.
1012

1113
Synopsis
1214
--------
1315

1416
.. code-block:: c
1517
1618
char *
17-
bson_array_as_json (const bson_t *bson, size_t *length) BSON_GNUC_DEPRECATED_FOR (bson_array_as_legacy_extended_json);
19+
bson_array_as_json (const bson_t *bson, size_t *length);
1820
1921
Parameters
2022
----------
@@ -27,8 +29,6 @@ Description
2729

2830
:symbol:`bson_array_as_json()` encodes ``bson`` as a UTF-8 string using :doc:`libbson's Legacy Extended JSON <legacy_extended_json>`.
2931
The outermost element is encoded as a JSON array (``[ ... ]``), rather than a JSON document (``{ ... }``).
30-
This function is superseded by :symbol:`bson_array_as_canonical_extended_json()` and :symbol:`bson_array_as_relaxed_extended_json()`, which use the same `MongoDB Extended JSON format`_ as all other MongoDB drivers.
31-
To continue producing Legacy Extended JSON, :symbol:`bson_array_as_legacy_extended_json()` may be used.
3232

3333
The caller is responsible for freeing the resulting UTF-8 encoded string by calling :symbol:`bson_free()` with the result.
3434

src/libbson/doc/bson_array_builder_t.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Creating a top-level array
4646
bool
4747
bson_array_builder_build (bson_array_builder_t *bab, bson_t *out);
4848
49-
BSON_EXPORT (void)
49+
void
5050
bson_array_builder_destroy (bson_array_builder_t *bab);
5151
5252
``bson_array_builder_new`` and ``bson_array_builder_build`` may be used to build a top-level BSON array. ``bson_array_builder_build`` initializes and moves BSON data to ``out``. The ``bson_array_builder_t`` may be reused and will start appending a new array at index "0":

src/libbson/doc/bson_as_json.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,17 @@ bson_as_json()
66
.. warning::
77
.. deprecated:: 1.29.0
88

9-
This function is deprecated and should not be used in new code.
9+
Use :symbol:`bson_as_canonical_extended_json()` and :symbol:`bson_as_relaxed_extended_json()` instead, which use the same `MongoDB Extended JSON format`_ as all other MongoDB drivers.
10+
11+
To continue producing Legacy Extended JSON, use :symbol:`bson_as_legacy_extended_json()`.
1012

1113
Synopsis
1214
--------
1315

1416
.. code-block:: c
1517
1618
char *
17-
bson_as_json (const bson_t *bson, size_t *length) BSON_GNUC_DEPRECATED_FOR (bson_as_legacy_extended_json);
19+
bson_as_json (const bson_t *bson, size_t *length);
1820
1921
Parameters
2022
----------
@@ -26,8 +28,6 @@ Description
2628
-----------
2729

2830
:symbol:`bson_as_json()` encodes ``bson`` as a UTF-8 string using :doc:`libbson's Legacy Extended JSON <legacy_extended_json>`.
29-
This function is superseded by :symbol:`bson_as_canonical_extended_json()` and :symbol:`bson_as_relaxed_extended_json()`, which use the same `MongoDB Extended JSON format`_ as all other MongoDB drivers.
30-
To continue producing Legacy Extended JSON, :symbol:`bson_as_legacy_extended_json()` may be used.
3131

3232
The caller is responsible for freeing the resulting UTF-8 encoded string by calling :symbol:`bson_free()` with the result.
3333

src/libbson/doc/bson_context_t.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Synopsis
2020
typedef struct _bson_context_t bson_context_t;
2121
2222
bson_context_t *
23-
bson_context_get_default (void) BSON_GNUC_CONST;
23+
bson_context_get_default (void);
2424
bson_context_t *
2525
bson_context_new (bson_context_flags_t flags);
2626
void

src/libbson/doc/bson_copy_to_excluding.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ bson_copy_to_excluding()
66
.. warning::
77
.. deprecated:: 1.1.0
88

9-
This function is deprecated and should not be used in new code.
10-
11-
Please use :symbol:`bson_copy_to_excluding_noinit()` in new code.
9+
Use :symbol:`bson_copy_to_excluding_noinit()` instead.
1210

1311
Synopsis
1412
--------
@@ -19,8 +17,7 @@ Synopsis
1917
bson_copy_to_excluding (const bson_t *src,
2018
bson_t *dst,
2119
const char *first_exclude,
22-
...) BSON_GNUC_NULL_TERMINATED
23-
BSON_GNUC_DEPRECATED_FOR (bson_copy_to_excluding_noinit);
20+
...);
2421
2522
Parameters
2623
----------

src/libbson/doc/bson_copy_to_excluding_noinit.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Synopsis
1212
bson_copy_to_excluding_noinit (const bson_t *src,
1313
bson_t *dst,
1414
const char *first_exclude,
15-
...) BSON_GNUC_NULL_TERMINATED;
15+
...);
1616
1717
Parameters
1818
----------

src/libbson/doc/bson_oid_init_sequence.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,15 @@ bson_oid_init_sequence()
66
.. warning::
77
.. deprecated:: 1.14.0
88

9-
This function is deprecated and should not be used in new code.
10-
11-
Please use :symbol:`bson_oid_init()` in new code.
9+
Use :symbol:`bson_oid_init()` instead.
1210

1311
Synopsis
1412
--------
1513

1614
.. code-block:: c
1715
1816
void
19-
bson_oid_init_sequence (bson_oid_t *oid, bson_context_t *context)
20-
BSON_GNUC_DEPRECATED_FOR (bson_oid_init);
17+
bson_oid_init_sequence (bson_oid_t *oid, bson_context_t *context);
2118
2219
Parameters
2320
----------

src/libbson/doc/bson_set_error.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ Synopsis
1010
1111
void
1212
bson_set_error (
13-
bson_error_t *error, uint32_t domain, uint32_t code, const char *format, ...)
14-
BSON_GNUC_PRINTF (4, 5);
13+
bson_error_t *error, uint32_t domain, uint32_t code, const char *format, ...);
1514
1615
Parameters
1716
----------

src/libbson/doc/bson_snprintf.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ Synopsis
99
.. code-block:: c
1010
1111
int
12-
bson_snprintf (char *str, size_t size, const char *format, ...)
13-
BSON_GNUC_PRINTF (3, 4);
12+
bson_snprintf (char *str, size_t size, const char *format, ...);
1413
1514
Parameters
1615
----------

src/libbson/doc/bson_strdup_printf.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Synopsis
99
.. code-block:: c
1010
1111
char *
12-
bson_strdup_printf (const char *format, ...) BSON_GNUC_PRINTF (1, 2);
12+
bson_strdup_printf (const char *format, ...);
1313
1414
Parameters
1515
----------

0 commit comments

Comments
 (0)