Merge pull request #93 from MasFlam/develop

ludocode · web-flow · commit c7e7d6399201 · 2022-03-04T22:08:43.000-05:00
Fix doc comments for mpack_node_data{,_len}()
diff --git a/src/mpack/mpack-node.h b/src/mpack/mpack-node.h
@@ -985,7 +985,7 @@ size_t mpack_node_bin_size(mpack_node_t node);
  *
  * This returns zero if the tree is in an error state.
  *
- * If this node is not a str, bin or map, @ref mpack_error_type is raised and zero
+ * If this node is not a str, bin or ext, @ref mpack_error_type is raised and zero
  * is returned.
  */
 uint32_t mpack_node_data_len(mpack_node_t node);
@@ -1025,7 +1025,7 @@ const char* mpack_node_str(mpack_node_t node);
  *
  * The pointer is valid as long as the data backing the tree is valid.
  *
- * If this node is not of a str, bin or map, @ref mpack_error_type is raised, and
+ * If this node is not of a str, bin or ext, @ref mpack_error_type is raised, and
  * @c NULL is returned.
  *
  * @see mpack_node_copy_cstr()

Original file line number	Diff line number	Diff line change
`@@ -985,7 +985,7 @@ size_t mpack_node_bin_size(mpack_node_t node);`
`985`	`985`	`*`
`986`	`986`	`* This returns zero if the tree is in an error state.`
`987`	`987`	`*`
`988`		`- * If this node is not a str, bin or map, @ref mpack_error_type is raised and zero`
	`988`	`+ * If this node is not a str, bin or ext, @ref mpack_error_type is raised and zero`
`989`	`989`	`* is returned.`
`990`	`990`	`*/`
`991`	`991`	`uint32_t mpack_node_data_len(mpack_node_t node);`
`@@ -1025,7 +1025,7 @@ const char* mpack_node_str(mpack_node_t node);`
`1025`	`1025`	`*`
`1026`	`1026`	`* The pointer is valid as long as the data backing the tree is valid.`
`1027`	`1027`	`*`
`1028`		`- * If this node is not of a str, bin or map, @ref mpack_error_type is raised, and`
	`1028`	`+ * If this node is not of a str, bin or ext, @ref mpack_error_type is raised, and`
`1029`	`1029`	`* @c NULL is returned.`
`1030`	`1030`	`*`
`1031`	`1031`	`* @see mpack_node_copy_cstr()`