more work on doxygen

documentation/RELEASE_NOTES.md

@@ -9,7 +9,7 @@ Will not work with older versions.
 destroy methods removed
 -----------------------
 
-All the destroy methods are removed since implementation is RAII compliant.s
+All the destroy methods are removed since implementation is RAII compliant.
 
 API changes to PvaClientMonitor
 -------------------------------

documentation/htmldoxygen/pvaClientGet.html

@@ -40,18 +40,18 @@
 pvaClientGet is a synchronous wrapper for the pvAccess::ChannelGet API, which is a callback based API.
 Thus it is easier to use than pvAccess::ChannelGet itself.
 </p>
-<p>An instance of PvaClientGet is created via a call to one of the followimg:</p>
+<p>An instance of PvaClientGet is created via a call to one of the following:</p>
 <pre>
 class PvaClientChannel
 ...
 {
 ...
-    PvaClientGetPtr get(std::string const & request = "field(value,alarm,timeStamp)");
-    PvaClientGetPtr createGet(std::string const & request = "");
-    PvaClientGetPtr createGet(epics::pvData::PVStructurePtr const &  pvRequest);
+    PvaClientGetPtr get(std::string const &amp; request = "field(value,alarm,timeStamp)");
+    PvaClientGetPtr createGet(std::string const &amp; request = "");
+    PvaClientGetPtr createGet(epics::pvData::PVStructurePtr const &amp;  pvRequest);
 ...
 };
-<p>An instance of <b>PvaClientGet/b> connects to a single channel.
+<p>An instance of <b>PvaClientGet</b> connects to a single channel.
 <b>PvaClientGet</b> has both synchronous methods, which block, and non blocking methods.
 </p>
 <p><b>PvaClientChannel</b> has methods:</p>
@@ -65,8 +65,8 @@ waitGet             waits until the server send a message that the get is comple
 getData             get the data.
 </pre>
 <p>
-Note that <b>issueConnect</b> and <b>issueGet</b> do not block but all other methods
-do block.
+<b>issueConnect</b> and <b>issueGet</b> do not block.
+All other methods can block.
 </p>
 
 </body>

documentation/htmldoxygen/pvaClientGetData.html

@@ -45,7 +45,7 @@ showChanged           Show all the fields that have changed value since the last
 getAlarm              If a alarm field is available get it.
 getTimeStamp          If a timeStamp field is available get it.
 hasValue              Does the PVStructure have a top level field named value
-NOTE: The following only apply it hasValue is true.
+NOTE: The following only apply if hasValue is true.
 isValueScalar         Is the value field a scalar?
 isValueScalarArray    Is the value field a scalar array?
 getValue              Get the value field.

documentation/htmldoxygen/pvaClientMonitorData.html

@@ -48,7 +48,7 @@ showChanged           Show all the fields that have changed value more than once
 getAlarm              If a alarm field is available get it.
 getTimeStamp          If a timeStamp field is available get it.
 hasValue              Does the PVStructure have a top level field named value
-NOTE: The following only apply it hasValue is true.
+NOTE: The following only apply if hasValue is true.
 isValueScalar         Is the value field a scalar?
 isValueScalarArray    Is the value field a scalar array?
 getValue              Get the value field.

documentation/htmldoxygen/pvaClientProcess.html

@@ -45,11 +45,11 @@ class PvaClientChannel
 ...
 {
 ...
-    PvaClientProcessPtr createProcess(std::string const & request = "");
-    PvaClientProcessPtr createProcess(epics::pvData::PVStructurePtr const &  pvRequest);
+    PvaClientProcessPtr createProcess(std::string const & request = "");
+    PvaClientProcessPtr createProcess(epics::pvData::PVStructurePtr const &  pvRequest);
 ...
 };
-<p>An instance of <b>PvaClientProcess/b> connects to a single channel.
+<p>An instance of <b>PvaClientProcess</b> connects to a single channel.
 <b>PvaClientProcess</b> has both synchronous methods, which block, and non blocking methods.
 </p>
 <p><b>PvaClientChannel</b> has methods:</p>
@@ -62,8 +62,8 @@ issueProcess        issues a process request to the server.
 waitProcess         waits until the server send a message that the process is complete.
 </pre>
 <p>
-Note that <b>issueConnect</b> and <b>issueProcess</b> do not block but all other methods
-do block.
+<b>issueConnect</b> and <b>issueProcess</b> do not block.
+All other methods can block.
 </p>
 
 </body>

documentation/htmldoxygen/pvaClientPutData.html

@@ -36,11 +36,11 @@
 <h1>PvaClientPutData</h1>
 
 <p>This class provides access to data to send to the server via a <b>PvaChannelPut</b>
-It is created by <b>PvaChannelPut<b> or <b>PvaChannelPutGet</b>.
-This the client only gets access to an instance by getting it from <b>PvaChannelPut<b> or <b>PvaChannelPutGet</b>.
+It is created by <b>PvaChannelPut</b> or <b>PvaChannelPutGet</b>.
+This the client only gets access to an instance by getting it from <b>PvaChannelPut</b> or <b>PvaChannelPutGet</b>.
 <p>
 <p>Note also that for all field types except <b>union</b> the <b>BitSet</b> for the data is updated
