Issue 18638: Documentation comments corrections to src/hpp/dds/pub/TPublisher.hpp (dds-psm-cxx-rtf) Source: Micro Focus (Mr. Simon McQueen, simon.mcqueen(at)microfocus.com) Nature: Uncategorized Issue Severity: 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; Resolution: Revised Text: Actions taken: April 9, 2013: received issue Discussion: End of Annotations:===== ogle-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20120113; h=x-received:message-id:date:from:user-agent:mime-version:to:subject :content-type:content-transfer-encoding:x-gm-message-state; bh=jn8ObXM6qBab+EvWVUDeDFMGpeBafEpRI+8s0xyqWBA=; b=irko2uOd2BB2zF4NmDL0JenpVxUziO7RxWn0Nc5Bl08vEGU4XdWSG4gglL0xIVbLWt 5Rd8UGF+BoH4JHQ5n39dQyFMNHA3oimNveU6oBRjLSLdhZ7IC1XpHAaDGrgEECERPThF 7cyaKpx7zHp9oZxi28vkA/o+IcMpyKMWETzSjZQlNwKfeZ6boxUZ9+z36t/3rwS9ZQR/ 8x9SQaWLOOH/vD0jlvD1ChO7gzbSUlK9WVsYzalU9T5l1w2MLYX36E3opD2iwQUYbg4H MrOqHU9qH+VRrelm4upgVEwyWOLngxYhrzt9sHi/z2cN2AzWPugW1AGoBq0jcxeb7inT AfXA== X-Received: by 10.180.89.243 with SMTP id br19mr20140155wib.5.1365517593581; Tue, 09 Apr 2013 07:26:33 -0700 (PDT) Date: Tue, 09 Apr 2013 15:26:22 +0100 From: Simon McQueen User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:17.0) Gecko/20130307 Thunderbird/17.0.4 To: issues@omg.org Subject: Documentation comments corrections to src/hpp/dds/pub/TPublisher.hpp X-Gm-Message-State: ALoCoQnUkcPyION2yNh4iXjncxKgP474HxYE64bxYJ40KgKPymNlNq7FqMTBloUkXO8aZaUUEqY8 X-Virus-Scanned: amavisd-new at omg.org X-Brightmail-Tracker: AAAAAA== X-Brightmail-Tracker: AAAAAA== Name: Simon McQueen Employer: PrismTech Specification: DDS CXX PSM RTF FormalNumber: ptc/12-10-03 Nature: Revision _Issues_: 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 DataWriterQos<\code> - * which will be used for newly created DataWriterentities + * This operation sets a default value of the DataWriterQos + * which will be used for newly created DataWriterentities * for which no DataWriterQos 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 DataWriterQos<\code>, + * This operation retrieves the default value of the DataWriterQos, * 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 DomainParticipant that owns this Publisher. + * Return the DomainParticipant that owns this Publisher. */ const dds::domain::DomainParticipant& participant() const;