changes for doxygen
This commit is contained in:
@@ -57,7 +57,9 @@ typedef std::tr1::shared_ptr<ChannelLocal> ChannelLocalPtr;
|
||||
|
||||
epicsShareExtern MonitorFactoryPtr getMonitorFactory();
|
||||
|
||||
/** MonitorFactory
|
||||
/**
|
||||
* @brief MonitorFactory
|
||||
*
|
||||
* This class provides a static method to create a monitor for a PVRecord
|
||||
*/
|
||||
class epicsShareClass MonitorFactory
|
||||
@@ -99,6 +101,8 @@ private:
|
||||
epicsShareExtern ChannelProviderLocalPtr getChannelProviderLocal();
|
||||
|
||||
/**
|
||||
* @brief ChannelProvider for PVDatabase.
|
||||
*
|
||||
* An implementation of channelProvider that provides access to records in PVDatabase.
|
||||
*/
|
||||
class epicsShareClass ChannelProviderLocal :
|
||||
@@ -191,6 +195,8 @@ private:
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief Channel for accessing a PVRecord.
|
||||
*
|
||||
* A Channel for accessing a record in the PVDatabase.
|
||||
* It is a complete implementation of Channel
|
||||
*/
|
||||
|
||||
@@ -46,7 +46,8 @@ typedef std::tr1::shared_ptr<PVCopyMonitorFieldNode> PVCopyMonitorFieldNodePtr;
|
||||
|
||||
|
||||
/**
|
||||
* PVCopyMonitor
|
||||
* @brief Monitor changes to a PVRecord.
|
||||
*
|
||||
* This class manages changes to fields being monitored in a PVRecord.
|
||||
*/
|
||||
class epicsShareClass PVCopyMonitor :
|
||||
@@ -154,12 +155,31 @@ private:
|
||||
std::list<PVCopyMonitorFieldNodePtr> monitorFieldNodeList;
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief Class implemented by monitorFactory
|
||||
*
|
||||
* This is not of interest to users.
|
||||
* It is for communication between monitorfactory and pvCopyMonitor.
|
||||
*
|
||||
*/
|
||||
class epicsShareClass PVCopyMonitorRequester
|
||||
{
|
||||
public:
|
||||
POINTER_DEFINITIONS(PVCopyMonitorRequester);
|
||||
/**
|
||||
*
|
||||
* Destructor
|
||||
*/
|
||||
virtual ~PVCopyMonitorRequester() {}
|
||||
/**
|
||||
* Release active element and return a new element.
|
||||
* @return new element to use.
|
||||
*/
|
||||
virtual epics::pvData::MonitorElementPtr releaseActiveElement() = 0;
|
||||
/**
|
||||
*
|
||||
* stop listening for changes.
|
||||
*/
|
||||
virtual void unlisten() = 0;
|
||||
};
|
||||
|
||||
|
||||
Reference in New Issue
Block a user