-by <b>PvaChannelPut<b> or <b>PvaChannelPutGet</b> whenever the client changes a field.
+by <b>PvaChannelPut</b> or <b>PvaChannelPutGet</b> whenever the client changes a field.
 For a <b>union</b> or <b>unionArray</b> field the client must update the <b>BitSet</b>.
 </p>
 
@@ -54,7 +54,7 @@ showChanged           Show all the fields that have changed value since the last
 getAlarm              If a alarm field is available get it.
 getTimeStamp          If a timeStamp field is available get it.
 hasValue              Does the PVStructure have a top level field named value
-NOTE: The following only apply it hasValue is true.
+NOTE: The following only apply if hasValue is true.
 isValueScalar         Is the value field a scalar?
 isValueScalarArray    Is the value field a scalar array?
 getValue              Get the value field.

documentation/htmldoxygen/pvaClientPutGet.html

@@ -50,11 +50,11 @@ class PvaClientChannel
 ...
 {
 ...
-    PvaClientPutGetPtr createPutGet(std::string const & request);
-    PvaClientPutGetPtr createPutGet(epics::pvData::PVStructurePtr const &  pvRequest);
+    PvaClientPutGetPtr createPutGet(std::string const & request);
+    PvaClientPutGetPtr createPutGet(epics::pvData::PVStructurePtr const &  pvRequest);
 ...
 };
-<p>An instance of <b>PvaClientPutGet/b> connects to a single channel.
+<p>An instance of <b>PvaClientPutGet</b> connects to a single channel.
 <b>PvaClientPutGet</b> has both synchronous methods, which block, and non blocking methods.
 </p>
 <p><b>PvaClientPutGet</b> has methods:</p>
@@ -75,7 +75,8 @@ getPutData          get the put portion of the data.
 getGetData          get the get portion of the data.
 </pre>
 <p>
-Note that <b>issueConnect</b>, <b>issuePutGet</b>,  <b>issueGetGet</b>  and <b>issueGetPut</b> do not block but all other methods block.
+<b>issueConnect</b>, <b>issuePutGet</b>,  <b>issueGetGet</b>  and <b>issueGetPut</b> do not block.
+All other methods can block.
 </p>
 
 

src/pv/pvaClient.h

@@ -17,7 +17,6 @@
 
 #include <list>
 #include <iostream>
-#include <compilerDependencies.h>
 #include <pv/requester.h>
 #include <pv/status.h>
 #include <pv/event.h>

src/pv/pvaClientMultiChannel.h

@@ -145,10 +145,6 @@ public:
      */
     PvaClientNTMultiMonitorPtr createNTMonitor(
         std::string const &request= "field(value,alarm,timeStamp)");
-     /** Deprecated method
-     * \deprecated This method will go away in future versions. 
-     */
-    void destroy()  EPICS_DEPRECATED {}
 private:
     PvaClientMultiChannel(
         PvaClientPtr const &pvaClient,
@@ -209,10 +205,6 @@ public:
     {
         return shared_from_this();
     }
-    /** Deprecated method
-     * \deprecated This method will go away in future versions. 
-     */
-    void destroy()  EPICS_DEPRECATED {}
 private:
     PvaClientMultiGetDouble(
          PvaClientMultiChannelPtr const &pvaClientMultiChannel,
@@ -262,10 +254,6 @@ public:
     {
         return shared_from_this();
     }
-    /** Deprecated method
-     * \deprecated This method will go away in future versions. 
-     */
-    void destroy()  EPICS_DEPRECATED {}
 private:
     PvaClientMultiPutDouble(
          PvaClientMultiChannelPtr const &pvaClientMultiChannel,
@@ -329,10 +317,6 @@ public:
     {
         return shared_from_this();
     }
-    /** Deprecated method
-     * \deprecated This method will go away in future versions. 
-     */
-    void destroy()  EPICS_DEPRECATED {}
 private:
     PvaClientMultiMonitorDouble(
          PvaClientMultiChannelPtr const &pvaClientMultiChannel,
@@ -390,10 +374,6 @@ public:
     {
         return shared_from_this();
     }
-    /** Deprecated method
-     * \deprecated This method will go away in future versions. 
-     */
-    void destroy()  EPICS_DEPRECATED {}
 private:
     PvaClientNTMultiGet(
          epics::pvData::UnionConstPtr const & u,
@@ -453,10 +433,6 @@ public:
     {
         return shared_from_this();
     }
-    /** Deprecated method
-     * \deprecated This method will go away in future versions. 
-     */
-    void destroy()  EPICS_DEPRECATED {}
 private:
     PvaClientNTMultiPut(
          PvaClientMultiChannelPtr const &pvaClientMultiChannel,
@@ -523,10 +499,6 @@ public:
     {
         return shared_from_this();
     }
-    /** Deprecated method
-     * \deprecated This method will go away in future versions. 
-     */
-    void destroy()  EPICS_DEPRECATED {}
 private:
     PvaClientNTMultiMonitor(
          epics::pvData::UnionConstPtr const & u,
@@ -601,10 +573,6 @@ public:
     {
         return shared_from_this();
     }
-    /** Deprecated method
-     * \deprecated This method will go away in future versions. 
-     */
-    void destroy()  EPICS_DEPRECATED {}
 private:
     PvaClientNTMultiData(
          epics::pvData::UnionConstPtr const & u,