unified parsing of numeric values, documentation

This commit is contained in:
john30
2014-11-20 22:24:21 +01:00
parent 0283b0e121
commit 15cbb9bbd9
2 changed files with 51 additions and 44 deletions
+2 -2
View File
@@ -88,11 +88,11 @@ public:
* @brief Factory method for creating new instances.
* @param it the iterator to traverse for the definition parts.
* @param end the iterator pointing to the end of the definition parts.
* @param templates a map of DataField templates to be referenced by name.
* @param templates a map of @a DataField templates to be referenced by name.
* @param returnField the variable in which to store the created instance.
* @param isSetMessage whether the field is part of a set message (default false).
* @param dstAddress the destination bus address (default @a SYN for creating a template @a DataField).
* @return @a RESULT_OK on success, @a RESULT_ERR_EOF if the iterator is empty, or an error code.
* @return @a RESULT_OK on success, or an error code.
* Note: the caller needs to free the created instance.
*/
static result_t create(std::vector<std::string>::iterator& it, const std::vector<std::string>::iterator end,