From ca2f80aeaf4bf19ff67db9121dae1a92ab091372 Mon Sep 17 00:00:00 2001 From: Benoit Blanchon Date: Wed, 21 Feb 2024 10:48:50 +0100 Subject: [PATCH] Add links to the documentation --- src/ArduinoJson/Configuration.hpp | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/src/ArduinoJson/Configuration.hpp b/src/ArduinoJson/Configuration.hpp index 12d60688a..cc6292a3d 100644 --- a/src/ArduinoJson/Configuration.hpp +++ b/src/ArduinoJson/Configuration.hpp @@ -5,6 +5,7 @@ #pragma once // Support std::istream and std::ostream +// https://arduinojson.org/v7/config/enable_std_stream/ #ifndef ARDUINOJSON_ENABLE_STD_STREAM # ifdef __has_include # if __has_include() && \ @@ -25,6 +26,7 @@ #endif // Support std::string +// https://arduinojson.org/v7/config/enable_std_string/ #ifndef ARDUINOJSON_ENABLE_STD_STRING # ifdef __has_include # if __has_include() && !defined(min) && !defined(max) @@ -55,6 +57,7 @@ #endif // Store floating-point values with float (0) or double (1) +// https://arduinojson.org/v7/config/use_double/ #ifndef ARDUINOJSON_USE_DOUBLE # define ARDUINOJSON_USE_DOUBLE 1 #endif @@ -71,6 +74,7 @@ #endif // Store integral values with long (0) or long long (1) +// https://arduinojson.org/v7/config/use_long_long/ #ifndef ARDUINOJSON_USE_LONG_LONG # if ARDUINOJSON_SIZEOF_POINTER >= 4 // 32 & 64 bits systems # define ARDUINOJSON_USE_LONG_LONG 1 @@ -80,11 +84,13 @@ #endif // Limit nesting as the stack is likely to be small +// https://arduinojson.org/v7/config/default_nesting_limit/ #ifndef ARDUINOJSON_DEFAULT_NESTING_LIMIT # define ARDUINOJSON_DEFAULT_NESTING_LIMIT 10 #endif -// Number of bytes to store the variant identifier +// Number of bytes to store a slot id +// https://arduinojson.org/v7/config/slot_id_size/ #ifndef ARDUINOJSON_SLOT_ID_SIZE # if ARDUINOJSON_SIZEOF_POINTER <= 2 # define ARDUINOJSON_SLOT_ID_SIZE 1 // up to 255 slots @@ -123,6 +129,7 @@ #endif // Number of bytes to store the length of a string +// https://arduinojson.org/v7/config/string_length_size/ #ifndef ARDUINOJSON_STRING_LENGTH_SIZE # if ARDUINOJSON_SIZEOF_POINTER <= 2 # define ARDUINOJSON_STRING_LENGTH_SIZE 1 // up to 255 characters @@ -134,11 +141,13 @@ #ifdef ARDUINO // Enable support for Arduino's String class +// https://arduinojson.org/v7/config/enable_arduino_string/ # ifndef ARDUINOJSON_ENABLE_ARDUINO_STRING # define ARDUINOJSON_ENABLE_ARDUINO_STRING 1 # endif // Enable support for Arduino's Stream class +// https://arduinojson.org/v7/config/enable_arduino_stream/ # ifndef ARDUINOJSON_ENABLE_ARDUINO_STREAM # define ARDUINOJSON_ENABLE_ARDUINO_STREAM 1 # endif @@ -149,6 +158,7 @@ # endif // Enable support for PROGMEM +// https://arduinojson.org/v7/config/enable_progmem/ # ifndef ARDUINOJSON_ENABLE_PROGMEM # define ARDUINOJSON_ENABLE_PROGMEM 1 # endif @@ -156,11 +166,13 @@ #else // ARDUINO // Disable support for Arduino's String class +// https://arduinojson.org/v7/config/enable_arduino_string/ # ifndef ARDUINOJSON_ENABLE_ARDUINO_STRING # define ARDUINOJSON_ENABLE_ARDUINO_STRING 0 # endif // Disable support for Arduino's Stream class +// https://arduinojson.org/v7/config/enable_arduino_stream/ # ifndef ARDUINOJSON_ENABLE_ARDUINO_STREAM # define ARDUINOJSON_ENABLE_ARDUINO_STREAM 0 # endif @@ -171,6 +183,7 @@ # endif // Enable PROGMEM support on AVR only +// https://arduinojson.org/v7/config/enable_progmem/ # ifndef ARDUINOJSON_ENABLE_PROGMEM # ifdef __AVR__ # define ARDUINOJSON_ENABLE_PROGMEM 1 @@ -182,32 +195,38 @@ #endif // ARDUINO // Convert unicode escape sequence (\u0123) to UTF-8 +// https://arduinojson.org/v7/config/decode_unicode/ #ifndef ARDUINOJSON_DECODE_UNICODE # define ARDUINOJSON_DECODE_UNICODE 1 #endif // Ignore comments in input +// https://arduinojson.org/v7/config/enable_comments/ #ifndef ARDUINOJSON_ENABLE_COMMENTS # define ARDUINOJSON_ENABLE_COMMENTS 0 #endif // Support NaN in JSON +// https://arduinojson.org/v7/config/enable_nan/ #ifndef ARDUINOJSON_ENABLE_NAN # define ARDUINOJSON_ENABLE_NAN 0 #endif // Support Infinity in JSON +// https://arduinojson.org/v7/config/enable_infinity/ #ifndef ARDUINOJSON_ENABLE_INFINITY # define ARDUINOJSON_ENABLE_INFINITY 0 #endif // Control the exponentiation threshold for big numbers // CAUTION: cannot be more that 1e9 !!!! +// https://arduinojson.org/v7/config/positive_exponentiation_threshold/ #ifndef ARDUINOJSON_POSITIVE_EXPONENTIATION_THRESHOLD # define ARDUINOJSON_POSITIVE_EXPONENTIATION_THRESHOLD 1e7 #endif // Control the exponentiation threshold for small numbers +// https://arduinojson.org/v7/config/negative_exponentiation_threshold/ #ifndef ARDUINOJSON_NEGATIVE_EXPONENTIATION_THRESHOLD # define ARDUINOJSON_NEGATIVE_EXPONENTIATION_THRESHOLD 1e-5 #endif