Issue 18635: Documentation comments corrections required to src/hpp/dds/domain/discovery.hpp & find.hpp (dds-psm-cxx-rtf)
Source: Micro Focus (Mr. Simon McQueen, simon.mcqueen(at)microfocus.com)
Nature: Uncategorized Issue
Severity: 
Summary: Comment correction required.


_Suggested resolution_:


diff --git a/src/hpp/dds/domain/discovery.hpp b/src/hpp/dds/domain/discovery.hpp
index e43d28d..97943ec 100644
--- a/src/hpp/dds/domain/discovery.hpp
+++ b/src/hpp/dds/domain/discovery.hpp
@@ -26,7 +26,7 @@
 namespace dds { namespace domain {


   /**
-   * This function allows to express the will to ignore the entity
+   * This function allows one to express the will to ignore the entity
    * represented by the given <code>InstanceHandle</code> for the specific
    * <code>DomainParticipant</code>.
    *
@@ -40,7 +40,7 @@ namespace dds { namespace domain {
   void ignore(const dds::domain::DomainParticipant& dp, const dds::core::InstanceHandle& handle);


   /**
-   * This function allows to express the will to ignore a series of entities
+   * This function allows one to express the will to ignore a series of entities
    * whose instance handles are made available via the provided iterators.
    *
    * @param dp      the <code>DomainParticipant</code> for which the remote
diff --git a/src/hpp/dds/domain/find.hpp b/src/hpp/dds/domain/find.hpp
index 112d67c..2043f04 100644
--- a/src/hpp/dds/domain/find.hpp
+++ b/src/hpp/dds/domain/find.hpp
@@ -27,7 +27,7 @@ namespace dds { namespace domain {
   /**
    * This operation retrieves a previously created <code>DomainParticipant</code>
    * belonging to specified domain_id. If no such DomainParticipant
-   * exists, the operation will return a <it>nil</it> value.
+   * exists, the operation will return a @a nil value.
    *
    * @param id the domain id
    */
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=X1BCMVuS4/bjzIBBnBQxJVRtgLnlV3OC5DsSgqZBZSI=;
        b=car3fUEn5s0+6YW+SUa5YcSXpUyuUaBYVrm5IViB7QA326nX4Za1XPxWOE1Nh9q0me
         D6aFzu75NbewXfCR9qelddTWf2cyFbnOYzWSgqebMPBG/by1hLiUL+TYyYfOvr/RxPBv
         GhIW4PfEQHI/mUWi6t0F5W5lmSL/jY1Xvu7GniePvdlPn32my9w+0C2ocXmMHXeDCC8A
         BG17fzn7NBOdrNZOHykmqd5ho8sLuBbhXiYMKjKENXCwjphz8m7ZqtA8kpXKHRXeoIyo
         JoOI2AjkBXUKsPPqoXzjLVRZ6aPNv02mi7aGfYJZXTsO3ozOK4PyGffiJQg6QR7yMhrn
         FrLQ==
X-Received: by 10.194.11.70 with SMTP id o6mr38743729wjb.29.1365514678124;
        Tue, 09 Apr 2013 06:37:58 -0700 (PDT)
Date: Tue, 09 Apr 2013 14:37:47 +0100
From: Simon McQueen <sm@prismtech.com>
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 required to src/hpp/dds/domain/discovery.hpp
 & find.hpp
X-Gm-Message-State: ALoCoQmOkd4DxPE6jZz+o5X/rcUWnsmabm6nPTMf/qZMTuvUBYksM6hMhUQuTX2Utq+eNsJ5q2Fk
X-Virus-Scanned: amavisd-new at omg.org
X-Brightmail-Tracker: AAAAAR16L3U=
X-Brightmail-Tracker: AAAAAA==


Name:            Simon McQueen
Employer:        PrismTech
Specification:   DDS CXX PSM RTF
FormalNumber:    ptc/12-10-03
Nature:          Revision


_Issues_:


Comment correction required.


_Suggested resolution_:


diff --git a/src/hpp/dds/domain/discovery.hpp b/src/hpp/dds/domain/discovery.hpp
index e43d28d..97943ec 100644
--- a/src/hpp/dds/domain/discovery.hpp
+++ b/src/hpp/dds/domain/discovery.hpp
@@ -26,7 +26,7 @@
 namespace dds { namespace domain {


   /**
-   * This function allows to express the will to ignore the entity
+   * This function allows one to express the will to ignore the entity
    * represented by the given <code>InstanceHandle</code> for the specific
    * <code>DomainParticipant</code>.
    *
@@ -40,7 +40,7 @@ namespace dds { namespace domain {
   void ignore(const dds::domain::DomainParticipant& dp, const dds::core::InstanceHandle& handle);


   /**
-   * This function allows to express the will to ignore a series of entities
+   * This function allows one to express the will to ignore a series of entities
    * whose instance handles are made available via the provided iterators.
    *
    * @param dp      the <code>DomainParticipant</code> for which the remote
diff --git a/src/hpp/dds/domain/find.hpp b/src/hpp/dds/domain/find.hpp
index 112d67c..2043f04 100644
--- a/src/hpp/dds/domain/find.hpp
+++ b/src/hpp/dds/domain/find.hpp
@@ -27,7 +27,7 @@ namespace dds { namespace domain {
   /**
    * This operation retrieves a previously created <code>DomainParticipant</code>
    * belonging to specified domain_id. If no such DomainParticipant
-   * exists, the operation will return a <it>nil</it> value.
+   * exists, the operation will return a @a nil value.
    *
    * @param id the domain id
    */