From 9b1539f3685b42d7a41f7f4cb6cc327d5531cd00 Mon Sep 17 00:00:00 2001 From: mrkraimer Date: Wed, 12 Jul 2017 06:38:55 -0400 Subject: [PATCH] more work on doxygen --- documentation/RELEASE_NOTES.md | 2 +- documentation/htmldoxygen/pvaClientGet.html | 14 ++++---- .../htmldoxygen/pvaClientGetData.html | 2 +- .../htmldoxygen/pvaClientMonitorData.html | 2 +- .../htmldoxygen/pvaClientProcess.html | 10 +++--- .../htmldoxygen/pvaClientPutData.html | 8 ++--- .../htmldoxygen/pvaClientPutGet.html | 9 +++--- src/pv/pvaClient.h | 1 - src/pv/pvaClientMultiChannel.h | 32 ------------------- 9 files changed, 24 insertions(+), 56 deletions(-) diff --git a/documentation/RELEASE_NOTES.md b/documentation/RELEASE_NOTES.md index 0070a25..628422d 100644 --- a/documentation/RELEASE_NOTES.md +++ b/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 ------------------------------- diff --git a/documentation/htmldoxygen/pvaClientGet.html b/documentation/htmldoxygen/pvaClientGet.html index 12984d6..0845e92 100644 --- a/documentation/htmldoxygen/pvaClientGet.html +++ b/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.

-

An instance of PvaClientGet is created via a call to one of the followimg:

+

An instance of PvaClientGet is created via a call to one of the following:

 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 & request = "field(value,alarm,timeStamp)");
+    PvaClientGetPtr createGet(std::string const & request = "");
+    PvaClientGetPtr createGet(epics::pvData::PVStructurePtr const &  pvRequest);
 ...
 };
-
An instance of PvaClientGet/b> connects to a single channel.
+
An instance of PvaClientGet connects to a single channel.
 PvaClientGet has both synchronous methods, which block, and non blocking methods.
 

 
PvaClientChannel has methods:

@@ -65,8 +65,8 @@ waitGet             waits until the server send a message that the get is comple
 getData             get the data.

-Note that issueConnect and issueGet do not block but all other methods -do block. +issueConnect and issueGet do not block. +All other methods can block.

diff --git a/documentation/htmldoxygen/pvaClientGetData.html b/documentation/htmldoxygen/pvaClientGetData.html index e0926d7..8625301 100644 --- a/documentation/htmldoxygen/pvaClientGetData.html +++ b/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. diff --git a/documentation/htmldoxygen/pvaClientMonitorData.html b/documentation/htmldoxygen/pvaClientMonitorData.html index 7ce7710..1b76f83 100644 --- a/documentation/htmldoxygen/pvaClientMonitorData.html +++ b/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. diff --git a/documentation/htmldoxygen/pvaClientProcess.html b/documentation/htmldoxygen/pvaClientProcess.html index 9b944f1..b1de4f2 100644 --- a/documentation/htmldoxygen/pvaClientProcess.html +++ b/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); ... }; -

An instance of PvaClientProcess/b> connects to a single channel. +

An instance of PvaClientProcess connects to a single channel. PvaClientProcess has both synchronous methods, which block, and non blocking methods.

PvaClientChannel has methods:

@@ -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.

-Note that issueConnect and issueProcess do not block but all other methods -do block. +issueConnect and issueProcess do not block. +All other methods can block.

diff --git a/documentation/htmldoxygen/pvaClientPutData.html b/documentation/htmldoxygen/pvaClientPutData.html index c4e2869..09cff35 100644 --- a/documentation/htmldoxygen/pvaClientPutData.html +++ b/documentation/htmldoxygen/pvaClientPutData.html @@ -36,11 +36,11 @@

PvaClientPutData

This class provides access to data to send to the server via a PvaChannelPut -It is created by PvaChannelPut or PvaChannelPutGet. -This the client only gets access to an instance by getting it from PvaChannelPut or PvaChannelPutGet. +It is created by PvaChannelPut or PvaChannelPutGet. +This the client only gets access to an instance by getting it from PvaChannelPut or PvaChannelPutGet.

Note also that for all field types except union the BitSet for the data is updated -by PvaChannelPut or PvaChannelPutGet whenever the client changes a field. +by PvaChannelPut or PvaChannelPutGet whenever the client changes a field. For a union or unionArray field the client must update the BitSet.

@@ -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. diff --git a/documentation/htmldoxygen/pvaClientPutGet.html b/documentation/htmldoxygen/pvaClientPutGet.html index d0d11d8..f0db3bf 100644 --- a/documentation/htmldoxygen/pvaClientPutGet.html +++ b/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); ... }; -

An instance of PvaClientPutGet/b> connects to a single channel. +

An instance of PvaClientPutGet connects to a single channel. PvaClientPutGet has both synchronous methods, which block, and non blocking methods.

PvaClientPutGet has methods:

@@ -75,7 +75,8 @@ getPutData get the put portion of the data. getGetData get the get portion of the data.

-Note that issueConnect, issuePutGet, issueGetGet and issueGetPut do not block but all other methods block. +issueConnect, issuePutGet, issueGetGet and issueGetPut do not block. +All other methods can block.

diff --git a/src/pv/pvaClient.h b/src/pv/pvaClient.h index f332019..cbb3b57 100644 --- a/src/pv/pvaClient.h +++ b/src/pv/pvaClient.h @@ -17,7 +17,6 @@ #include #include -#include #include #include #include diff --git a/src/pv/pvaClientMultiChannel.h b/src/pv/pvaClientMultiChannel.h index ffaff18..c58ad7a 100644 --- a/src/pv/pvaClientMultiChannel.h +++ b/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,