From 4e30c4fcdb93cd0670f00eddf89fc5e900b86295 Mon Sep 17 00:00:00 2001 From: Christopher Dunn Date: Sun, 8 Mar 2015 12:56:32 -0500 Subject: [PATCH] comments --- include/json/value.h | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/include/json/value.h b/include/json/value.h index b590825..836b663 100644 --- a/include/json/value.h +++ b/include/json/value.h @@ -34,21 +34,29 @@ namespace Json { /** Base class for all exceptions we throw. + * + * We use nothing but these internally. Of course, STL can throw others. */ class JSON_API Exception; /** Exceptions which the user cannot easily avoid. * - * E.g. out-of-memory, stack-overflow, malicious input + * E.g. out-of-memory (when we use malloc), stack-overflow, malicious input + * + * \remark derived from Json::Exception */ class JSON_API RuntimeError; -/** Exceptions throw by JSON_ASSERT/JSON_FAIL macros. +/** Exceptions thrown by JSON_ASSERT/JSON_FAIL macros. * * These are precondition-violations (user bugs) and internal errors (our bugs). + * + * \remark derived from Json::Exception */ class JSON_API LogicError; -JSON_API void throwRuntimeError(std::string const& msg); -JSON_API void throwLogicError(std::string const& msg); +/// used internally +void throwRuntimeError(std::string const& msg); +/// used internally +void throwLogicError(std::string const& msg); /** \brief Type of the value held by a Value object. */