update doc

This commit is contained in:
Michael Davidsaver
2018-10-18 16:43:56 -07:00
parent fb546b41c1
commit f54602dead
9 changed files with 76 additions and 27 deletions
+3
View File
@@ -52,6 +52,7 @@ struct epicsShareClass JSONPrintOptions
/** Print PVStructure as JSON
*
* 'mask' selects those fields which will be printed.
* @version Overload added after 7.0.0
*/
epicsShareFunc
void printJSON(std::ostream& strm,
@@ -60,6 +61,7 @@ void printJSON(std::ostream& strm,
const JSONPrintOptions& opts = JSONPrintOptions());
/** Print PVField as JSON
* @version Overload added after 7.0.0
*/
epicsShareFunc
void printJSON(std::ostream& strm,
@@ -97,6 +99,7 @@ PVStructure::shared_pointer parseJSON(std::istream& strm);
* @param dest Store in fields of this structure
* @param assigned Which fields of _dest_ were assigned. (Optional)
* @throws std::runtime_error on failure. dest and assigned may be modified.
* @version Overload added after 7.0.0
*/
epicsShareFunc
void parseJSON(std::istream& strm,
+3 -1
View File
@@ -117,6 +117,7 @@ public:
//! Construct from un-typed pointer.
//! Caller is responsible to ensure that buf actually points to the provided type
//! @version Added after 7.0.0
AnyScalar(ScalarType type, const void *buf);
AnyScalar(const AnyScalar& o);
@@ -147,7 +148,7 @@ public:
#endif
//! Reset internal state.
//! Added after 7.0.0
//! @version Added after 7.0.0
//! @post empty()==true
void clear();
@@ -174,6 +175,7 @@ public:
//! Provide read-only access to underlying buffer.
//! For a string this is std::string::c_str().
//! @version Added after 7.0.0
const void* bufferUnsafe() const;
/** Return typed reference to wrapped value. Non-const reference allows value modification
+2
View File
@@ -50,6 +50,8 @@ namespace epics { namespace pvData {
* synchronization.
*
* Based on Java implementation.
*
* @since 7.0.0 Many methods return BitSet& to facilite method chaining.
*/
class epicsShareClass BitSet : public Serializable {
public:
+32
View File
@@ -5,6 +5,38 @@
#ifndef REFTRACK_H
#define REFTRACK_H
/** @page pvd_reftrack RefTrack
*
* reftrack.h is a utility for listing, finding, and reading global atomic counters.
* By convention used to expose object instance counters as a way of detecting (slow)
* reference/resource leaks before they cause problems.
*
* cf. the IOC shell commands "refshow", "refsave", and "refdiff".
*
* Example usage:
*
* @code
* // my header.h
* struct MyClass {
* MyClass();
* ~MyClass();
* static size_t num_instances;
* ...
* };
* ...
* // my src.cpp
* size_t MyClass::num_instances;
* MyClass::MyClass() {
* REFTRACE_INCREMENT(num_instances);
* }
* MyClass::~MyClass() {
* REFTRACE_DECREMENT(num_instances);
* }
* // in some IOC registrar or global ctor
* registerRefCounter("MyClass", &MyClass::num_instances);
* @endcode
*/
#ifdef __cplusplus
#include <map>
+2 -2
View File
@@ -201,7 +201,8 @@ inline std::ostream& operator<<(std::ostream& strm, const ::detail::ref_shower<T
typedef std::tr1::weak_ptr<clazz> weak_pointer; \
typedef std::tr1::weak_ptr<const clazz> const_weak_pointer
/* A semi-hack to help with migration from std::auto_ptr to std::unique_ptr,
namespace epics{
/** A semi-hack to help with migration from std::auto_ptr to std::unique_ptr,
* and avoid copious deprecation warning spam
* which may be hiding legitimate issues.
*
@@ -214,7 +215,6 @@ inline std::ostream& operator<<(std::ostream& strm, const ::detail::ref_shower<T
* copy/assignment/return are not supported
* (use auto_ptr or unique_ptr explicitly).
*/
namespace epics{
#if __cplusplus>=201103L
template<typename T>
using auto_ptr = std::unique_ptr<T>;
-6
View File
@@ -1659,9 +1659,3 @@ namespace std{
}
#endif /* PVDATA_H */
/** @page Overview Documentation
*
* <a href = "pvDataCPP.html">pvData.html</a>
*
*/
+8
View File
@@ -349,6 +349,7 @@ public:
virtual std::ostream& dump(std::ostream& o) const = 0;
//! Allocate a new instance
//! @version Added after 7.0.0
std::tr1::shared_ptr<PVField> build() const;
protected:
@@ -399,6 +400,7 @@ public:
virtual void deserialize(ByteBuffer *buffer, DeserializableControl *control) OVERRIDE FINAL;
//! Allocate a new instance
//! @version Added after 7.0.0
std::tr1::shared_ptr<PVScalar> build() const;
protected:
@@ -507,6 +509,7 @@ public:
virtual void deserialize(ByteBuffer *buffer, DeserializableControl *control) OVERRIDE FINAL;
//! Allocate a new instance
//! @version Added after 7.0.0
std::tr1::shared_ptr<PVScalarArray> build() const;
virtual ~ScalarArray();
@@ -611,6 +614,7 @@ public:
virtual void deserialize(ByteBuffer *buffer, DeserializableControl *control) OVERRIDE FINAL;
//! Allocate a new instance
//! @version Added after 7.0.0
std::tr1::shared_ptr<PVValueArray<std::tr1::shared_ptr<PVStructure> > > build() const;
protected:
@@ -655,6 +659,7 @@ public:
virtual void deserialize(ByteBuffer *buffer, DeserializableControl *control) OVERRIDE FINAL;
//! Allocate a new instance
//! @version Added after 7.0.0
std::tr1::shared_ptr<PVValueArray<std::tr1::shared_ptr<PVUnion> > > build() const;
protected:
@@ -766,6 +771,7 @@ public:
virtual void deserialize(ByteBuffer *buffer, DeserializableControl *control) OVERRIDE FINAL;
//! Allocate a new instance
//! @version Added after 7.0.0
std::tr1::shared_ptr<PVStructure> build() const;
protected:
@@ -904,6 +910,7 @@ public:
virtual void deserialize(ByteBuffer *buffer, DeserializableControl *control) OVERRIDE FINAL;
//! Allocate a new instance
//! @version Added after 7.0.0
std::tr1::shared_ptr<PVUnion> build() const;
protected:
@@ -939,6 +946,7 @@ class epicsShareClass FieldBuilder :
{
public:
//! Create a new instance of in-line @c Field builder.
//! @version Added after 7.0.0
static FieldBuilderPtr begin();
//! Create a new instance of in-line @c Field builder pre-initialized with and existing Structure
static FieldBuilderPtr begin(StructureConstPtr S);