From 5108bae08c1abdb2c76dc5fbd1fc72bb5c64b00b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mario=20Dom=C3=ADnguez=20L=C3=B3pez?= <116071334+Mario-DL@users.noreply.github.com> Date: Tue, 23 Jul 2024 15:54:35 +0200 Subject: [PATCH] Move `Time_t` to `dds` namespace and some *Attributes to `xmlparser` docs (#870) * Refs #21321: Update CodeTester Signed-off-by: Mario Dominguez * Refs #21321: Update docs Signed-off-by: Mario Dominguez * Refs #21321: Apply rev Signed-off-by: Mario Dominguez --------- Signed-off-by: Mario Dominguez --- code/DDSCodeTester.cpp | 6 ++-- docs/03-exports/aliases-api.include | 6 ++-- .../dds_pim/core/Time_t/Duration_t.rst | 7 +++++ .../dds_pim/core/Time_t/Time_t.rst | 10 ++++++ .../dds_pim/core/Time_t/const_values.rst | 14 +++++++++ .../dds_pim/core/Time_t/operators.rst | 31 +++++++++++++++++++ .../dds_pim/core/Time_t/time_toc.rst | 12 +++++++ .../api_reference/dds_pim/core/core.rst | 9 +++--- .../rtps/common/Time_t/Duration_t.rst | 7 ----- .../rtps/common/Time_t/Time_t.rst | 4 +-- .../rtps/common/Time_t/const_values.rst | 14 --------- .../rtps/common/Time_t/fastrtps_Time_t.rst | 8 ----- .../rtps/common/Time_t/operators.rst | 30 ++---------------- .../rtps/common/Time_t/time_toc.rst | 7 ++--- 14 files changed, 91 insertions(+), 74 deletions(-) create mode 100644 docs/fastdds/api_reference/dds_pim/core/Time_t/Duration_t.rst create mode 100644 docs/fastdds/api_reference/dds_pim/core/Time_t/Time_t.rst create mode 100644 docs/fastdds/api_reference/dds_pim/core/Time_t/const_values.rst create mode 100644 docs/fastdds/api_reference/dds_pim/core/Time_t/operators.rst create mode 100644 docs/fastdds/api_reference/dds_pim/core/Time_t/time_toc.rst delete mode 100644 docs/fastdds/api_reference/rtps/common/Time_t/Duration_t.rst delete mode 100644 docs/fastdds/api_reference/rtps/common/Time_t/const_values.rst delete mode 100644 docs/fastdds/api_reference/rtps/common/Time_t/fastrtps_Time_t.rst diff --git a/code/DDSCodeTester.cpp b/code/DDSCodeTester.cpp index ecaa7822f..a221ba62a 100644 --- a/code/DDSCodeTester.cpp +++ b/code/DDSCodeTester.cpp @@ -3872,7 +3872,7 @@ void dds_dataReader_examples() SampleInfo info; //Define a timeout of 5 seconds - eprosima::fastdds::Duration_t timeout (5, 0); + eprosima::fastdds::dds::Duration_t timeout (5, 0); // Loop reading data as it arrives // This will make the current thread to be dedicated exclusively to @@ -3924,7 +3924,7 @@ void dds_dataReader_examples() SampleInfo info; //Define a timeout of 5 seconds - eprosima::fastdds::Duration_t timeout (5, 0); + eprosima::fastdds::dds::Duration_t timeout (5, 0); // Loop reading data as it arrives // This will make the current thread to be dedicated exclusively to @@ -7403,7 +7403,7 @@ void dds_waitset_example() // Wait for any of the conditions to be triggered ReturnCode_t ret_code; ConditionSeq triggered_conditions; - ret_code = wait_set_.wait(triggered_conditions, eprosima::fastdds::c_TimeInfinite); + ret_code = wait_set_.wait(triggered_conditions, eprosima::fastdds::dds::c_TimeInfinite); if (RETCODE_OK != ret_code) { // ... handle error diff --git a/docs/03-exports/aliases-api.include b/docs/03-exports/aliases-api.include index 369d5a635..a185ab0fc 100644 --- a/docs/03-exports/aliases-api.include +++ b/docs/03-exports/aliases-api.include @@ -465,9 +465,9 @@ .. |EXCLUSIVE-xml-api| replace:: :cpp:enumerator:`EXCLUSIVE` .. |Duration_t-api| replace:: :cpp:type:`Duration_t` -.. |c_TimeInfinite-api| replace:: :cpp:var:`c_TimeInfinite` -.. |c_TimeZero-api| replace:: :cpp:var:`c_TimeZero` -.. |c_TimeInvalid-api| replace:: :cpp:var:`c_TimeInvalid` +.. |c_TimeInfinite-api| replace:: :cpp:var:`c_TimeInfinite` +.. |c_TimeZero-api| replace:: :cpp:var:`c_TimeZero` +.. |c_TimeInvalid-api| replace:: :cpp:var:`c_TimeInvalid` .. |LocatorList_t-api| replace:: :cpp:type:`LocatorList` .. |ExternalLocators-api| replace:: :cpp:type:`ExternalLocators` .. |Locator_t-api| replace:: :cpp:class:`Locator_t` diff --git a/docs/fastdds/api_reference/dds_pim/core/Time_t/Duration_t.rst b/docs/fastdds/api_reference/dds_pim/core/Time_t/Duration_t.rst new file mode 100644 index 000000000..33084f2b7 --- /dev/null +++ b/docs/fastdds/api_reference/dds_pim/core/Time_t/Duration_t.rst @@ -0,0 +1,7 @@ +.. rst-class:: api-ref + +DDS Layer Duration_t +-------------------- + +.. doxygentypedef:: eprosima::fastdds::dds::Duration_t + :project: FastDDS diff --git a/docs/fastdds/api_reference/dds_pim/core/Time_t/Time_t.rst b/docs/fastdds/api_reference/dds_pim/core/Time_t/Time_t.rst new file mode 100644 index 000000000..730524642 --- /dev/null +++ b/docs/fastdds/api_reference/dds_pim/core/Time_t/Time_t.rst @@ -0,0 +1,10 @@ +.. _api_pim_time_t: + +.. rst-class:: api-ref + +DDS Layer Time_t +---------------- + +.. doxygenstruct:: eprosima::fastdds::dds::Time_t + :project: FastDDS + :members: diff --git a/docs/fastdds/api_reference/dds_pim/core/Time_t/const_values.rst b/docs/fastdds/api_reference/dds_pim/core/Time_t/const_values.rst new file mode 100644 index 000000000..9defb8801 --- /dev/null +++ b/docs/fastdds/api_reference/dds_pim/core/Time_t/const_values.rst @@ -0,0 +1,14 @@ +.. rst-class:: api-ref + +Const values +------------ + +.. doxygenvariable:: eprosima::fastdds::dds::c_TimeInfinite + :project: FastDDS + +.. doxygenvariable:: eprosima::fastdds::dds::c_TimeZero + :project: FastDDS + +.. doxygenvariable:: eprosima::fastdds::dds::c_TimeInvalid + :project: FastDDS + diff --git a/docs/fastdds/api_reference/dds_pim/core/Time_t/operators.rst b/docs/fastdds/api_reference/dds_pim/core/Time_t/operators.rst new file mode 100644 index 000000000..3ac7d27ac --- /dev/null +++ b/docs/fastdds/api_reference/dds_pim/core/Time_t/operators.rst @@ -0,0 +1,31 @@ +.. rst-class:: api-ref + +Time_t DDS Operators +-------------------- + +.. doxygenfunction:: eprosima::fastdds::dds::operator==(const Time_t &t1, const Time_t &t2) + :project: FastDDS + +.. doxygenfunction:: eprosima::fastdds::dds::operator!=(const Time_t &t1, const Time_t &t2) + :project: FastDDS + +.. doxygenfunction:: eprosima::fastdds::dds::operator<(const Time_t &t1, const Time_t &t2) + :project: FastDDS + +.. doxygenfunction:: eprosima::fastdds::dds::operator>(const Time_t &t1, const Time_t &t2) + :project: FastDDS + +.. doxygenfunction:: eprosima::fastdds::dds::operator<=(const Time_t &t1, const Time_t &t2) + :project: FastDDS + +.. doxygenfunction:: eprosima::fastdds::dds::operator>=(const Time_t &t1, const Time_t &t2) + :project: FastDDS + +.. doxygenfunction:: eprosima::fastdds::dds::operator<<(std::ostream &output, const Time_t &t) + :project: FastDDS + +.. doxygenfunction:: eprosima::fastdds::dds::operator+(const Time_t &ta, const Time_t &tb) + :project: FastDDS + +.. doxygenfunction:: eprosima::fastdds::dds::operator-(const Time_t &ta, const Time_t &tb) + :project: FastDDS diff --git a/docs/fastdds/api_reference/dds_pim/core/Time_t/time_toc.rst b/docs/fastdds/api_reference/dds_pim/core/Time_t/time_toc.rst new file mode 100644 index 000000000..a64f90e1d --- /dev/null +++ b/docs/fastdds/api_reference/dds_pim/core/Time_t/time_toc.rst @@ -0,0 +1,12 @@ +.. _api_dds_common_time_t: + +DDS Time_t +---------- + +.. toctree:: + :titlesonly: + + /fastdds/api_reference/dds_pim/core/Time_t/const_values + /fastdds/api_reference/dds_pim/core/Time_t/Duration_t + /fastdds/api_reference/dds_pim/core/Time_t/operators + /fastdds/api_reference/dds_pim/core/Time_t/Time_t diff --git a/docs/fastdds/api_reference/dds_pim/core/core.rst b/docs/fastdds/api_reference/dds_pim/core/core.rst index 7f630005e..4372ba585 100644 --- a/docs/fastdds/api_reference/dds_pim/core/core.rst +++ b/docs/fastdds/api_reference/dds_pim/core/core.rst @@ -4,12 +4,13 @@ Core .. toctree:: :titlesonly: - /fastdds/api_reference/dds_pim/core/entity.rst - /fastdds/api_reference/dds_pim/core/domainentity.rst - /fastdds/api_reference/dds_pim/core/policy/policy.rst - /fastdds/api_reference/dds_pim/core/status/status.rst /fastdds/api_reference/dds_pim/core/condition/basecondition.rst + /fastdds/api_reference/dds_pim/core/domainentity.rst + /fastdds/api_reference/dds_pim/core/entity.rst /fastdds/api_reference/dds_pim/core/loanablearray.rst /fastdds/api_reference/dds_pim/core/loanablecollection.rst /fastdds/api_reference/dds_pim/core/loanablesequence.rst + /fastdds/api_reference/dds_pim/core/policy/policy.rst /fastdds/api_reference/dds_pim/core/stackallocatedsequence.rst + /fastdds/api_reference/dds_pim/core/status/status.rst + /fastdds/api_reference/dds_pim/core/Time_t/time_toc.rst diff --git a/docs/fastdds/api_reference/rtps/common/Time_t/Duration_t.rst b/docs/fastdds/api_reference/rtps/common/Time_t/Duration_t.rst deleted file mode 100644 index a31034bcf..000000000 --- a/docs/fastdds/api_reference/rtps/common/Time_t/Duration_t.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. rst-class:: api-ref - -eprosima::fastdds::Duration_t --------------------------------- - -.. doxygentypedef:: eprosima::fastdds::Duration_t - :project: FastDDS diff --git a/docs/fastdds/api_reference/rtps/common/Time_t/Time_t.rst b/docs/fastdds/api_reference/rtps/common/Time_t/Time_t.rst index 5fde81ca1..94221ca78 100644 --- a/docs/fastdds/api_reference/rtps/common/Time_t/Time_t.rst +++ b/docs/fastdds/api_reference/rtps/common/Time_t/Time_t.rst @@ -1,7 +1,7 @@ .. rst-class:: api-ref -Time_t --------------------------------- +RTPS layer Time_t +----------------- .. doxygenclass:: eprosima::fastdds::rtps::Time_t :project: FastDDS diff --git a/docs/fastdds/api_reference/rtps/common/Time_t/const_values.rst b/docs/fastdds/api_reference/rtps/common/Time_t/const_values.rst deleted file mode 100644 index fbd147881..000000000 --- a/docs/fastdds/api_reference/rtps/common/Time_t/const_values.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. rst-class:: api-ref - -Const values --------------------------------- - -.. doxygenvariable:: eprosima::fastdds::c_TimeInfinite - :project: FastDDS - -.. doxygenvariable:: eprosima::fastdds::c_TimeZero - :project: FastDDS - -.. doxygenvariable:: eprosima::fastdds::c_TimeInvalid - :project: FastDDS - diff --git a/docs/fastdds/api_reference/rtps/common/Time_t/fastrtps_Time_t.rst b/docs/fastdds/api_reference/rtps/common/Time_t/fastrtps_Time_t.rst deleted file mode 100644 index 1074699d4..000000000 --- a/docs/fastdds/api_reference/rtps/common/Time_t/fastrtps_Time_t.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. rst-class:: api-ref - -eprosima::fastdds::Time_t --------------------------------- - -.. doxygenstruct:: eprosima::fastdds::Time_t - :project: FastDDS - :members: diff --git a/docs/fastdds/api_reference/rtps/common/Time_t/operators.rst b/docs/fastdds/api_reference/rtps/common/Time_t/operators.rst index a732e136d..a61d8721a 100644 --- a/docs/fastdds/api_reference/rtps/common/Time_t/operators.rst +++ b/docs/fastdds/api_reference/rtps/common/Time_t/operators.rst @@ -1,7 +1,7 @@ .. rst-class:: api-ref -Time_t Operators --------------------------------- +Time_t RTPS Operators +--------------------- .. doxygenfunction:: eprosima::fastdds::rtps::operator==(const Time_t &t1, const Time_t &t2) :project: FastDDS @@ -30,29 +30,3 @@ Time_t Operators .. doxygenfunction:: eprosima::fastdds::rtps::operator-(const Time_t &ta, const Time_t &tb) :project: FastDDS -.. doxygenfunction:: eprosima::fastdds::operator==(const Time_t &t1, const Time_t &t2) - :project: FastDDS - -.. doxygenfunction:: eprosima::fastdds::operator!=(const Time_t &t1, const Time_t &t2) - :project: FastDDS - -.. doxygenfunction:: eprosima::fastdds::operator<(const Time_t &t1, const Time_t &t2) - :project: FastDDS - -.. doxygenfunction:: eprosima::fastdds::operator>(const Time_t &t1, const Time_t &t2) - :project: FastDDS - -.. doxygenfunction:: eprosima::fastdds::operator<=(const Time_t &t1, const Time_t &t2) - :project: FastDDS - -.. doxygenfunction:: eprosima::fastdds::operator>=(const Time_t &t1, const Time_t &t2) - :project: FastDDS - -.. doxygenfunction:: eprosima::fastdds::operator<<(std::ostream &output, const Time_t &t) - :project: FastDDS - -.. doxygenfunction:: eprosima::fastdds::operator+(const Time_t &ta, const Time_t &tb) - :project: FastDDS - -.. doxygenfunction:: eprosima::fastdds::operator-(const Time_t &ta, const Time_t &tb) - :project: FastDDS diff --git a/docs/fastdds/api_reference/rtps/common/Time_t/time_toc.rst b/docs/fastdds/api_reference/rtps/common/Time_t/time_toc.rst index d094152dd..885eec8f3 100644 --- a/docs/fastdds/api_reference/rtps/common/Time_t/time_toc.rst +++ b/docs/fastdds/api_reference/rtps/common/Time_t/time_toc.rst @@ -1,14 +1,11 @@ .. _api_rtps_common_time_t: -Time_t --------------------- +RTPS Time_t +----------- .. toctree:: :titlesonly: - /fastdds/api_reference/rtps/common/Time_t/const_values /fastdds/api_reference/rtps/common/Time_t/defines - /fastdds/api_reference/rtps/common/Time_t/Duration_t - /fastdds/api_reference/rtps/common/Time_t/fastrtps_Time_t /fastdds/api_reference/rtps/common/Time_t/operators /fastdds/api_reference/rtps/common/Time_t/Time_t