From 8008823ea5d3ea28944e1bfe87ed941e5b08f6cf Mon Sep 17 00:00:00 2001 From: Dave Hickin Date: Wed, 14 Oct 2015 23:01:28 +0100 Subject: [PATCH] Fix doxygen warnings --- src/copy/createRequest.h | 1 - src/copy/pvCopy.h | 6 +++--- src/misc/byteBuffer.h | 14 +++++++------- src/misc/serialize.h | 3 +-- src/misc/timer.h | 2 +- src/monitor/monitorPlugin.h | 3 --- src/property/timeStamp.h | 4 ++-- src/pv/convert.h | 4 ++-- src/pv/pvData.h | 34 ++++++++++++++++------------------ src/pv/pvIntrospect.h | 34 ++++++++++++++++------------------ src/pv/pvSubArrayCopy.h | 6 +++--- src/pv/standardField.h | 8 ++++---- src/pv/standardPVField.h | 6 +++--- 13 files changed, 58 insertions(+), 67 deletions(-) diff --git a/src/copy/createRequest.h b/src/copy/createRequest.h index 0cab001..bc79de9 100644 --- a/src/copy/createRequest.h +++ b/src/copy/createRequest.h @@ -38,7 +38,6 @@ class epicsShareClass CreateRequest { * Create a request structure for the create calls in Channel. * See the package overview documentation for details. * @param request The field request. See the package overview documentation for details. - * @param requester The requester; * @return The request PVStructure if a valid request was given. * If a NULL PVStructure is returned then getMessage will return * the reason. diff --git a/src/copy/pvCopy.h b/src/copy/pvCopy.h index 6da7945..084bcf9 100644 --- a/src/copy/pvCopy.h +++ b/src/copy/pvCopy.h @@ -116,8 +116,8 @@ public: PVStructurePtr const &masterPVStructure, PVFieldPtr const &masterPVField); /** - * Given a offset in the copy get the corresponding field in pvMaster. - * @param offset The offset in the copy. + * Given an offset in the copy get the corresponding field in pvMaster. + * @param structureOffset The offset in the copy. */ PVFieldPtr getMasterPVField(std::size_t structureOffset); /** @@ -159,7 +159,7 @@ public: BitSetPtr const &bitSet); /** * Get the options for the field at the specified offset. - * @param offset the offset in copy. + * @param fieldOffset the offset in copy. * @returns A NULL is returned if no options were specified for the field. * If options were specified,PVStructurePtr is a structures * with a set of PVString subfields that specify name,value pairs.s diff --git a/src/misc/byteBuffer.h b/src/misc/byteBuffer.h index 16d314d..087a8c5 100644 --- a/src/misc/byteBuffer.h +++ b/src/misc/byteBuffer.h @@ -399,9 +399,9 @@ public: * Put a sub-array of bytes into the byte buffer. * The position is increased by the count. * - * @param src The source array. - * @param offset The starting position within src. - * @param count The number of bytes to put into the byte buffer, + * @param src The source array. + * @param src_offset The starting position within src. + * @param count The number of bytes to put into the byte buffer, */ inline void put(const char* src, std::size_t src_offset, std::size_t count) { //if(count>getRemaining()) THROW_BASE_EXCEPTION("buffer overflow"); @@ -412,9 +412,9 @@ public: * Get a sub-array of bytes from the byte buffer. * The position is increased by the count. * - * @param dest The destination array. - * @param offset The starting position within src. - * @param count The number of bytes to put into the byte buffer, + * @param dest The destination array. + * @param dest_offset The starting position within src. + * @param count The number of bytes to put into the byte buffer. */ inline void get(char* dest, std::size_t dest_offset, std::size_t count) { //if(count>getRemaining()) THROW_BASE_EXCEPTION("buffer overflow"); @@ -637,7 +637,7 @@ public: /** * Get a boolean value from the byte buffer at the specified index. * - * @param double The offset in the byte buffer. + * @param index The offset in the byte buffer. * @return The value. */ inline double getDouble (std::size_t index) { return get(index); } diff --git a/src/misc/serialize.h b/src/misc/serialize.h index 2c45a6e..db70a0d 100644 --- a/src/misc/serialize.h +++ b/src/misc/serialize.h @@ -118,7 +118,6 @@ namespace epics { namespace pvData { std::size_t elementSize) = 0; /** * deserialize via cache - * @param field instance to be deserialized * @param buffer buffer to be deserialized from */ virtual std::tr1::shared_ptr cachedDeserialize( @@ -196,7 +195,7 @@ namespace epics { namespace pvData { * Serialize field into given buffer. * @param buffer serialization buffer. * @param flusher flush interface. - * ¶m offset offset in elements. + * @param offset offset in elements. * @param count number of elements */ virtual void serialize( diff --git a/src/misc/timer.h b/src/misc/timer.h index 9c1fc47..369519c 100644 --- a/src/misc/timer.h +++ b/src/misc/timer.h @@ -115,7 +115,7 @@ public: bool isScheduled(TimerCallbackPtr const &timerCallback); /** * show the elements in the timer queue. - * @parm o The output stream for the output + * @param o The output stream for the output */ void dump(std::ostream& o); diff --git a/src/monitor/monitorPlugin.h b/src/monitor/monitorPlugin.h index 963767a..544e262 100644 --- a/src/monitor/monitorPlugin.h +++ b/src/monitor/monitorPlugin.h @@ -66,9 +66,6 @@ public: MonitorElementPtr const &monitorElement) = 0; /** * A monitor will be sent to the client. - * @param pvField The copy of the field being monitored. - * The plugin can modify the data. - * @param pvTop The top-level structure in which the field resides. * @param monitorElement The data for the client. * The plugin is allowed to change the data values. */ diff --git a/src/property/timeStamp.h b/src/property/timeStamp.h index 3696229..2f018f9 100644 --- a/src/property/timeStamp.h +++ b/src/property/timeStamp.h @@ -107,7 +107,7 @@ public: int32 getUserTag() const {return userTag;} /** * Set userTag. - * @param useTag application specific. + * @param userTag application specific. */ void setUserTag(int userTag) {this->userTag = userTag;} /** @@ -162,7 +162,7 @@ public: /** * Return a-b as a double value with units of seconds. * @param a first timeStamp - * @param n second timeStamp + * @param b second timeStamp * @return time difference in seconds. */ static double diff(TimeStamp const & a,TimeStamp const & b); diff --git a/src/pv/convert.h b/src/pv/convert.h index b497caa..39a2827 100644 --- a/src/pv/convert.h +++ b/src/pv/convert.h @@ -57,7 +57,7 @@ public: * @param from The source. * @param to The destination * @throws std::invalid_argument if the arguments are not compatible. - * @DEPRECATED use "to->copy[Unchecked](*from)" instead + * @deprecated use "to->copy[Unchecked](*from)" instead */ void copy(PVFieldPtr const & from, PVFieldPtr const & to) { to->copy(*from); @@ -144,7 +144,7 @@ public: StringArray & to, std::size_t toOffset); /** - * Convert a PV to a . + * Convert a PV to a byte. * @param pv a PV * @return converted value */ diff --git a/src/pv/pvData.h b/src/pv/pvData.h index 73f0851..1546a07 100644 --- a/src/pv/pvData.h +++ b/src/pv/pvData.h @@ -363,7 +363,7 @@ public: virtual T get() const = 0; /** * Put a new value into the PVScalar. - * @param The value. + * @param value The value. */ virtual void put(T value) = 0; @@ -515,7 +515,7 @@ public: virtual std::size_t getLength() const = 0; /** * Set the array length. - * @param The length. + * @param length The length. */ virtual void setLength(std::size_t length) = 0; /** @@ -535,7 +535,7 @@ public: void setCapacityMutable(bool isMutable); /** * Set the array capacity. - * @param The capacity. + * @param capacity The capacity. */ virtual void setCapacity(std::size_t capacity) = 0; @@ -931,7 +931,7 @@ public: * Select field (set index) and get the field at the index. * @param index index of the field to select. * @return corresponding PVField (of undetermined value), {@code null} if {@code index == UNDEFINED_INDEX}. - * @throws {@code std::invalid_argument} if index is invalid (out of range). + * @throws std::invalid_argument if index is invalid (out of range). */ PVFieldPtr select(int32 index); @@ -944,7 +944,7 @@ public: * Select field (set index) and get the field by given name. * @param fieldName the name of the field to select. * @return corresponding PVField (of undetermined value). - * @throws {@code std::invalid_argument} if field does not exist. + * @throws std::invalid_argument if field does not exist. */ PVFieldPtr select(std::string const & fieldName); @@ -974,19 +974,19 @@ public: /** * Set the {@code PVField} (by reference!) as field at given index. * If a value is not a valid union field an {@code std::invalid_argument} exception is thrown. - * Use {@code select(int)} to put by value. + * Use {@code select(int32)} to put by value. * @param index index of a field to put. * @param value the field to set. - * @see #select(int) + * @see #select(int32) */ void set(int32 index, PVFieldPtr const & value); /** * Set the {@code PVField} (by reference!) as field by given name. * If a value is not a valid union field an {@code std::invalid_argument} exception is thrown. - * Use {@code select(std::string)} to put by value. + * Use {@code select(std::string const &)} to put by value. * @param fieldName Name of the field to put. * @param value the field to set. - * @see #select(std::string) + * @see #select(std::string const &) */ void set(std::string const & fieldName, PVFieldPtr const & value); @@ -1447,7 +1447,7 @@ public: PVScalarPtr createPVScalar(ScalarConstPtr const & scalar); /** * Create an implementation of a scalar field. A Scalar introspection interface is created. - * @param fieldType The field type. + * @param scalarType The scalar type. * @return The PVScalar implementation. */ PVScalarPtr createPVScalar(ScalarType scalarType); @@ -1460,7 +1460,7 @@ public: PVScalarPtr createPVScalar(PVScalarPtr const & scalarToClone); /** * template version - * @param PVT must be a valid pvType + * @tparam PVT must be a valid PVType * @return The PVScalar implementation. */ template @@ -1492,7 +1492,7 @@ public: /** * Create implementation for PVUnion. - * @param union The introspection interface. + * @param punion The introspection interface. * @return The PVUnion implementation */ PVUnionPtr createPVUnion(UnionConstPtr const & punion); @@ -1510,13 +1510,12 @@ public: /** * Create an implementation of an array field reusing the Array introspection interface. - * @param array The introspection interface. + * @param scalarArray The introspection interface. * @return The PVScalarArray implementation. */ PVScalarArrayPtr createPVScalarArray(ScalarArrayConstPtr const & scalarArray); /** * Create an implementation for an array field. An Array introspection interface is created. - * @param parent The parent interface. * @param elementType The element type. * @return The PVScalarArray implementation. */ @@ -1524,13 +1523,13 @@ public: /** * Create an implementation of an array field by cloning an existing PVArray. * The new PVArray will have the same value and auxInfo as the original. - * @param arrayToClone The PVScalarArray to clone. + * @param scalarArrayToClone The PVScalarArray to clone. * @return The PVScalarArray implementation. */ PVScalarArrayPtr createPVScalarArray(PVScalarArrayPtr const & scalarArrayToClone); /** * template version - * @param PVT must be a valid pvType + * @tparam PVT must be a valid pvType * @return The PVScalarArray implementation. */ template @@ -1587,9 +1586,8 @@ private: /** * Get the single class that implements PVDataCreate - * @param The PVDataCreate factory. + * @return The PVDataCreate factory. */ - epicsShareExtern PVDataCreatePtr getPVDataCreate(); bool epicsShareExtern operator==(const PVField&, const PVField&); diff --git a/src/pv/pvIntrospect.h b/src/pv/pvIntrospect.h index aaa8029..eb12dcc 100644 --- a/src/pv/pvIntrospect.h +++ b/src/pv/pvIntrospect.h @@ -318,7 +318,7 @@ public: protected: /** * Constructor - * @param fieldName The field type. + * @param type The field type. */ Field(Type type); private: @@ -433,7 +433,7 @@ public: protected: /** * Constructor - * @param fieldName The field type. + * @param type The field type. */ Array(Type type); @@ -626,7 +626,7 @@ public: protected: /** * Constructor. - * @param union The introspection interface for the elements. + * @param _punion The introspection interface for the elements. */ UnionArray(UnionConstPtr const & _punion); /** @@ -689,7 +689,7 @@ public: /** * Get the field for the specified fieldName. - * @param fieldName The index of the field to get; + * @param index The index of the field to get; * @return The introspection interface. * This will hold a null pointer if the field is not in the structure. */ @@ -810,7 +810,7 @@ public: /** * Get the field for the specified fieldName. - * @param fieldName The index of the field to get; + * @param index The index of the field to get; * @return The introspection interface. * This will hold a null pointer if the field is not in the union. */ @@ -952,7 +952,7 @@ public: /** * Add array of {@code Field} elements. * @param name name of the array. - * @param field a type of an array element. + * @param element a type of an array element. * @return this instance of a {@code FieldBuilder}. */ FieldBuilderPtr addArray(std::string const & name, FieldConstPtr const & element); @@ -1013,8 +1013,8 @@ public: /** * Complete the creation of a nested object. - * @see #addNestedStructure(std::string) - * @see #addNestedUnion(std::string) + * @see #addNestedStructure(std::string const & name) + * @see #addNestedUnion(std::string const & name) * @return a previous (parent) {@code FieldBuilder}. */ FieldBuilderPtr endNested(); @@ -1062,14 +1062,14 @@ public: * Create a {@code ScalarField}. * @param scalarType The scalar type. * @return a {@code Scalar} interface for the newly created object. - * @throws An {@code IllegalArgumentException} if an illegal type is specified. + * @throws IllegalArgumentException if an illegal type is specified. */ ScalarConstPtr createScalar(ScalarType scalarType) const; /** * Create a {@code BoundedString}. * @param maxLength a string maximum length. * @return a {@code BoundedString} interface for the newly created object. - * @throws An {@code IllegalArgumentException} if maxLength == 0. + * @throws IllegalArgumentException if maxLength == 0. */ BoundedStringConstPtr createBoundedString(std::size_t maxLength) const; /** @@ -1088,14 +1088,13 @@ public: /** * Create an {@code Array} field, bounded size array. * @param elementType The {@code scalarType} for array elements - * @param size Array maximum capacity (bound). + * @param bound Array maximum capacity. * @return An {@code Array} Interface for the newly created object. */ ScalarArrayConstPtr createBoundedScalarArray(ScalarType elementType, std::size_t bound) const; /** * Create an {@code Array} field that is has element type Structure - * @param fieldName The field name - * @param elementStructure The {@code Structure} for each array element. + * @param structure The {@code Structure} for each array element. * @return An {@code Array} Interface for the newly created object. */ StructureArrayConstPtr createStructureArray(StructureConstPtr const & structure) const; @@ -1126,8 +1125,7 @@ public: FieldConstPtrArray const & fields) const; /** * Create an {@code Array} field that is has element type Union - * @param fieldName The field name - * @param elementUnion The {@code Union} for each array element. + * @param punion The {@code Union} for each array element. * @return An {@code Array} Interface for the newly created object. */ UnionArrayConstPtr createUnionArray(UnionConstPtr const & punion) const; @@ -1174,8 +1172,8 @@ public: /** * Append fields to a structure. * @param structure The structure to which the fields appended. - * @param fieldName The names of the fields. - * @param field The fields. + * @param fieldNames The names of the fields. + * @param fields The fields. * @return a {@code Structure} interface for the newly created object. */ StructureConstPtr appendFields( @@ -1201,7 +1199,7 @@ private: /** * Get the single class that implements FieldCreate, - * @param The fieldCreate factory. + * @return The fieldCreate factory. */ epicsShareExtern FieldCreatePtr getFieldCreate(); diff --git a/src/pv/pvSubArrayCopy.h b/src/pv/pvSubArrayCopy.h index 04de8b6..eb3e2f3 100644 --- a/src/pv/pvSubArrayCopy.h +++ b/src/pv/pvSubArrayCopy.h @@ -71,7 +71,7 @@ epicsShareExtern void copy( PVStructureArray & pvFrom, size_t fromOffset, size_t fromStride, - PVStructureArray & pvToo, + PVStructureArray & pvTo, size_t toOffset, size_t toStride, size_t count); @@ -91,7 +91,7 @@ epicsShareExtern void copy( PVArray & pvFrom, size_t fromOffset, size_t fromStride, - PVArray & pvToo, + PVArray & pvTo, size_t toOffset, size_t toStride, size_t count); @@ -111,7 +111,7 @@ epicsShareExtern void copy( PVArray::shared_pointer const & pvFrom, size_t fromOffset, size_t fromStride, - PVArray::shared_pointer & pvToo, + PVArray::shared_pointer & pvTo, size_t toOffset, size_t toStride, size_t count); diff --git a/src/pv/standardField.h b/src/pv/standardField.h index 3388aac..0c2e669 100644 --- a/src/pv/standardField.h +++ b/src/pv/standardField.h @@ -93,14 +93,14 @@ public: */ StructureConstPtr variantUnion(std::string const & properties); /** Create a structure that has a scalarArray value field. - * @param type The type. + * @param elementType The element type. * @param properties A comma separated list of properties. * This is some combination of "alarm,timeStamp,display,control,valueAlarm". * @return The const shared pointer to the structure. */ StructureConstPtr scalarArray(ScalarType elementType, std::string const & properties); /** Create a structure that has a structureArray value field. - * @param type The type. + * @param structure The Structure introspection object for elements of the value field. * @param properties A comma separated list of properties. * This is some combination of "alarm,timeStamp,display,control,valueAlarm". * @return The const shared pointer to the structure. @@ -109,7 +109,7 @@ public: StructureConstPtr const & structure, std::string const & properties); /** Create a structure that has a unionArray value field. - * @param type The type. + * @param punion The Union introspection object for elements of the value field. * @param properties A comma separated list of properties. * This is some combination of "alarm,timeStamp,display,control". * @return The const shared pointer to the structure. @@ -118,7 +118,7 @@ public: UnionConstPtr const & punion, std::string const & properties); /** Create a structure that has an enumerated structure value field. - * The id for the structure is "enum-t". + * The id for the structure is "enum_t". * @return The const shared pointer to the structure. */ StructureConstPtr enumerated(); diff --git a/src/pv/standardPVField.h b/src/pv/standardPVField.h index 48c2542..aa68d14 100644 --- a/src/pv/standardPVField.h +++ b/src/pv/standardPVField.h @@ -54,7 +54,7 @@ public: PVStructurePtr scalar(ScalarType type,std::string const & properties); /** * Create a structure that has a scalar array value field. - * @param type The type. + * @param elementType The element scalar type. * @param properties A comma separated list of properties. * This is some combination of "alarm,timeStamp,display,control,valueAlarm". * @return The const shared pointer to the structure. @@ -62,7 +62,7 @@ public: PVStructurePtr scalarArray(ScalarType elementType, std::string const & properties); /** * Create a structure that has a structure array value field. - * @param type The type. + * @param structure The Structure introspection object for elements of the value field. * @param properties A comma separated list of properties. * This is some combination of "alarm,timeStamp,display,control,valueAlarm". * @return The const shared pointer to the structure. @@ -70,7 +70,7 @@ public: PVStructurePtr structureArray(StructureConstPtr const &structure,std::string const & properties); /** * Create a structure that has a union array value field. - * @param type The type. + * @param punion The Union introspection object for elements of the value field. * @param properties A comma separated list of properties. * This is some combination of "alarm,timeStamp,display,control,valueAlarm". * @return The const shared pointer to the structure.