Skip to content

Commit 8970403

Browse files
committed
minor doc fix, for open-source-parsers#302
1 parent 6ca8ffc commit 8970403

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

include/json/value.h

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ Json::Value obj_value(Json::objectValue); // {}
255255
#endif // if defined(JSON_HAS_INT64)
256256
Value(double value);
257257
Value(const char* value); ///< Copy til first 0. (NULL causes to seg-fault.)
258-
Value(const char* beginValue, const char* endValue); ///< Copy all, incl zeroes.
258+
Value(const char* begin, const char* end); ///< Copy all, incl zeroes.
259259
/** \brief Constructs a value from a static string.
260260
261261
* Like other value string constructor but do not duplicate the string for
@@ -306,7 +306,7 @@ Json::Value obj_value(Json::objectValue); // {}
306306
* \return false if !string. (Seg-fault if str or end are NULL.)
307307
*/
308308
bool getString(
309-
char const** str, char const** end) const;
309+
char const** begin, char const** end) const;
310310
#ifdef JSON_USE_CPPTL
311311
CppTL::ConstString asConstString() const;
312312
#endif
@@ -435,8 +435,8 @@ Json::Value obj_value(Json::objectValue); // {}
435435
Value get(const char* key, const Value& defaultValue) const;
436436
/// Return the member named key if it exist, defaultValue otherwise.
437437
/// \note deep copy
438-
/// \param key may contain embedded nulls.
439-
Value get(const char* key, const char* end, const Value& defaultValue) const;
438+
/// \note key may contain embedded nulls.
439+
Value get(const char* begin, const char* end, const Value& defaultValue) const;
440440
/// Return the member named key if it exist, defaultValue otherwise.
441441
/// \note deep copy
442442
/// \param key may contain embedded nulls.
@@ -448,12 +448,12 @@ Json::Value obj_value(Json::objectValue); // {}
448448
#endif
449449
/// Most general and efficient version of isMember()const, get()const,
450450
/// and operator[]const
451-
/// \note As stated elsewhere, behavior is undefined if (end-key) >= 2^30
452-
Value const* find(char const* key, char const* end) const;
451+
/// \note As stated elsewhere, behavior is undefined if (end-begin) >= 2^30
452+
Value const* find(char const* begin, char const* end) const;
453453
/// Most general and efficient version of object-mutators.
454-
/// \note As stated elsewhere, behavior is undefined if (end-key) >= 2^30
454+
/// \note As stated elsewhere, behavior is undefined if (end-begin) >= 2^30
455455
/// \return non-zero, but JSON_ASSERT if this is neither object nor nullValue.
456-
Value const* demand(char const* key, char const* end);
456+
Value const* demand(char const* begin, char const* end);
457457
/// \brief Remove and return the named member.
458458
///
459459
/// Do nothing if it did not exist.
@@ -466,7 +466,7 @@ Json::Value obj_value(Json::objectValue); // {}
466466
/// \param key may contain embedded nulls.
467467
/// \deprecated
468468
Value removeMember(const std::string& key);
469-
/// Same as removeMember(const char* key, const char* end, Value* removed),
469+
/// Same as removeMember(const char* begin, const char* end, Value* removed),
470470
/// but 'key' is null-terminated.
471471
bool removeMember(const char* key, Value* removed);
472472
/** \brief Remove the named map member.
@@ -477,7 +477,7 @@ Json::Value obj_value(Json::objectValue); // {}
477477
*/
478478
bool removeMember(std::string const& key, Value* removed);
479479
/// Same as removeMember(std::string const& key, Value* removed)
480-
bool removeMember(const char* key, const char* end, Value* removed);
480+
bool removeMember(const char* begin, const char* end, Value* removed);
481481
/** \brief Remove the indexed array element.
482482
483483
O(n) expensive operations.
@@ -493,7 +493,7 @@ Json::Value obj_value(Json::objectValue); // {}
493493
/// \param key may contain embedded nulls.
494494
bool isMember(const std::string& key) const;
495495
/// Same as isMember(std::string const& key)const
496-
bool isMember(const char* key, const char* end) const;
496+
bool isMember(const char* begin, const char* end) const;
497497
#ifdef JSON_USE_CPPTL
498498
/// Return true if the object has a member named key.
499499
bool isMember(const CppTL::ConstString& key) const;

0 commit comments

Comments
 (0)