changes for doxygen

This commit is contained in:
Marty Kraimer
2014-12-12 09:28:49 -05:00
parent 3344165f19
commit ec44251df0
6 changed files with 1826 additions and 729 deletions

View File

@@ -56,7 +56,8 @@ class PVDatabase;
typedef std::tr1::shared_ptr<PVDatabase> PVDatabasePtr;
/**
* Base interface for a record.
* @brief Base interface for a record.
*
* @author mrk
*/
class epicsShareClass PVRecord :
@@ -235,7 +236,8 @@ private:
epicsShareExtern std::ostream& operator<<(std::ostream& o, const PVRecord& record);
/**
* Interface for a field of a record.
* @brief Interface for a field of a record.
*
* One exists for each field of the top level PVStructure.
* @author mrk
*/
@@ -330,7 +332,8 @@ private:
};
/**
* Interface for a field that is a structure.
* @brief Interface for a field that is a structure.
*
* One exists for each structure field of the top level PVStructure.
* @author mrk
*/
@@ -386,7 +389,8 @@ private:
};
/**
* An interface that must be implemented by any code that accesses the record.
* @brief An interface implemented by code that accesses the record.
*
* @author mrk
*/
class epicsShareClass PVRecordClient {
@@ -404,6 +408,8 @@ public:
};
/**
* @brief Listener for PVRecord::message.
*
* An interface that is implemented by code that traps calls to PVRecord::message.
* @author mrk
*/
@@ -448,7 +454,8 @@ public:
};
/**
* The interface to a database of PVRecords.
* @brief The interface for a database of PVRecords.
*
* @author mrk
*/
class epicsShareClass PVDatabase {
@@ -503,3 +510,10 @@ private:
}}
#endif /* PVDATABASE_H */
/** @page Overview Documentation
*
* <a href = "pvDatabaseCPP.html">pvDatabase.html</a>
*
*/