-
Key: DDSPSMC11_-47
-
Legacy Issue Number: 18638
-
Status: open
-
Source: Leonardo S.p.A ( Simon McQueen)
-
Summary:
Corrections to documentation comments required.
Suggested resolution:
diff --git a/src/hpp/dds/pub/TPublisher.hpp b/src/hpp/dds/pub/TPublisher.hpp index 3534a29..d872370 100644 --- a/src/hpp/dds/pub/TPublisher.hpp +++ b/src/hpp/dds/pub/TPublisher.hpp @@ -97,16 +97,16 @@ public: * * @param pqos the new publisher QoS */ - TPublisher& operator <<(const dds::pub::qos::PublisherQos& the_qos); + TPublisher& operator <<(const dds::pub::qos::PublisherQos& pqos); /** * Get the publisher qos policies. */ - TPublisher& operator >> (dds::pub::qos::PublisherQos& the_qos); + TPublisher& operator >> (dds::pub::qos::PublisherQos& qos); /** - * This operation sets a default value of the <code>DataWriterQos<\code> - * which will be used for newly created <core>DataWriter<code>entities + * This operation sets a default value of the <code>DataWriterQos</code> + * which will be used for newly created <code>DataWriter</code>entities * for which no <code>DataWriterQos</code> is provided in the constructor. * This operation will check that the resulting policies are self consistent; * if they are not, the operation will have no effect and raise an @@ -115,7 +115,7 @@ public: TPublisher& default_writer_qos(const dds::pub::qos::DataWriterQos& dwqos); /** - * This operation retrieves the default value of the <code>DataWriterQos<\code>, + * This operation retrieves the default value of the <code>DataWriterQos</code>, * that is, the QoS policies which will be used for newly created DataWriter * that don't provide a QoS parameter in the constructor. */ @@ -155,7 +155,7 @@ public: //========================================================================== /** - * Return the <code>DomainParticipant<code> that owns this Publisher. + * Return the <code>DomainParticipant</code> that owns this Publisher. */ const dds::domain::DomainParticipant& participant() const; @@ -143,19 +159,21 @@ public: * This operation blocks the calling thread until either all data written * by the reliable DataWriter entities is acknowledged by all matched * reliable DataReader entities, or else the duration specified by the - * max_wait parameter elapses, whichever happens first. + * timeout parameter elapses, whichever happens first. * A normal return indicates that all the samples written have been - * acknowledged by all reliable matched data readers; A TimeoutError - * indicates that max_wait elapsed before all the data was acknowledged. + * acknowledged by all reliable matched data readers. A TimeoutError + * indicates that timeout elapsed before all the data was acknowledged. + * + * @param timeout the time out duration */ void wait_for_acknowledgments(const dds::core::Duration& timeout);
-
Reported: DDS-PSM-Cxx 1.0b2 — Tue, 9 Apr 2013 04:00 GMT
-
Updated: Sun, 30 Sep 2018 23:30 GMT
DDSPSMC11_ — Documentation comments corrections to src/hpp/dds/pub/TPublisher.hpp
- Key: DDSPSMC11_-47
- OMG Task Force: DDS-PSM-Cxx v1.1 RTF