Javadoc corrections
This commit is contained in:
@@ -271,22 +271,22 @@ public:
|
||||
epics::pvData::PVStructurePtr getAlarm() const;
|
||||
|
||||
/**
|
||||
* Get the ranges field.
|
||||
* Returns the ranges field.
|
||||
* @return the ranges field.
|
||||
*/
|
||||
epics::pvData::PVDoubleArrayPtr getRanges() const;
|
||||
|
||||
/**
|
||||
* Get the value field.
|
||||
* Returns the value field.
|
||||
* @return the value field.
|
||||
*/
|
||||
epics::pvData::PVScalarArrayPtr getValue() const;
|
||||
|
||||
/**
|
||||
* Get the value field of a specified type (e.g. PVIntArray).
|
||||
* Returns the value field of a specified type (e.g. PVIntArray).
|
||||
* @tparam PVT the expected type of the value field which should be
|
||||
* be PVShortArray, PVIntArray pr PVLongArray.
|
||||
* @return the value field or null if it is not of the expected type..
|
||||
* @return the value field or null if it is not of the expected type.
|
||||
*/
|
||||
template<typename PVT>
|
||||
std::tr1::shared_ptr<PVT> getValue() const
|
||||
|
||||
@@ -290,13 +290,13 @@ public:
|
||||
epics::pvData::PVStructurePtr getDisplay() const;
|
||||
|
||||
/**
|
||||
* Get the value field.
|
||||
* Returns the value field.
|
||||
* @return the value field.
|
||||
*/
|
||||
epics::pvData::PVDoubleArrayPtr getValue() const;
|
||||
|
||||
/**
|
||||
* Get the dim field.
|
||||
* Returns the dim field.
|
||||
* @return the dim field or or null if no such field.
|
||||
*/
|
||||
epics::pvData::PVIntArrayPtr getDim() const;
|
||||
|
||||
@@ -348,7 +348,7 @@ public:
|
||||
|
||||
/**
|
||||
* Returns the field with the severity of each channel.
|
||||
* @return the severity field or null if no such field
|
||||
* @return the severity field or null if no such field.
|
||||
*/
|
||||
epics::pvData::PVIntArrayPtr getSeverity() const
|
||||
{return pvSeverity;}
|
||||
|
||||
@@ -260,49 +260,49 @@ public:
|
||||
|
||||
/**
|
||||
* Returns the value field.
|
||||
* @return The PVField for the values.
|
||||
* Returns the value field.
|
||||
*/
|
||||
epics::pvData::PVUnionPtr getValue() const;
|
||||
|
||||
/**
|
||||
* Returns the codec field.
|
||||
* @return the PVStructurePtr.
|
||||
* @return the codec field.
|
||||
*/
|
||||
epics::pvData::PVStructurePtr getCodec() const;
|
||||
|
||||
/**
|
||||
* Returns the compressedDataSize field.
|
||||
* @return PVStructurePtr.
|
||||
* @return the compressedDataSize field.
|
||||
*/
|
||||
epics::pvData::PVLongPtr getCompressedDataSize() const;
|
||||
|
||||
/**
|
||||
* Returns the uncompressedDataSize field.
|
||||
* @return PVStructurePtr.
|
||||
* @return the uncompressedDataSize field.
|
||||
*/
|
||||
epics::pvData::PVLongPtr getUncompressedDataSize() const;
|
||||
|
||||
/**
|
||||
* Returns the dimension field.
|
||||
* @return the PVStructurePtr.
|
||||
* @return the dimension field.
|
||||
*/
|
||||
epics::pvData::PVStructureArrayPtr getDimension() const;
|
||||
|
||||
/**
|
||||
* Returns the uniqueId field.
|
||||
* @return PVStructurePtr.
|
||||
* @return the uniqueId field.
|
||||
*/
|
||||
epics::pvData::PVIntPtr getUniqueId() const;
|
||||
|
||||
/**
|
||||
* Returns the data timeStamp field.
|
||||
* @return PVStructurePtr.
|
||||
* Returns the dataTimeStamp field.
|
||||
* @return the dataTimeStamp field.
|
||||
*/
|
||||
epics::pvData::PVStructurePtr getDataTimeStamp() const;
|
||||
|
||||
/**
|
||||
* Returns the attribute field.
|
||||
* @return the PVStructurePtr.
|
||||
* @return the attribute field.
|
||||
*/
|
||||
epics::pvData::PVStructureArrayPtr getAttribute() const;
|
||||
|
||||
|
||||
@@ -54,7 +54,7 @@ namespace detail {
|
||||
|
||||
/**
|
||||
* Sets the value type of the NTScalarArray.
|
||||
* @param elementType the value array element type.
|
||||
* @param elementType the value field element ScalarType.
|
||||
* @return this instance of <b>NTScalarArrayBuilder</b>.
|
||||
* @deprecated use value instead.
|
||||
*/
|
||||
|
||||
@@ -250,7 +250,7 @@ public:
|
||||
|
||||
/**
|
||||
* Returns the authority field.
|
||||
* @return the authority field if no such field.
|
||||
* @return the authority field or null if no such field.
|
||||
*/
|
||||
epics::pvData::PVStringPtr getAuthority() const;
|
||||
|
||||
@@ -262,7 +262,7 @@ public:
|
||||
|
||||
/**
|
||||
* Returns the query field.
|
||||
* @return the query field if no such field.
|
||||
* @return the query field or null if no such field.
|
||||
*/
|
||||
epics::pvData::PVStructurePtr getQuery() const;
|
||||
|
||||
@@ -285,7 +285,7 @@ public:
|
||||
* Returns the subfield of the query field (parameter) with the specified
|
||||
* name and of a specified expected type (for example, PVString).
|
||||
* @tparam PVT the expected type of the subfield which should be
|
||||
* be PVStringArray, PVIntArray pr PVDoubleArray.
|
||||
* be PVString, PVInt pr PVDouble.
|
||||
* @param name the subfield of the query field or null if the field does
|
||||
* not exist or is not of the expected type.
|
||||
* @return The PVT field.
|
||||
|
||||
Reference in New Issue
Block a user