From 0ada6c912df8fe5126383c88c0b745dc3cca4174 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20Ferreira=20Gonz=C3=A1lez?= Date: Tue, 18 Nov 2025 08:16:41 +0100 Subject: [PATCH] Update deprecated API MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Carlos Ferreira González --- docs/03-exports/aliases-api.include | 2 +- docs/fastdds/rtps_layer/rtps_layer.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/03-exports/aliases-api.include b/docs/03-exports/aliases-api.include index d20a9162b..79b7cbafc 100644 --- a/docs/03-exports/aliases-api.include +++ b/docs/03-exports/aliases-api.include @@ -936,12 +936,12 @@ .. |RTPSWriters-api| replace:: :cpp:class:`RTPSWriters ` .. |WriterAttributes-api| replace:: :cpp:class:`WriterAttributes` -.. |RTPSWriters::new_change-api| replace:: :cpp:func:`RTPSWriter::new_change() ` .. |RTPSWriters::wait_for_all_acked-api| replace:: :cpp:func:`RTPSWriter::wait_for_all_acked ` .. |History-api| replace:: :cpp:class:`History ` .. |WriterHistory-api| replace:: :cpp:class:`WriterHistory ` .. |WriterHistory::add_change-api| replace:: :cpp:func:`WriterHistory::add_change() ` +.. |WriterHistory::create_change-api| replace:: :cpp:func:`WriterHistory::create_change() ` .. |ReaderHistory-api| replace:: :cpp:class:`ReaderHistory ` .. |CacheChange_t-api| replace:: :cpp:class:`CacheChange_t` diff --git a/docs/fastdds/rtps_layer/rtps_layer.rst b/docs/fastdds/rtps_layer/rtps_layer.rst index 856413864..4a5cd66df 100644 --- a/docs/fastdds/rtps_layer/rtps_layer.rst +++ b/docs/fastdds/rtps_layer/rtps_layer.rst @@ -94,9 +94,9 @@ Changes are always managed by the History. You can add a new :class:`CacheChange_t` to the History of the Writer to send data. The procedure is as follows: -1. Request a :class:`CacheChange_t` from the Writer with |RTPSWriters::new_change-api|. +1. Request a :class:`CacheChange_t` from the Writer History with |WriterHistory::create_change-api|. In order to allocate enough memory, - you need to provide a callback that returns the maximum number bytes in the payload. + you need to provide as argument the maximum number of bytes in the payload. 2. Fill the :class:`CacheChange_t` with the data. 3. Add it to the History with |WriterHistory::add_change-api|.